diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000..d645695 --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100755 index 0000000..bbb2fa1 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include *.py +include *.json +include LICENSE +recursive-include zohocrmsdk * +recursive-exclude zohocrmsdk *.pyc \ No newline at end of file diff --git a/README.md b/README.md old mode 100644 new mode 100755 index 97d7317..0569b8e --- a/README.md +++ b/README.md @@ -1 +1,78 @@ -# zohocrm-python-sdk-7.0 +# ZOHO CRM PYTHON SDK 7.0 for API version 7 + +The Python SDK for Zoho CRM allows developers to easily create Python applications that can be integrated with Zoho CRM. This SDK serves as a wrapper for the REST APIs, making it easier to access and utilize the services of Zoho CRM. +Authentication to access the CRM APIs is done through OAuth2.0, and the authentication process is streamlined through the use of the Python SDK. The grant and access/refresh tokens are generated and managed within the SDK code, eliminating the need for manual handling during data synchronization between Zoho CRM and the client application. + +This repository includes the Python SDK for API v7 of Zoho CRM. Check [Versions](https://github.com/zoho/zohocrm-python-sdk-7.0/releases) for more details on the versions of SDK released for this API version. + +License +======= + + Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED + All rights reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +## Latest Version + +- [1.0.0](/versions/1.0.0/README.md) + + - Python SDK upgraded to support v7 APIs. + + - Python SDK improved to support the following new APIs + + - [Export Audit Log API](https://www.zoho.com/crm/developer/docs/api/v7/create-export-audit-log.html) + - [Cadence API](https://www.zoho.com/crm/developer/docs/api/v7/cadences/get-cadences.html) + - [Record Clone API](https://www.zoho.com/crm/developer/docs/api/v7/record-clone.html) + - [Duplicate Record Check API](https://www.zoho.com/crm/developer/docs/api/v7/enable-duplicate-record-check.html) + - [Data People Enrichment API](https://www.zoho.com/crm/developer/docs/api/v7/zia-enrichment/create-ppl-enrichment.html) + - [Data Org Enrichment API](https://www.zoho.com/crm/developer/docs/api/v7/zia-enrichment/get-config.html) + - [Mass Delete Tags API](https://www.zoho.com/crm/developer/docs/api/v7/mass-delete-tags.html) + - [Picklist Option API](https://www.zoho.com/crm/developer/docs/api/v7/picklist-values.html) + - [API Fetcher](https://www.zoho.com/crm/developer/docs/api/v7/list-available-rest-apis.html) + + +For older versions, please [refer](https://github.com/zoho/zohocrm-python-sdk-7.0/releases). + + +## Including the SDK in your project +You can include the SDK to your project using: + +- For including the latest [version](https://github.com/zoho/zohocrm-python-sdk-7.0/releases/tag/1.0.0) + + - Install **Python** from [python.org](https://www.python.org/downloads/) (if not installed). + + - Install **Python SDK** + - Navigate to the workspace of your client app. + - Run the command below: + + ```sh + pip install zohocrmsdk7_0 + ``` + - The Python SDK will be installed in your client application. + + +**NOTE** + +> - The **access and refresh tokens are environment-specific and domain-specific**. When you handle various environments and domains such as **Production**, **Sandbox**, or **Developer** and **IN**, **CN**, **US**, **EU**, **JP**, or **AU**, respectively, you must use the access token and refresh token generated only in those respective environments and domains. The SDK throws an error, otherwise. +For example, if you generate the tokens for your Sandbox environment in the CN domain, you must use only those tokens for that domain and environment. You cannot use the tokens generated for a different environment or a domain. + +> - For **Deal Contact Roles API and Records API**, you will need to provide the **ZohoCRM.settings.fields.ALL** scope along with the **ZohoCRM.modules.ALL** scope while generating the OAuthtoken. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error. + +> - For **Related Records API**, the scopes required for generating OAuthtoken are **ZohoCRM.modules.ALL**, **ZohoCRM.settings.fields.ALL** and **ZohoCRM.settings.related_lists.ALL**. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error. + +> - For **Mass Convert API**, you will need to provide the **ZohoCRM.settings.fields.ALL** scope along with the **ZohoCRM.mass_convert.leads.CREATE** and **ZohoCRM.mass_convert.leads.READ** scope while generating the OAuthtoken. Otherwise, the system returns the **OAUTH-SCOPE-MISMATCH** error. + +--- + +For more details, kindly refer [here](/versions/1.0.0/README.md). diff --git a/class_hierarchy.png b/class_hierarchy.png new file mode 100755 index 0000000..6d3072b Binary files /dev/null and b/class_hierarchy.png differ diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ff5bd83 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,5 @@ +setuptools~=69.0.0 +requests~=2.31.0 +urllib3~=2.0.3 +python-dateutil~=2.8.2 +mysql-connector-python~=8.0.20 \ No newline at end of file diff --git a/samples/__init__.py b/samples/__init__.py new file mode 100644 index 0000000..fdf2d85 --- /dev/null +++ b/samples/__init__.py @@ -0,0 +1,6 @@ +from . import bulk_write +from . import org +from . import business_hours +from . import coql +from . import record +from . import modules diff --git a/samples/bulk_write/CreateBulkWriteJob.py b/samples/bulk_write/CreateBulkWriteJob.py new file mode 100644 index 0000000..8a280e7 --- /dev/null +++ b/samples/bulk_write/CreateBulkWriteJob.py @@ -0,0 +1,121 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, RequestWrapper, CallBack, Resource, \ + FieldMapping, SuccessResponse, APIException, DefaultValue +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class CreateBulkWriteJob(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def create_bulk_write_job(module_api_name, file_id): + """ + This method is used to create bulk write job with the uploaded file ID + :param module_api_name: The API Name of the module. + :param file_id: The ID of the uploaded file to create BulkWrite Job. + example + module_api_name = 'Leads' + file_id = 3409643002212140 + """ + bulk_write_operations = BulkWriteOperations() + request = RequestWrapper() + call_back = CallBack() + call_back.set_url("https://www.example.com/callback") + call_back.set_method(Choice('post')) + # The Bulk Read Job's details is posted to this URL on successful completion / failure of the job. + request.set_callback(call_back) + request.set_character_encoding('UTF-8') + # To set the type of operation you want to perform on the bulk write job. + request.set_operation(Choice('update')) + request.set_ignore_empty(True) + resources = [] + resource = Resource() + # To set the type of module that you want to import. The value is data. + resource.set_type(Choice('data')) + # To set API name of the module that you select for bulk write job. + # Specifies the API Name of the module to be read. + module = MinifiedModule() + module.set_api_name(module_api_name) + resource.set_module(module) + # To set the fileId obtained from file upload API. + resource.set_file_id(file_id) + # To set a field as a unique field or ID of a record. + resource.set_find_by('id') + field_mappings = [] + field_mapping = FieldMapping() + # To set API name of the field present in Zoho module object that you want to import. + field_mapping.set_api_name('Email') + # To set the column index of the field you want to map to the CRM field. + field_mapping.set_index(1) + field_mappings.append(field_mapping) + field_mapping = FieldMapping() + # To set API name of the field present in Zoho module object that you want to import. + field_mapping.set_api_name('Company') + # To set the column index of the field you want to map to the CRM field. + field_mapping.set_index(2) + field_mappings.append(field_mapping) + field_mapping = FieldMapping() + # To set API name of the field present in Zoho module object that you want to import. + field_mapping.set_api_name('Last_Name') + # To set the column index of the field you want to map to the CRM field. + field_mapping.set_index(0) + field_mappings.append(field_mapping) + # field_mapping = FieldMapping() + # # To set API name of the field present in Zoho module object that you want to import. + # field_mapping.set_api_name('Phone') + # # To set the column index of the field you want to map to the CRM field. + # field_mapping.set_index(3) + # field_mappings.append(field_mapping) + field_mapping = FieldMapping() + field_mapping.set_api_name('id') + field_mapping.set_index(4) + field_mappings.append(field_mapping) + field_mapping = FieldMapping() + field_mapping.set_api_name('Website') + default_value = DefaultValue() + default_value.set_value("www.zohoapis.com") + # To set the default value for an empty column in the uploaded file. + field_mapping.set_default_value(default_value) + field_mappings.append(field_mapping) + resource.set_field_mappings(field_mappings) + module = MinifiedModule() + module.set_api_name(module_api_name) + resource.set_module(module) + resources.append(resource) + request.set_resource(resources) + # Call create_bulk_write_job method that takes RequestWrapper instance as parameter + response = bulk_write_operations.create_bulk_write_job(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module = "Leads" +file_id = "3477471001" +CreateBulkWriteJob.initialize() +CreateBulkWriteJob.create_bulk_write_job(module, file_id) \ No newline at end of file diff --git a/samples/bulk_write/DownloadBulkWriteResult.py b/samples/bulk_write/DownloadBulkWriteResult.py new file mode 100644 index 0000000..4b7738b --- /dev/null +++ b/samples/bulk_write/DownloadBulkWriteResult.py @@ -0,0 +1,61 @@ +import os + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, FileBodyWrapper, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + +class DownloadBulkWriteResult(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def download_bulk_write_result(download_url, destination_folder): + """ + This method is used to download the result of bulk write job. + :param download_url: The URL present in the download_url key in the response of Get Bulk Write Job Details. + :param destination_folder: The absolute path where downloaded file has to be stored. + """ + """ + example + download_url = "https://download-accl.zoho.com/6735/bulk-write/347706122009/347706122009.zip" + destination_folder = "/Users/user_name/Documents" + """ + bulk_write_operations = BulkWriteOperations() + # Call download_bulk_write_result method that takes download_url as parameter + response = bulk_write_operations.download_bulk_write_result(download_url) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, FileBodyWrapper): + stream_wrapper = response_object.get_file() + # Construct the file name by joining the destination_folder 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: + for chunk in stream_wrapper.get_stream(): + f.write(chunk) + f.close() + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +download_url = "https://download-accl.zoho.com/v2/crm/6045/bulk-write/3477441008/3477061008.zip" +destination_folder = "/Users/file" +DownloadBulkWriteResult.initialize() +DownloadBulkWriteResult.download_bulk_write_result(download_url, destination_folder) \ No newline at end of file diff --git a/samples/bulk_write/GetBulkWriteJobDetails.py b/samples/bulk_write/GetBulkWriteJobDetails.py new file mode 100644 index 0000000..a6af67a --- /dev/null +++ b/samples/bulk_write/GetBulkWriteJobDetails.py @@ -0,0 +1,98 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, BulkWriteResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + +class GetBulkWriteJobDetails(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_bulk_write_job_details(job_id): + """ + This method is used to get the details of a bulk write job performed previously. + :param job_id: The unique ID of the bulk write job. + """ + """ + example + job_id = 3477061005615003 + """ + bulk_write_operations = BulkWriteOperations() + # Call get_bulk_write_job_details method that takes job_id as parameter + response = bulk_write_operations.get_bulk_write_job_details(job_id) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, BulkWriteResponse): + print("Bulk write Job Status: " + response_object.get_status()) + print("Bulk write CharacterEncoding: ") + print(response_object.get_character_encoding()) + resources = response_object.get_resource() + if resources is not None: + for resource in resources: + print("Bulk write Resource Status: " + resource.get_status().get_value()) + print("Bulk write Resource Type: " + resource.get_type().get_value()) + print("Bulk write Resource Module: ") + print(resource.get_module().get_id()) + print("Bulk write Resource Module: " + resource.get_module().get_api_name()) + field_mappings = resource.get_field_mappings() + if field_mappings is not None: + for field_mapping in field_mappings: + print("Bulk write Resource FieldMapping Module: " + field_mapping.get_api_name()) + if field_mapping.get_index() is not None: + print( + "Bulk write Resource FieldMapping Index: " + str(field_mapping.get_index())) + if field_mapping.get_format() is not None: + print("Bulk write Resource FieldMapping Format: " + field_mapping.get_format()) + if field_mapping.get_find_by() is not None: + print("Bulk write Resource FieldMapping FindBy: " + field_mapping.get_find_by()) + if field_mapping.get_module() is not None: + print("Bulk write Resource FieldMapping module: " + field_mapping.get_module()) + default_value = field_mapping.get_default_value() + if default_value is not None: + print('Default values' + default_value.get_value()) + + file = resource.get_file() + if file is not None: + print("Bulk write Resource File Status: " + file.get_status().get_value()) + print("Bulk write Resource File Name: " + file.get_name()) + print("Bulk write Resource File AddedCount: " + str(file.get_added_count())) + print("Bulk write Resource File SkippedCount: " + str(file.get_skipped_count())) + print("Bulk write Resource File UpdatedCount: " + str(file.get_updated_count())) + print("Bulk write Resource File TotalCount: " + str(file.get_total_count())) + callback = response_object.get_callback() + if callback is not None: + print("Bulk write CallBack Url: " + callback.get_url()) + print("Bulk write CallBack Method: " + callback.get_method().get_value()) + print("Bulk write ID: " + str(response_object.get_id())) + result = response_object.get_result() + if result is not None: + print("Bulk write DownloadUrl: " + result.get_download_url()) + created_by = response_object.get_created_by() + if created_by is not None: + print("Bulkwrite Created By - Name: " + created_by.get_name()) + print("Bulkwrite Created By - ID: " + str(created_by.get_id())) + print("Bulk write Operation: " + response_object.get_operation()) + print("Bulk write File CreatedTime: " + str(response_object.get_created_time())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +job_id = "347703001" +GetBulkWriteJobDetails.initialize() +GetBulkWriteJobDetails.get_bulk_write_job_details(job_id) diff --git a/samples/bulk_write/UploadFile.py b/samples/bulk_write/UploadFile.py new file mode 100644 index 0000000..3c5f2a5 --- /dev/null +++ b/samples/bulk_write/UploadFile.py @@ -0,0 +1,89 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, FileBodyWrapper, UploadFileHeader, \ + SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper + + +class UploadFile(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def upload_file(org_id, absolute_file_path): + """ + This method is used to upload a CSV file in ZIP format for bulk write API. The response contains the file_id. + :param org_id: The unique ID (zgid) of your organization obtained through the Organization API. + :param absolute_file_path: The absoluteFilePath of the zip file you want to upload. + """ + """ + example + org_id = "6045" + absolute_file_path = "/Users/user_name/Documents/Leads.zip" + """ + bulk_write_operations = BulkWriteOperations() + file_body_wrapper = FileBodyWrapper() + """ + StreamWrapper can be initialized in any of the following ways + * param 1 -> fileName + * param 2 -> Read Stream. + """ + # stream_wrapper = StreamWrapper(stream=open(absolute_file_path, 'rb')) + """ + * param 1 -> fileName + * param 2 -> Read Stream + * param 3 -> Absolute File Path of the file to be attached + """ + stream_wrapper = StreamWrapper(file_path=absolute_file_path) + file_body_wrapper.set_file(stream_wrapper) + header_instance = HeaderMap() + # Possible parameters for upload_file operation + header_instance.add(UploadFileHeader.feature, "bulk-write") + header_instance.add(UploadFileHeader.x_crm_org, org_id) + # Call upload_file method that takes FileBodyWrapper instance and header_instance as parameter + response = bulk_write_operations.upload_file(file_body_wrapper, header_instance) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + elif isinstance(response_object, APIException): + if response_object.get_status() is not None: + print("Status: " + response_object.get_status().get_value()) + if response_object.get_code() is not None: + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + if details is not None: + for key, value in details.items(): + print(key + ' : ' + str(value)) + if response_object.get_error_message() is not None: + print("Error Message: " + response_object.get_error_message().get_value()) + print('Error Code: ' + str(response_object.get_error_code())) + if response_object.get_x_error() is not None: + print('XError: ' + response_object.get_x_error().get_value()) + if response_object.get_info() is not None: + print("Info: " + response_object.get_info().get_value()) + if response_object.get_x_info() is not None: + print("XInfo: " + response_object.get_x_info().get_value()) + if response_object.get_message() is not None: + print("Message: " + response_object.get_message().get_value()) + print('HttpStatus: ' + str(response_object.get_http_status())) + + +org_id = "6045" +absolute_path = "/Users/Leads.zip" +UploadFile.initialize() +UploadFile.upload_file(org_id, absolute_path) diff --git a/samples/bulk_write/__init__.py b/samples/bulk_write/__init__.py new file mode 100644 index 0000000..4c41942 --- /dev/null +++ b/samples/bulk_write/__init__.py @@ -0,0 +1,4 @@ +from .UploadFile import UploadFile +from .CreateBulkWriteJob import CreateBulkWriteJob +from .DownloadBulkWriteResult import DownloadBulkWriteResult +from .GetBulkWriteJobDetails import GetBulkWriteJobDetails diff --git a/samples/business_hours/CreateBusinessHours.py b/samples/business_hours/CreateBusinessHours.py new file mode 100644 index 0000000..0f7853b --- /dev/null +++ b/samples/business_hours/CreateBusinessHours.py @@ -0,0 +1,73 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.business_hours import BusinessHoursOperations, BodyWrapper, BusinessHours, \ + BreakHoursCustomTiming, APIException, ActionWrapper, SuccessResponse +from zohocrmsdk.src.com.zoho.crm.api.dc import INDataCenter +from zohocrmsdk.src.com.zoho.crm.api.util.choice import Choice + + +class CreateBusinessHours: + @staticmethod + def initialize(): + environment = INDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def create_business_hours(): + business_hours_operations = BusinessHoursOperations() + request = BodyWrapper() + business_hours = BusinessHours() + business_days = [Choice("Monday")] + business_hours.set_business_days(business_days) + business_hours.set_week_starts_on(Choice("Monday")) + bhct = BreakHoursCustomTiming() + bhct.set_days(Choice("Monday")) + business_timings = ["10:00", "11:00"] + bhct.set_business_timing(business_timings) + custom_timing = [bhct] + business_hours.set_custom_timing(custom_timing) + business_hours.set_same_as_everyday(False) + # when same_as_everyday is true + daily_timing = ["10:00", "11:00"] + business_hours.set_daily_timing(daily_timing) + # + business_hours.set_type(Choice("custom")) + request.set_business_hours(business_hours) + response = business_hours_operations.create_business_hours(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_business_hours() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +CreateBusinessHours.initialize() +CreateBusinessHours.create_business_hours() diff --git a/samples/business_hours/GetBusinessHours.py b/samples/business_hours/GetBusinessHours.py new file mode 100644 index 0000000..4477651 --- /dev/null +++ b/samples/business_hours/GetBusinessHours.py @@ -0,0 +1,66 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.business_hours import BusinessHoursOperations, ResponseWrapper, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + +class GetBusinessHours(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_business_hours(): + business_hours_operations = BusinessHoursOperations() + response = business_hours_operations.get_business_hours() + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, ResponseWrapper): + responseWrapper = response_object + business_hours = responseWrapper.get_business_hours() + business_days = business_hours.get_business_days() + if business_days is not None: + print("businessdays : ") + for business_day in business_days: + print(business_day) + else: + print("businessdays : None") + custom_timing = business_hours.get_custom_timing() + if custom_timing is not None: + print("custom_timing :") + for bhct in custom_timing: + print("days: " + bhct.get_days().get_value()) + business_timings = bhct.get_business_timing() + for business_timing in business_timings: + print("business_timings : " + business_timing) + else: + print("custom_timing : None") + daily_timing = business_hours.get_daily_timing() + if daily_timing is not None: + print("daily_timings : ") + for daily_timing1 in daily_timing: + print(daily_timing1) + else: + print("daily_timings : None") + print("week_starts_on : " + business_hours.get_week_starts_on().get_value()) + print("same_as_everyday : " + str(business_hours.get_same_as_everyday())) + print("businesshours_id : " + str(business_hours.get_id())) + print("businesshours_type : " + business_hours.get_type().get_value()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +GetBusinessHours.initialize() +GetBusinessHours.get_business_hours() diff --git a/samples/business_hours/UpdateBusinessHours.py b/samples/business_hours/UpdateBusinessHours.py new file mode 100644 index 0000000..f7a4488 --- /dev/null +++ b/samples/business_hours/UpdateBusinessHours.py @@ -0,0 +1,83 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.business_hours import BusinessHoursOperations, BodyWrapper, BusinessHours, \ + BreakHoursCustomTiming, ActionWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class UpdateBusinessHours(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_business_hours(): + business_hours_operations = BusinessHoursOperations() + request = BodyWrapper() + business_hours = BusinessHours() + business_days = [Choice("Monday")] + business_hours.set_business_days(business_days) + business_hours.set_week_starts_on(Choice("Monday")) + business_hours.set_same_as_everyday(False) # when same_as_everyday is true + business_hours.set_id(44028001017425) + bhct = BreakHoursCustomTiming() + bhct.set_days(Choice("Monday")) + business_timings = ["09:00", "17:00"] + bhct.set_business_timing(business_timings) + + bhct1 = BreakHoursCustomTiming() + bhct1.set_days(Choice("Tuesday")) + business_timing1 = ["10:30", "17:00"] + bhct1.set_business_timing(business_timing1) + + bhct2 = BreakHoursCustomTiming() + bhct2.set_days(Choice("Wednesday")) + business_timing2 = ["10:30", "17:00"] + bhct2.set_business_timing(business_timing2) + + custom_timing = [bhct, bhct1, bhct2] + business_hours.set_custom_timing(custom_timing) + daily_timing = ["10:00", "11:00"] + business_hours.set_daily_timing(daily_timing) + + business_hours.set_type(Choice("custom")) + request.set_business_hours(business_hours) + response = business_hours_operations.update_business_hours(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response = response_object.get_business_hours() + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +UpdateBusinessHours.initialize() +UpdateBusinessHours.update_business_hours() \ No newline at end of file diff --git a/samples/business_hours/__init__.py b/samples/business_hours/__init__.py new file mode 100644 index 0000000..320134a --- /dev/null +++ b/samples/business_hours/__init__.py @@ -0,0 +1,3 @@ +from .GetBusinessHours import GetBusinessHours +from .CreateBusinessHours import CreateBusinessHours +from .UpdateBusinessHours import UpdateBusinessHours diff --git a/samples/coql/GetRecords.py b/samples/coql/GetRecords.py new file mode 100644 index 0000000..a0a43fb --- /dev/null +++ b/samples/coql/GetRecords.py @@ -0,0 +1,83 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.coql import CoqlOperations, BodyWrapper, ResponseWrapper, APIException + + +class GetRecords(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_records(): + + """ + This method is used to get records from the module through a COQL query. + """ + query_operations = CoqlOperations() + body_wrapper = BodyWrapper() + select_query = "select Last_Name, Account_Name.Parent_Account, Account_Name.Parent_Account.Account_Name,First_Name, Full_Name, Created_Time from Contacts where Last_Name is not null limit 200" + body_wrapper.set_select_query(select_query) + response = query_operations.get_records(body_wrapper) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + print("Record ID: " + str(record.get_id())) + created_by = record.get_created_by() + if created_by is not None: + print("Record Created By - Name: " + created_by.get_name()) + print("Record Created By - ID: " + created_by.get_id()) + print("Record Created By - Email: " + created_by.get_email()) + print("Record CreatedTime: " + str(record.get_created_time())) + if record.get_modified_time() is not None: + print("Record ModifiedTime: " + str(record.get_modified_time())) + modified_by = record.get_modified_by() + if modified_by is not None: + print("Record Modified By - Name: " + modified_by.get_name()) + print("Record Modified By - ID: " + modified_by.get_id()) + print("Record Modified By - Email: " + modified_by.get_email()) + print('Record KeyValues: ') + key_values = record.get_key_values() + for key_name, value in key_values.items(): + if isinstance(value, list): + print("Record KeyName : " + key_name) + for data in value: + if isinstance(data, dict): + for dict_key, dict_value in data.items(): + print(dict_key + " : " + str(dict_value)) + else: + print(str(data)) + elif isinstance(value, dict): + print("Record KeyName : " + key_name + " - Value : ") + for dict_key, dict_value in value.items(): + print(dict_key + " : " + str(dict_value)) + else: + print("Record KeyName : " + key_name + " - Value : " + str(value)) + info = response_object.get_info() + if info is not None: + if info.get_count() is not None: + print('Record Info Count: ' + str(info.get_count())) + if info.get_more_records() is not None: + print('Record Info MoreRecords: ' + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +GetRecords.initialize() +GetRecords.get_records() diff --git a/samples/coql/__init__.py b/samples/coql/__init__.py new file mode 100644 index 0000000..1391861 --- /dev/null +++ b/samples/coql/__init__.py @@ -0,0 +1 @@ +from .GetRecords import GetRecords diff --git a/samples/custom_store/README.md b/samples/custom_store/README.md new file mode 100644 index 0000000..29668c2 --- /dev/null +++ b/samples/custom_store/README.md @@ -0,0 +1,72 @@ +Custom Store Token Store Persistence +------------------------------------ +Our Python SDK comes with built-in support for File Persistence, which stores your tokens in a file at a location of your choosing, and DB Persistence, which stores your tokens in a MySQL database. However, if these options don't align with your specific requirements, or if you want to use a database other than MySQL or any other storage method, you can leverage Custom Persistence, where you can define your own storage logic through the TokenStore class. To do this, you need to implement the TokenStore interface and override its methods accordingly. + +We have added examples for three different types using custom persistence: + +### 1. [SQLite3 DB](custom_store_sqlite.py): + +In this case, the tokens are persisted in a file on disk. The data in this database persists even after the program exits, as long as the file is not deleted. + +The sqlite3.connect('zohooauth.db') command in Python is used to create a connection to an SQLite database stored in a file called zohooauth.db. + +Persistent Database: + - The database is stored on disk in the file zohooauth.db. + - The data in this database persists even after the program exits, as long as the file is not deleted. + - If the zohooauth.db file does not exist, it will be created. + - If the zohooauth.db file already exists, the command will open a connection to this existing database. + +Initialization Sample Code: +```python + try: + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="client_id", client_secret="client_secret", refresh_token="refresh_token") + store = CustomStoreSQLite() + Initializer.initialize(environment=environment, token=token, store=store) + except Exception as ex: + print(ex) +``` +Please check out the complete sample code [here](custom_store_sqlite.py). + +### 2. [In-Memory SQLite3 DB](custom_store_in_memory.py) + +In this case, the tokens are persisted in the RAM, and not on disk. Once the connection to the DB is closed, the DB and all its data will be deleted. + +The sqlite3.connect(':memory:') command in Python is used to create an in-memory SQLite database. This type of database resides entirely in RAM and does not persist to disk. Here are the key points about using an in-memory SQLite database: + +Temporary Database: + - The database exists only while the connection is open. + - Once the connection is closed, the database and all its data are lost. + +Initialization Sample Code: +```python + try: + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="client_id", client_secret="client_secret", refresh_token="refresh_token") + store = CustomStore() + Initializer.initialize(environment=environment, token=token, store=store) + except Exception as ex: + print(ex) +``` +Please check out the complete sample code [here](custom_store_in_memory.py). + +### 3. [Custom Store List](custom_store_list.py) + +In this case, the token details are stored in a list object. The data exists only while the app is running. + +The token details stored in list. + +Temporary Storage: + - The data exists only while the app is running. + +Initialization Sample Code: +```python + try: + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="client_id", client_secret="client_secret", refresh_token="refresh_token") + store = CustomStoreList() + Initializer.initialize(environment=environment, token=token, store=store) + except Exception as ex: + print(ex) +``` +Please check out the complete sample code [here](custom_store_list.py). \ No newline at end of file diff --git a/samples/custom_store/custom_store_in_memory.py b/samples/custom_store/custom_store_in_memory.py new file mode 100644 index 0000000..66ae817 --- /dev/null +++ b/samples/custom_store/custom_store_in_memory.py @@ -0,0 +1,282 @@ +from sqlite3 import Error + +from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +import sqlite3 + +class CustomStore(TokenStore): + + """ + This class to store user token details to the MySQL DataBase. + """ + + def __init__(self): + + """ + Creates a DBStore class instance with the specified parameters. + """ + self.db_name = ':memory:' + self.connection = sqlite3.connect(self.db_name) + if not self.check_table_exists(): + cursor = self.connection.cursor() + cursor.execute("CREATE TABLE oauthtoken (id varchar(10) NOT NULL,user_name varchar(255), client_id varchar(255), client_secret varchar(255), refresh_token varchar(255), access_token varchar(255), grant_token varchar(255), expiry_time varchar(20), redirect_url varchar(255), api_domain varchar(255), primary key (id))") + cursor.close() + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + def find_token(self, token): + cursor = None + try: + if isinstance(token, OAuthToken): + oauth_token = token + query = "select * from oauthtoken" + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query= query + " where access_token='" + oauth_token.get_access_token() + "'" + elif oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + cursor = self.connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + if result is None: + return None + self.set_merge_data(oauth_token, result) + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1, cause=ex) + finally: + cursor.close() if cursor is not None else None + return token + + @staticmethod + def get_data(next_record): + return next_record if next_record is not None else None + + @staticmethod + def set_merge_data(oauth_token, next_record): + if oauth_token.get_id() is None: + oauth_token.set_id(CustomStore.get_data(next_record[0])) + if oauth_token.get_user_signature() is None: + name = CustomStore.get_data(next_record[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(CustomStore.get_data(next_record[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(CustomStore.get_data(next_record[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(CustomStore.get_data(next_record[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(CustomStore.get_data(next_record[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(CustomStore.get_data(next_record[6])) + if oauth_token.get_expires_in() is None: + expiresIn = CustomStore.get_data(next_record[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(CustomStore.get_data(next_record[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(CustomStore.get_data(next_record[9])) + + def save_token(self, token): + if not isinstance(token, OAuthToken): + return + cursor = None + try: + oauth_token = token + query = "update oauthtoken set " + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + self.set_token(oauth_token) + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and len(oauth_token.get_access_token()) > 0 and \ + self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query = query + self.set_token(oauth_token) + " where access_token='" + oauth_token.get_access_token() + "'" + elif ((oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0) or + (oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0)) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + self.set_token(oauth_token) + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + self.set_token(oauth_token) + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + try: + cursor = self.connection.cursor() + cursor.execute(query) + if cursor.rowcount <= 0: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1) + if oauth_token.get_id() is None: + newId = str(self.generate_id()) + oauth_token.set_id(newId) + query = "insert into oauthtoken (id,user_name,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url,api_domain) values (?,?,?,?,?,?,?,?,?,?);" + val = (token.get_id(), token.get_user_signature().get_name() if token.get_user_signature() is not None else None, token.get_client_id(), token.get_client_secret(), token.get_refresh_token(), token.get_access_token(), token.get_grant_token(), token.get_expires_in(), token.get_redirect_url(), token.get_api_domain()) + cursor.execute(query, val) + except Error as e: + raise e + finally: + self.connection.commit() + cursor.close() if cursor is not None else None + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.SAVE_TOKEN_DB_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def set_token(self, oauth_token): + query = [] + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query.append(self.set_token_info(Constants.USER_NAME, name)) + if oauth_token.get_api_domain() is not None: + query.append(self.set_token_info(Constants.API_DOMAIN, oauth_token.get_api_domain())) + if oauth_token.get_client_id() is not None: + query.append(self.set_token_info(Constants.CLIENT_ID, oauth_token.get_client_id())) + if oauth_token.get_client_secret() is not None: + query.append(self.set_token_info(Constants.CLIENT_SECRET, oauth_token.get_client_secret())) + if oauth_token.get_refresh_token() is not None: + query.append(self.set_token_info(Constants.REFRESH_TOKEN, oauth_token.get_refresh_token())) + if oauth_token.get_access_token() is not None: + query.append(self.set_token_info(Constants.ACCESS_TOKEN, oauth_token.get_access_token())) + if oauth_token.get_grant_token() is not None: + query.append(self.set_token_info(Constants.GRANT_TOKEN, oauth_token.get_grant_token())) + if oauth_token.get_expires_in() is not None: + query.append(self.set_token_info(Constants.EXPIRY_TIME, oauth_token.get_expires_in())) + if oauth_token.get_redirect_url() is not None: + query.append(self.set_token_info(Constants.REDIRECT_URL, oauth_token.get_redirect_url())) + return str.join(",", query) + + @staticmethod + def set_token_info(key, value): + return key + "='" + value + "'" + + def delete_token(self, id): + cursor = None + try: + try: + cursor = self.connection.cursor() + query = "delete from oauthtoken where id= " + id + ";" + cursor.execute(query) + self.connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKEN_DB_ERROR, cause=ex) + + def get_tokens(self): + cursor = None + try: + tokens = [] + try: + cursor = self.connection.cursor() + query = "select * from oauthtoken;" + cursor.execute(query) + results = cursor.fetchall() + for result in results: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, result) + tokens.append(oauth_token) + return tokens + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_DB_ERROR, cause=ex) + + def delete_tokens(self): + cursor = None + try: + try: + cursor = self.connection.cursor() + query = "delete from oauthtoken;" + cursor.execute(query) + self.connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_DB_ERROR, cause=ex) + + def find_token_by_id(self, id): + cursor = None + try: + try: + query = "select * from oauthtoken where id='" + id + "'" + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + cursor = self.connection.cursor() + cursor.execute(query) + results = cursor.fetchall() + if results is None or len(results) <= 0: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_DB_ERROR) + for result in results: + self.set_merge_data(oauth_token, result) + return oauth_token + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_BY_ID_DB_ERROR, cause=ex) + + def generate_id(self): + cursor = None + try: + query = "select max(id) as id from oauthtoken;" + cursor = self.connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + max1 = result[0] + if max1 is None: + return 1 + else: + return int(max1) + 1 + except Exception as e1: + raise SDKException(Constants.TOKEN_STORE, Constants.GENERATE_TOKEN_ID_ERROR, cause=e1) + finally: + cursor.close() if cursor is not None else None + + def check_table_exists(self): + cursor = None + try: + cursor = self.connection.cursor() + # Query to check if table exists + cursor.execute("SELECT * FROM oauthtoken limit 1") + table = cursor.fetchone() + return table is not None + except Exception as e1: + return False + finally: + cursor.close() if cursor is not None else None \ No newline at end of file diff --git a/samples/custom_store/custom_store_list.py b/samples/custom_store/custom_store_list.py new file mode 100644 index 0000000..c867082 --- /dev/null +++ b/samples/custom_store/custom_store_list.py @@ -0,0 +1,223 @@ +from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + + +class CustomStoreList(TokenStore): + + def __init__(self): + self.store = [] + + def find_token(self, token): + if not isinstance(token, OAuthToken): + return token + try: + oauth_token = token + is_row_present = False + data = self.store + for next_record in data: + if len(next_record) == 0: + continue + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + return oauth_token + if not is_row_present: + return None + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_FILE_ERROR, cause=ex) + + def set_merge_data(self, oauth_token, next_record): + if oauth_token.get_id() is None: + oauth_token.set_id(self.get_data(next_record[0])) + if oauth_token.get_user_signature() is None: + name = self.get_data(next_record[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(self.get_data(next_record[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(self.get_data(next_record[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(self.get_data(next_record[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(self.get_data(next_record[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(self.get_data(next_record[6])) + if oauth_token.get_expires_in() is None: + expires_in = self.get_data(next_record[7]) + if expires_in is not None: + oauth_token.set_expires_in(str(expires_in)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(self.get_data(next_record[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(self.get_data(next_record[9])) + + def check_condition(self, oauth_token, next_record): + is_row_present = False + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + user_name = self.get_data(next_record[1]) + if name is not None and len(name) > 0 and user_name is not None and len(user_name) > 0 and name == user_name: + is_row_present = True + elif oauth_token.get_access_token() is not None and self.are_all_objects_null( + [oauth_token.get_client_id(), oauth_token.get_client_secret()]): + access_token = self.get_data(next_record[5]) + if access_token is not None and len(access_token) > 0 and len( + oauth_token.get_access_token()) > 0 and oauth_token.get_access_token() == access_token: + is_row_present = True + elif ( + oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + grant_token = self.get_data(next_record[6]) + refresh_token = self.get_data(next_record[4]) + if grant_token is not None and len(grant_token) > 0 and oauth_token.get_grant_token() is not None and len( + oauth_token.get_grant_token()) > 0 and oauth_token.get_grant_token() == grant_token: + is_row_present = True + elif refresh_token is not None and len( + refresh_token) > 0 and oauth_token.get_refresh_token() is not None and len( + oauth_token.get_refresh_token()) > 0 and oauth_token.get_refresh_token() == refresh_token: + is_row_present = True + return is_row_present + + def save_token(self, token): + if isinstance(token, OAuthToken): + try: + is_row_present = False + oauth_token = token + all_contents = self.store + for next_record in all_contents: + if len(next_record) > 0: + if oauth_token.get_id() is not None: + id = self.get_data(next_record[0]) + if id is not None and oauth_token.get_id() is not None and id == oauth_token.get_id(): + is_row_present= True + else: + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + i = all_contents.index(next_record) + all_contents[i] = self.set_token(oauth_token) + break + else: + all_contents.remove(next_record) + if not is_row_present: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if ( + oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None): + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_FILE_ERROR1) + if oauth_token.get_id() is None: + new_id = self.generate_id(all_contents) + oauth_token.set_id(new_id) + all_contents.append(self.set_token(oauth_token)) + self.store = all_contents + except Exception as error: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.SAVE_TOKEN_FILE_ERROR, cause=error) + + @staticmethod + def set_token(oauth_token): + data = [] + data.insert(0, oauth_token.get_id()) + data.insert(1, oauth_token.get_user_signature().get_name() if oauth_token.get_user_signature() is not None else "") + data.insert(2, oauth_token.get_client_id()) + data.insert(3, oauth_token.get_client_secret()) + data.insert(4, oauth_token.get_refresh_token()) + data.insert(5, oauth_token.get_access_token()) + data.insert(6, oauth_token.get_grant_token()) + data.insert(7, oauth_token.get_expires_in()) + data.insert(8, oauth_token.get_redirect_url()) + data.insert(9, oauth_token.get_api_domain()) + return data + + def delete_token(self, id): + try: + is_row_present = False + all_contents = self.store + for i in range(len(all_contents)): + next_record = all_contents[i] + if len(next_record) > 1: + record_id = self.get_data(next_record[0]) + if record_id is not None and record_id == id: + is_row_present = True + all_contents.pop(i) + break + self.store = all_contents + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e2: + raise SDKException(Constants.TOKEN_STORE, Constants.DELETE_TOKENS_FILE_ERROR, cause=e2) + + def get_tokens(self): + tokens = [] + try: + for next_record in self.store: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, next_record) + tokens.append(oauth_token) + return tokens + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_FILE_ERROR, cause=ex) + + def delete_tokens(self): + try: + self.store = [] + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_FILE_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def find_token_by_id(self, id): + try: + is_row_present = False + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + all_contents = self.store + for content in all_contents: + if content[0] == id: + is_row_present = True + self.set_merge_data(oauth_token, content) + return oauth_token + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR, cause=e) + return None + + @staticmethod + def get_data(value): + return value if (value is not None and len(value) > 0) else None + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + @staticmethod + def generate_id(all_contents): + maxValue = 0 + if len(all_contents) > 0: + for i in range(len(all_contents) - 1): + next_record = all_contents[i + 1] + if next_record is not None and len(next_record) > 1 and len(next_record[0]) > 0: + if maxValue < int(next_record[0]): + maxValue = int(next_record[0]) + return str(maxValue + 1) diff --git a/samples/custom_store/custom_store_sqlite.py b/samples/custom_store/custom_store_sqlite.py new file mode 100644 index 0000000..401b2e7 --- /dev/null +++ b/samples/custom_store/custom_store_sqlite.py @@ -0,0 +1,306 @@ +from sqlite3 import Error + +from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +import sqlite3 + +# use aws lambda +# import os +# os.chdir("/tmp") + +class CustomStoreSQLite(TokenStore): + + """ + This class to store user token details to the MySQL DataBase. + """ + + def __init__(self): + + """ + Creates a DBStore class instance with the specified parameters. + """ + self.db_name = 'zohooauth.db' + if not self.check_table_exists(): + connection = sqlite3.connect(self.db_name) + cursor = connection.cursor() + cursor.execute("CREATE TABLE oauthtoken (id varchar(10) NOT NULL,user_name varchar(255), client_id varchar(255), client_secret varchar(255), refresh_token varchar(255), access_token varchar(255), grant_token varchar(255), expiry_time varchar(20), redirect_url varchar(255), api_domain varchar(255), primary key (id))") + cursor.close() + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + def find_token(self, token): + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + if isinstance(token, OAuthToken): + oauth_token = token + query = "select * from oauthtoken" + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query= query + " where access_token='" + oauth_token.get_access_token() + "'" + elif oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + if result is None: + return None + self.set_merge_data(oauth_token, result) + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1, cause=ex) + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + return token + + @staticmethod + def get_data(next_record): + return next_record if next_record is not None else None + + @staticmethod + def set_merge_data(oauth_token, next_record): + if oauth_token.get_id() is None: + oauth_token.set_id(CustomStoreSQLite.get_data(next_record[0])) + if oauth_token.get_user_signature() is None: + name = CustomStoreSQLite.get_data(next_record[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(CustomStoreSQLite.get_data(next_record[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(CustomStoreSQLite.get_data(next_record[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(CustomStoreSQLite.get_data(next_record[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(CustomStoreSQLite.get_data(next_record[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(CustomStoreSQLite.get_data(next_record[6])) + if oauth_token.get_expires_in() is None: + expiresIn = CustomStoreSQLite.get_data(next_record[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(CustomStoreSQLite.get_data(next_record[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(CustomStoreSQLite.get_data(next_record[9])) + + def save_token(self, token): + if not isinstance(token, OAuthToken): + return + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + oauth_token = token + query = "update oauthtoken set " + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + self.set_token(oauth_token) + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and len(oauth_token.get_access_token()) > 0 and \ + self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query = query + self.set_token(oauth_token) + " where access_token='" + oauth_token.get_access_token() + "'" + elif ((oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0) or + (oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0)) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + self.set_token(oauth_token) + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + self.set_token(oauth_token) + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + try: + cursor = connection.cursor() + cursor.execute(query) + if cursor.rowcount <= 0: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1) + if oauth_token.get_id() is None: + newId = str(self.generate_id()) + oauth_token.set_id(newId) + query = "insert into oauthtoken (id,user_name,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url,api_domain) values (?,?,?,?,?,?,?,?,?,?);" + val = (token.get_id(), token.get_user_signature().get_name() if token.get_user_signature() is not None else None, token.get_client_id(), token.get_client_secret(), token.get_refresh_token(), token.get_access_token(), token.get_grant_token(), token.get_expires_in(), token.get_redirect_url(), token.get_api_domain()) + cursor.execute(query, val) + except Error as e: + raise e + finally: + connection.commit() + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.SAVE_TOKEN_DB_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def set_token(self, oauth_token): + query = [] + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query.append(self.set_token_info(Constants.USER_NAME, name)) + if oauth_token.get_api_domain() is not None: + query.append(self.set_token_info(Constants.API_DOMAIN, oauth_token.get_api_domain())) + if oauth_token.get_client_id() is not None: + query.append(self.set_token_info(Constants.CLIENT_ID, oauth_token.get_client_id())) + if oauth_token.get_client_secret() is not None: + query.append(self.set_token_info(Constants.CLIENT_SECRET, oauth_token.get_client_secret())) + if oauth_token.get_refresh_token() is not None: + query.append(self.set_token_info(Constants.REFRESH_TOKEN, oauth_token.get_refresh_token())) + if oauth_token.get_access_token() is not None: + query.append(self.set_token_info(Constants.ACCESS_TOKEN, oauth_token.get_access_token())) + if oauth_token.get_grant_token() is not None: + query.append(self.set_token_info(Constants.GRANT_TOKEN, oauth_token.get_grant_token())) + if oauth_token.get_expires_in() is not None: + query.append(self.set_token_info(Constants.EXPIRY_TIME, oauth_token.get_expires_in())) + if oauth_token.get_redirect_url() is not None: + query.append(self.set_token_info(Constants.REDIRECT_URL, oauth_token.get_redirect_url())) + return str.join(",", query) + + @staticmethod + def set_token_info(key, value): + return key + "='" + value + "'" + + def delete_token(self, id): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + try: + cursor = connection.cursor() + query = "delete from oauthtoken where id= " + id + ";" + cursor.execute(query) + connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKEN_DB_ERROR, cause=ex) + + def get_tokens(self): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + tokens = [] + try: + cursor = connection.cursor() + query = "select * from oauthtoken;" + cursor.execute(query) + results = cursor.fetchall() + for result in results: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, result) + tokens.append(oauth_token) + return tokens + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_DB_ERROR, cause=ex) + + def delete_tokens(self): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + try: + cursor = connection.cursor() + query = "delete from oauthtoken;" + cursor.execute(query) + self.connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_DB_ERROR, cause=ex) + + def find_token_by_id(self, id): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + try: + query = "select * from oauthtoken where id='" + id + "'" + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + cursor = connection.cursor() + cursor.execute(query) + results = cursor.fetchall() + if results is None or len(results) <= 0: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_DB_ERROR) + for result in results: + self.set_merge_data(oauth_token, result) + return oauth_token + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_BY_ID_DB_ERROR, cause=ex) + + def generate_id(self): + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + query = "select max(id) as id from oauthtoken;" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + max1 = result[0] + if max1 is None: + return 1 + else: + return int(max1) + 1 + except Exception as e1: + raise SDKException(Constants.TOKEN_STORE, Constants.GENERATE_TOKEN_ID_ERROR, cause=e1) + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + def check_table_exists(self): + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + cursor = connection.cursor() + # Query to check if table exists + cursor.execute("SELECT * FROM oauthtoken limit 1") + table = cursor.fetchone() + return table is not None + except Exception as e1: + return False + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None \ No newline at end of file diff --git a/samples/modules/GetModule.py b/samples/modules/GetModule.py new file mode 100644 index 0000000..c86a3e0 --- /dev/null +++ b/samples/modules/GetModule.py @@ -0,0 +1,172 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, ResponseWrapper, APIException + + +class GetModule: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_module(id): + """ + This method is used to get metadata about single module with it's API Name and print the response. + :param module_api_name: The API Name of the module to obtain metadata + """ + """ + example + module_api_name = "Leads"; + """ + modules_operations = ModulesOperations() + # Call get_module method that takes module_api_name as parameter + response = modules_operations.get_module(id) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + modules_list = response_object.get_modules() + for module in modules_list: + print("Module ID: " + str(module.get_id())) + print("Module API Name: " + str(module.get_api_name())) + print("Module Name: " + str(module.get_module_name())) + print("Module Is Convertable: " + str(bool(module.get_convertable()))) + print("Module Is editable: " + str(bool(module.get_editable()))) + print("Module Is deletable: " + str(bool(module.get_deletable()))) + print("Module Web Link: " + str(module.get_web_link())) + print("Module Singular Label: " + str(module.get_singular_label())) + if module.get_modified_time() is not None: + print("Module Modified Time: " + str(module.get_modified_time())) + print("Module Is viewable: " + str(bool(module.get_viewable()))) + print("Module Is API supported: " + str(bool(module.get_api_supported()))) + print("Module Is creatable: " + str(module.get_creatable())) + print("Module Plural Label: " + str(bool(module.get_plural_label()))) + print("Module Generated Type: " + str(bool(module.get_generated_type()))) + print("Module Is blueprintsupported: " + str(bool(module.get_isblueprintsupported()))) + print("Module is Visible: " + str(bool(module.get_visible()))) + om_demand_properties = module.get_on_demand_properties() + if om_demand_properties is not None: + for om_demand_property in om_demand_properties: + print("\n Module onDemandProperties Fields: ") + print(om_demand_property) + arguments = module.get_arguments() + if arguments is not None: + for argument in arguments: + print('Module Argument Name: ' + argument.get_name()) + print("Module Argument Value: " + argument.get_value()) + modified_by_user = module.get_modified_by() + if modified_by_user is not None: + print("Module Modified By User-ID: " + str(modified_by_user.get_id())) + print("Module Modified By User-Name: " + str(modified_by_user.get_name())) + print("Module Is Global Search Supported: " + str(bool(module.get_global_search_supported()))) + print("Module Presence Sub Menu: " + str(bool(module.get_presence_sub_menu()))) + print("Module Is Triggers Supported: " + str(bool(module.get_triggers_supported()))) + print("Module Is Feeds Required: " + str(bool(module.get_feeds_required()))) + print("Module Is Scoring Supported: " + str(bool(module.get_scoring_supported()))) + print("Module Is Webform Supported: " + str(bool(module.get_webform_supported()))) + print("Module Is Kanban view: " + str(bool(module.get_kanban_view()))) + if module.get_kanban_view_supported() is not None: + print("Module Is Kanban view Supported: " + str(bool(module.get_kanban_view_supported()))) + print("Module Show as tab: " + str(bool(module.get_show_as_tab()))) + print("Module Filter Status: " + str(bool(module.get_filter_status()))) + print("Module Quick Create: " + str(bool(module.get_quick_create()))) + print("Module Is email template Supported: " + str(bool(module.get_emailtemplate_support()))) + print("Module Is inventory template Supported: " + str( + bool(module.get_inventory_template_supported()))) + print("Module Description: " + str(module.get_description())) + print("Module Display Field: " + str(module.get_display_field())) + print("Module Visibility: " + str(module.get_visibility())) + print("Module Business card field limit: " + str(module.get_business_card_field_limit())) + print("Module Per page: " + str(module.get_per_page())) + print("Module Sequence Number: " + str(module.get_sequence_number())) + custom_view = module.get_custom_view() + if custom_view is not None: + GetModule.print_custom_view(custom_view) + profiles = module.get_profiles() + if profiles is not None and len(profiles) > 0: + for profile in profiles: + print('Name: ' + str(profile.get_name())) + print('ID: ' + str(profile.get_id())) + search_layout_fields = module.get_search_layout_fields() + if search_layout_fields is not None: + print("Module SearchLayoutFields Fields: ") + for field in search_layout_fields: + print(field, end=",") + print('\n') + related_list_properties = module.get_related_list_properties() + if related_list_properties is not None: + print('Module RelatedListProperties Sort By:' + str(related_list_properties.get_sort_by())) + print('Module RelatedListProperties Sort Order:' + str( + related_list_properties.get_sort_order())) + fields = related_list_properties.get_fields() + if fields is not None: + print('Module RelatedListProperties Fields') + for field in fields: + print(field, end=",") + print('\n') + properties = module.get_properties() + if properties is not None: + print("Module Properties Fields: ") + for property in properties: + print(property, end=',') + print('\n') + parent_module = module.get_parent_module() + if parent_module is not None and parent_module.get_api_name() is not None: + print('Module Parent Module Id: ' + str(parent_module.get_id())) + print('Module Parent Module Name: ' + str(parent_module.get_api_name())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + @staticmethod + def print_custom_view(custom_view): + print('CustomView ID: ' + str(custom_view.get_id())) + print('CustomView Name: ' + str(custom_view.get_name())) + print('CustomView System Name: ' + str(custom_view.get_system_name())) + print('CustomView Display Value: ' + str(custom_view.get_display_value())) + print('CustomView Is default: ' + str(custom_view.get_default())) + print('CustomView SortBy: ' + str(custom_view.get_sort_by())) + if custom_view.get_sort_order() is not None: + print('CustomView SortOrder: ' + str(custom_view.get_sort_order())) + print('CustomView Is System Defined: ' + str(custom_view.get_system_defined())) + if custom_view.get_favorite() is not None: + print('CustomView Favorite: ' + str(custom_view.get_favorite())) + criteria = custom_view.get_criteria() + if criteria is not None: + GetModule.print_criteria(criteria) + fields = custom_view.get_fields() + if fields is not None: + print('Fields') + for field in fields: + print(field.get_api_name()) + + @staticmethod + def print_criteria(criteria): + if criteria.get_comparator() is not None: + print('CustomView Criteria Comparator: ' + criteria.get_comparator()) + if criteria.get_field() is not None: + print('CustomView Criteria Field api name: ' + criteria.get_field().get_api_name()) + if criteria.get_value() is not None: + print('CustomView Criteria Value: ' + str(criteria.get_value())) + criteria_group = criteria.get_group() + if criteria_group is not None: + for each_criteria in criteria_group: + GetModule.print_criteria(each_criteria) + if criteria.get_group_operator() is not None: + print('CustomView Criteria Group Operator: ' + criteria.get_group_operator().get_value()) + + +module_id = 34775367 +GetModule.initialize() +GetModule.get_module(module_id) diff --git a/samples/modules/GetModuleByAPIName.py b/samples/modules/GetModuleByAPIName.py new file mode 100644 index 0000000..768a4a9 --- /dev/null +++ b/samples/modules/GetModuleByAPIName.py @@ -0,0 +1,173 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, ResponseWrapper, APIException + + +class GetModule: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_module_by_api_name(module_api_name): + """ + This method is used to get metadata about single module with it's API Name and print the response. + :param module_api_name: The API Name of the module to obtain metadata + """ + """ + example + module_api_name = "Leads"; + """ + modules_operations = ModulesOperations() + # Call get_module method that takes module_api_name as parameter + response = modules_operations.get_module_by_api_name(module_api_name) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + modules_list = response_object.get_modules() + for module in modules_list: + print("Module ID: " + str(module.get_id())) + print("Module API Name: " + str(module.get_api_name())) + print("Module Name: " + str(module.get_module_name())) + print("Module Is Convertable: " + str(bool(module.get_convertable()))) + print("Module Is editable: " + str(bool(module.get_editable()))) + print("Module Is deletable: " + str(bool(module.get_deletable()))) + print("Module Web Link: " + str(module.get_web_link())) + print("Module Singular Label: " + str(module.get_singular_label())) + if module.get_modified_time() is not None: + print("Module Modified Time: " + str(module.get_modified_time())) + print("Module Is viewable: " + str(bool(module.get_viewable()))) + print("Module Is API supported: " + str(bool(module.get_api_supported()))) + print("Module Is creatable: " + str(module.get_creatable())) + print("Module Plural Label: " + str(bool(module.get_plural_label()))) + print("Module Generated Type: " + str(bool(module.get_generated_type()))) + print("Module Is blueprintsupported: " + str(bool(module.get_isblueprintsupported()))) + print("Module is Visible: " + str(bool(module.get_visible()))) + om_demand_properties = module.get_on_demand_properties() + if om_demand_properties is not None: + for om_demand_property in om_demand_properties: + print("\n Module onDemandProperties Fields: ") + print(om_demand_property) + arguments = module.get_arguments() + if arguments is not None: + for argument in arguments: + print('Module Argument Name: ' + argument.get_name()) + print("Module Argument Value: " + argument.get_value()) + modified_by_user = module.get_modified_by() + if modified_by_user is not None: + print("Module Modified By User-ID: " + str(modified_by_user.get_id())) + print("Module Modified By User-Name: " + str(modified_by_user.get_name())) + print("Module Is Global Search Supported: " + str(bool(module.get_global_search_supported()))) + print("Module Presence Sub Menu: " + str(bool(module.get_presence_sub_menu()))) + print("Module Is Triggers Supported: " + str(bool(module.get_triggers_supported()))) + print("Module Is Feeds Required: " + str(bool(module.get_feeds_required()))) + print("Module Is Scoring Supported: " + str(bool(module.get_scoring_supported()))) + print("Module Is Webform Supported: " + str(bool(module.get_webform_supported()))) + print("Module Is Kanban view: " + str(bool(module.get_kanban_view()))) + if module.get_kanban_view_supported() is not None: + print("Module Is Kanban view Supported: " + str(bool(module.get_kanban_view_supported()))) + print("Module Show as tab: " + str(bool(module.get_show_as_tab()))) + print("Module Filter Status: " + str(bool(module.get_filter_status()))) + print("Module Quick Create: " + str(bool(module.get_quick_create()))) + print("Module Is email template Supported: " + str(bool(module.get_emailtemplate_support()))) + print("Module Is inventory template Supported: " + str( + bool(module.get_inventory_template_supported()))) + print("Module Description: " + str(module.get_description())) + print("Module Display Field: " + str(module.get_display_field())) + print("Module Visibility: " + str(module.get_visibility())) + print("Module Business card field limit: " + str(module.get_business_card_field_limit())) + print("Module Per page: " + str(module.get_per_page())) + print("Module Sequence Number: " + str(module.get_sequence_number())) + custom_view = module.get_custom_view() + if custom_view is not None: + GetModule.print_custom_view(custom_view) + profiles = module.get_profiles() + if profiles is not None and len(profiles) > 0: + for profile in profiles: + print('Name: ' + str(profile.get_name())) + print('ID: ' + str(profile.get_id())) + search_layout_fields = module.get_search_layout_fields() + if search_layout_fields is not None: + print("Module SearchLayoutFields Fields: ") + for field in search_layout_fields: + print(field, end=",") + print('\n') + related_list_properties = module.get_related_list_properties() + if related_list_properties is not None: + print('Module RelatedListProperties Sort By:' + str(related_list_properties.get_sort_by())) + print('Module RelatedListProperties Sort Order:' + str( + related_list_properties.get_sort_order())) + fields = related_list_properties.get_fields() + if fields is not None: + print('Module RelatedListProperties Fields') + for field in fields: + print(field, end=",") + print('\n') + properties = module.get_properties() + if properties is not None: + print("Module Properties Fields: ") + for property in properties: + print(property, end=',') + print('\n') + parent_module = module.get_parent_module() + if parent_module is not None and parent_module.get_api_name() is not None: + print('Module Parent Module Id: ' + str(parent_module.get_id())) + print('Module Parent Module Name: ' + str(parent_module.get_api_name())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + @staticmethod + def print_custom_view(custom_view): + print('CustomView ID: ' + str(custom_view.get_id())) + print('CustomView Name: ' + str(custom_view.get_name())) + print('CustomView System Name: ' + str(custom_view.get_system_name())) + print('CustomView Display Value: ' + str(custom_view.get_display_value())) + print('CustomView Is default: ' + str(custom_view.get_default())) + print('CustomView SortBy: ' + str(custom_view.get_sort_by())) + if custom_view.get_sort_order() is not None: + print('CustomView SortOrder: ' + str(custom_view.get_sort_order())) + print('CustomView Is System Defined: ' + str(custom_view.get_system_defined())) + if custom_view.get_favorite() is not None: + print('CustomView Favorite: ' + str(custom_view.get_favorite())) + criteria = custom_view.get_criteria() + if criteria is not None: + GetModule.print_criteria(criteria) + fields = custom_view.get_fields() + if fields is not None: + print('Fields') + for field in fields: + print(field.get_api_name()) + + @staticmethod + def print_criteria(criteria): + if criteria.get_comparator() is not None: + print('CustomView Criteria Comparator: ' + criteria.get_comparator()) + if criteria.get_field() is not None: + print('CustomView Criteria Field api name: ' + criteria.get_field().get_api_name()) + if criteria.get_value() is not None: + print('CustomView Criteria Value: ' + str(criteria.get_value())) + criteria_group = criteria.get_group() + if criteria_group is not None: + for each_criteria in criteria_group: + GetModule.print_criteria(each_criteria) + if criteria.get_group_operator() is not None: + print('CustomView Criteria Group Operator: ' + criteria.get_group_operator().get_value()) + + +module_api_name = "Leads" +GetModule.initialize() +GetModule.get_module_by_api_name(module_api_name) diff --git a/samples/modules/GetModules.py b/samples/modules/GetModules.py new file mode 100644 index 0000000..c035f5a --- /dev/null +++ b/samples/modules/GetModules.py @@ -0,0 +1,131 @@ +from datetime import datetime +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, GetModulesHeader, ResponseWrapper, APIException + + +class GetModules: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_modules(): + """ + This method is used to get metadata about all the modules and print the response. + """ + modules_operations = ModulesOperations() + header_instance = HeaderMap() + # Add header to HeaderMap instance, if necessary + header_instance.add(GetModulesHeader.if_modified_since, datetime(2020, 1, 1, 10, 1, 1)) + # Call get_modules method that takes header_instance as parameter + response = modules_operations.get_modules(header_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + modules_list = response_object.get_modules() + for module in modules_list: + print("Module ID: " + str(module.get_id())) + print("Module API Name: " + str(module.get_api_name())) + print("Module Name: " + str(module.get_module_name())) + print("Module Is Convertable: " + str(bool(module.get_convertable()))) + print("Module Is editable: " + str(bool(module.get_editable()))) + print("Module Is deletable: " + str(bool(module.get_deletable()))) + print("Module Web Link: " + str(module.get_web_link())) + print("Module Singular Label: " + str(module.get_singular_label())) + if module.get_modified_time() is not None: + print("Module Modified Time: " + str(module.get_modified_time())) + print("Module Is viewable: " + str(bool(module.get_viewable()))) + print("Module Is API supported: " + str(bool(module.get_api_supported()))) + print("Module Is creatable: " + str(module.get_creatable())) + print("Module Plural Label: " + str(bool(module.get_plural_label()))) + print("Module Generated Type: " + str(bool(module.get_generated_type()))) + arguments = module.get_arguments() + if arguments is not None: + for argument in arguments: + print('Module Argument Name: ' + argument.get_name()) + print("Module Argument Value: " + argument.get_value()) + modified_by_user = module.get_modified_by() + if modified_by_user is not None: + print("Module Modified By User-ID: " + str(modified_by_user.get_id())) + print("Module Modified By User-Name: " + str(modified_by_user.get_name())) + print("Module Is Global Search Supported: " + str(bool(module.get_global_search_supported()))) + print("Module Is blueprintsupported: " + str(bool(module.get_isblueprintsupported()))) + print("Module is Visible: " + str(bool(module.get_visible()))) + om_demand_properties = module.get_on_demand_properties() + if om_demand_properties is not None: + for om_demand_property in om_demand_properties: + print("\n Module onDemandProperties Fields: ") + print(om_demand_property) + print("Module Presence Sub Menu: " + str(bool(module.get_presence_sub_menu()))) + print("Module Is Triggers Supported: " + str(bool(module.get_triggers_supported()))) + print("Module Is Feeds Required: " + str(bool(module.get_feeds_required()))) + print("Module Is Scoring Supported: " + str(bool(module.get_scoring_supported()))) + print("Module Is Webform Supported: " + str(bool(module.get_webform_supported()))) + if module.get_kanban_view() is not None: + print("Module Is Kanban view: " + str(bool(module.get_kanban_view()))) + print("Module Is Kanban view Supported: " + str(bool(module.get_kanban_view_supported()))) + print("Module Show as tab: " + str(bool(module.get_show_as_tab()))) + print("Module Filter Status: " + str(bool(module.get_filter_status()))) + print("Module Quick Create: " + str(bool(module.get_quick_create()))) + print("Module Is email template Supported: " + str(bool(module.get_emailtemplate_support()))) + print("Module Is inventory template Supported: " + str( + bool(module.get_inventory_template_supported()))) + print("Module Description: " + str(module.get_description())) + print("Module Display Field: " + str(module.get_display_field())) + print("Module Visibility: " + str(module.get_visibility())) + print("Module Business card field limit: " + str(module.get_business_card_field_limit())) + print("Module Per page: " + str(module.get_per_page())) + print("Module Sequence Number: " + str(module.get_sequence_number())) + profiles = module.get_profiles() + if profiles is not None and len(profiles) > 0: + for profile in profiles: + print('Name: ' + str(profile.get_name())) + print('ID: ' + str(profile.get_id())) + search_layout_fields = module.get_search_layout_fields() + if search_layout_fields is not None: + print("Module SearchLayoutFields Fields: ") + for field in search_layout_fields: + print(field, end=",") + print('\n') + related_list_properties = module.get_related_list_properties() + if related_list_properties is not None: + print('Module RelatedListProperties Sort By:' + str(related_list_properties.get_sort_by())) + print('Module RelatedListProperties Sort Order:' + str( + related_list_properties.get_sort_order())) + fields = related_list_properties.get_fields() + if fields is not None: + print('Module RelatedListProperties Fields') + for field in fields: + print(field, end=",") + print('\n') + properties = module.get_properties() + if properties is not None: + print("Module Properties Fields: ") + for property in properties: + print(property, end=',') + print('\n') + parent_module = module.get_parent_module() + if parent_module is not None and parent_module.get_api_name() is not None: + print('Module Parent Module Id: ' + str(parent_module.get_id())) + print('Module Parent Module Name: ' + str(parent_module.get_api_name())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetModules.initialize() +GetModules.get_modules() \ No newline at end of file diff --git a/samples/modules/UpdateModuleByAPIName.py b/samples/modules/UpdateModuleByAPIName.py new file mode 100644 index 0000000..300e95d --- /dev/null +++ b/samples/modules/UpdateModuleByAPIName.py @@ -0,0 +1,74 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, Modules, BodyWrapper, ActionWrapper, \ + SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.profiles import MinifiedProfile + + +class UpdateModuleByAPIName: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_module_by_api_name(module_api_name): + """ + This method is used to update module details using module APIName and print the response. + :param module_api_name: The API Name of the module to update + """ + """ + example + module_api_name = "Leads"; + """ + modules_operations = ModulesOperations() + modules_list = [] + profiles_list = [] + profile = MinifiedProfile() + profile.set_id(34770610026014) + profiles_list.append(profile) + module = Modules() + module.set_profiles(profiles_list) + modules_list.append(module) + request = BodyWrapper() + request.set_modules(modules_list) + # Call update_module_by_api_name method that takes BodyWrapper instance and module_api_name as parameter + response = modules_operations.update_module_by_api_name(module_api_name, request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_modules() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +module_api_name = "Leads" +UpdateModuleByAPIName.initialize() +UpdateModuleByAPIName.update_module_by_api_name(module_api_name) diff --git a/samples/modules/UpdateModuleById.py b/samples/modules/UpdateModuleById.py new file mode 100644 index 0000000..8cc55a9 --- /dev/null +++ b/samples/modules/UpdateModuleById.py @@ -0,0 +1,78 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import APIException, SuccessResponse, ActionWrapper, ModulesOperations, \ + Modules, BodyWrapper +from zohocrmsdk.src.com.zoho.crm.api.profiles import MinifiedProfile + + +class UpdateModuleById: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_module_by_id(module_id): + """ + This method is used to update module details using module Id and print the response. + :param module_id: The id of the module to update + """ + """ + example + module_id = 34096430252001 + """ + modules_operations = ModulesOperations() + modules_list = [] + profiles_list = [] + profile = MinifiedProfile() + # To set the Profile Id + profile.set_id(440280031160) + # profile.set_delete(True) + # Add Profile instance to the list + profiles_list.append(profile) + module = Modules() + module.set_profiles(profiles_list) + # Add the Module instance to list + modules_list.append(module) + request = BodyWrapper() + request.set_modules(modules_list) + # Call update_module_by_id method that takes BodyWrapper instance and module_id as parameter + response = modules_operations.update_module(module_id, request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_modules() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +module_id = 3477061000000485367 +UpdateModuleById.initialize() +UpdateModuleById.update_module_by_id(module_id) diff --git a/samples/modules/__init__.py b/samples/modules/__init__.py new file mode 100644 index 0000000..1f9c140 --- /dev/null +++ b/samples/modules/__init__.py @@ -0,0 +1,4 @@ +from .GetModule import GetModule +from .GetModules import GetModules +from .UpdateModuleById import UpdateModuleById +from .UpdateModuleByAPIName import UpdateModuleByAPIName diff --git a/samples/org/DeleteOrganizationPhoto.py b/samples/org/DeleteOrganizationPhoto.py new file mode 100644 index 0000000..0c2fed7 --- /dev/null +++ b/samples/org/DeleteOrganizationPhoto.py @@ -0,0 +1,41 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter, INDataCenter +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, SuccessResponse, APIException + + +class DeleteOrganizationPhoto: + @staticmethod + def initialize(): + environment = INDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def delete_organization_photo(): + org_operations = OrgOperations() + response = org_operations.delete_organization_photo() + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +DeleteOrganizationPhoto.initialize() +DeleteOrganizationPhoto.delete_organization_photo() \ No newline at end of file diff --git a/samples/org/GetOrganization.py b/samples/org/GetOrganization.py new file mode 100644 index 0000000..652d3cb --- /dev/null +++ b/samples/org/GetOrganization.py @@ -0,0 +1,84 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, ResponseWrapper, APIException + + +class GetOrganization: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_organization(): + """ + This method is used to get the organization data and print the response. + """ + org_operations = OrgOperations() + # Call get_organization method + response = org_operations.get_organization() + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + org_list = response_object.get_org() + for org in org_list: + print("Organization Country: " + str(org.get_country())) + hierarchy_preferences = org.get_hierarchy_preferences() + if hierarchy_preferences is not None: + print("Organization HierarchyPreferences Type: " + str(hierarchy_preferences.get_type())) + print("Organization HipaaComplianceEnabled: " + str(org.get_hipaa_compliance_enabled())) + print("Organization PhotoId: " + str(org.get_photo_id())) + print("Organization City: " + str(org.get_city())) + print("Organization Description: " + str(org.get_description())) + print("Organization McStatus: " + str(org.get_mc_status())) + print("Organization GappsEnabled: " + str(org.get_gapps_enabled())) + print("Organization DomainName: " + str(org.get_domain_name())) + print("Organization TranslationEnabled: " + str(org.get_translation_enabled())) + print("Organization Alias: " + str(org.get_alias())) + print("Organization Id: " + str(org.get_id())) + print("Organization State: " + str(org.get_state())) + print("Organization Fax: " + str(org.get_fax())) + print("Organization EmployeeCount: " + str(org.get_employee_count())) + print("Organization Zip: " + str(org.get_zip())) + print("Organization Website: " + str(org.get_website())) + print("Organization CurrencySymbol: " + str(org.get_currency_symbol())) + print("Organization Mobile: " + str(org.get_mobile())) + print("Organization CurrencyLocale: " + str(org.get_currency_locale())) + print("Organization PrimaryZuid: " + str(org.get_primary_zuid())) + print("Organization ZiaPortalId: " + str(org.get_zia_portal_id())) + print("Organization TimeZone: " + str(org.get_time_zone())) + print("Organization Zgid: " + str(org.get_zgid())) + print("Organization CountryCode: " + str(org.get_country_code())) + license_details = org.get_license_details() + if license_details is not None: + print("Organization LicenseDetails PaidExpiry: " + str(license_details.get_paid_expiry())) + print("Organization LicenseDetails UsersLicensePurchased: " + str( + license_details.get_users_license_purchased())) + print("Organization LicenseDetails TrialType: " + str(license_details.get_trial_type())) + print("Organization LicenseDetails TrialExpiry: " + str(license_details.get_trial_expiry())) + print("Organization LicenseDetails Paid: " + str(license_details.get_paid())) + print("Organization LicenseDetails PaidType: " + str(license_details.get_paid_type())) + print("Organization Phone: " + str(org.get_phone())) + print("Organization CompanyName: " + str(org.get_company_name())) + print("Organization PrivacySettings: " + str(org.get_privacy_settings())) + print("Organization PrimaryEmail: " + str(org.get_primary_email())) + print("Organization IsoCode: " + str(org.get_iso_code())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetOrganization.initialize() +GetOrganization.get_organization() \ No newline at end of file diff --git a/samples/org/GetOrganizationPhoto.py b/samples/org/GetOrganizationPhoto.py new file mode 100644 index 0000000..e4a2910 --- /dev/null +++ b/samples/org/GetOrganizationPhoto.py @@ -0,0 +1,50 @@ +import os + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, FileBodyWrapper, APIException + + +class GetOrganizationPhoto: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_organization_photo(destination_folder): + org_operations = OrgOperations() + response = org_operations.get_org_photo() + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, FileBodyWrapper): + 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: + for chunk in stream_wrapper.get_stream(): + f.write(chunk) + f.close() + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +destintion_folder = "/Users/sdk-sample/file" +GetOrganizationPhoto.initialize() +GetOrganizationPhoto.get_organization_photo(destintion_folder) diff --git a/samples/org/UploadOrganizationPhoto.py b/samples/org/UploadOrganizationPhoto.py new file mode 100644 index 0000000..ad66e02 --- /dev/null +++ b/samples/org/UploadOrganizationPhoto.py @@ -0,0 +1,66 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, FileBodyWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper + + +class UploadOrganizationPhoto: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def upload_organization_photo(absolute_file_path): + """ + This method is used to upload the brand logo or image of the organization and print the response. + :param absolute_file_path: The absolute file path of the file to be attached + """ + """ + example + absolute_file_path = "/Users/user_name/Desktop/logo.png"; + """ + org_operations = OrgOperations() + request = FileBodyWrapper() + """ + StreamWrapper can be initialized in any of the following ways + * param 1 -> fileName + * param 2 -> Read Stream. + """ + # stream_wrapper = StreamWrapper(stream=open(absolute_file_path, 'rb')) + """ + * param 1 -> fileName + * param 2 -> Read Stream + * param 3 -> Absolute File Path of the file to be attached + """ + stream_wrapper = StreamWrapper(file_path=absolute_file_path) + request.set_file(stream_wrapper) + # Call upload_organization_photo method that takes FileBodyWrapper instance as parameter + response = org_operations.upload_organization_photo(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +absolute_file_path = "/Users/Desktop/test.png" +UploadOrganizationPhoto.initialize() +UploadOrganizationPhoto.upload_organization_photo(absolute_file_path) diff --git a/samples/org/__init__.py b/samples/org/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/samples/record/GetRecord.py b/samples/record/GetRecord.py new file mode 100644 index 0000000..de16700 --- /dev/null +++ b/samples/record/GetRecord.py @@ -0,0 +1,371 @@ +import os +from datetime import datetime + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, ParameterMap, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.attachments import Attachment +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.layouts import MinifiedLayout +from zohocrmsdk.src.com.zoho.crm.api.record import RecordOperations, ResponseWrapper, \ + FileDetails, Reminder, Participants, ImageUpload, PricingDetails, Record, LineTax, Comment, RemindAt, \ + RecurringActivity, Consent, FileBodyWrapper, APIException, GetRecordParam, GetRecordHeader +from zohocrmsdk.src.com.zoho.crm.api.tags import Tag +from zohocrmsdk.src.com.zoho.crm.api.taxes import Tax +from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class GetRecord: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_record(module_api_name, record_id, destination_folder): + """ + This method is used to get a single record of a module with ID and print the response. + :param module_api_name: The API Name of the record's module. + :param record_id: The ID of the record to be obtained. + :param destination_folder: The absolute path of the destination folder to store the downloaded attachment Record + """ + """ + example + module_api_name = 'Leads' + record_id = 3477061006603276 + """ + record_operations = RecordOperations(module_api_name) + param_instance = ParameterMap() + # Possible parameters for Get Record operation + param_instance.add(GetRecordParam.cvid, '34096430087501') + param_instance.add(GetRecordParam.approved, 'true') + param_instance.add(GetRecordParam.converted, 'both') + fields = ['id', 'Company', 'MultiSelectLookup'] + for field in fields: + param_instance.add(GetRecordParam.fields, field) + start_date_time = datetime(2020, 1, 1, 10, 10, 10) + param_instance.add(GetRecordParam.startdatetime, start_date_time) + end_date_time = datetime(2023, 7, 7, 10, 10, 10) + param_instance.add(GetRecordParam.enddatetime, end_date_time) + param_instance.add(GetRecordParam.territory_id, '34096430505351') + param_instance.add(GetRecordParam.include_child, 'true') + param_instance.add(GetRecordParam.uid, '34096430500741') + header_instance = HeaderMap() + # Possible headers for Get Record operation + header_instance.add(GetRecordHeader.if_modified_since, datetime.now()) + header_instance.add(GetRecordHeader.x_external, "Leads.External") + # Call getRecord method that takes record_id, module_api_name, param_instance and header_instance as parameter + response = record_operations.get_record(record_id, param_instance, header_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + print("Record ID: " + str(record.get_id())) + created_by = record.get_created_by() + if created_by is not None: + print("Record Created By - Name: " + + created_by.get_name()) + print("Record Created By - ID: " + + str(created_by.get_id())) + print("Record Created By - Email: " + + created_by.get_email()) + print("Record CreatedTime: " + + str(record.get_created_time())) + if record.get_modified_time() is not None: + print("Record ModifiedTime: " + + str(record.get_modified_time())) + modified_by = record.get_modified_by() + if modified_by is not None: + print("Record Modified By - Name: " + + modified_by.get_name()) + print("Record Modified By - ID: " + + str(modified_by.get_id())) + print("Record Modified By - Email: " + + modified_by.get_email()) + tags = record.get_tag() + if tags is not None: + for tag in tags: + print("Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + str(tag.get_id())) + # To get particular field value + print("Record Field Value: " + + str(record.get_key_value('Last_Name'))) + print('Record KeyValues: ') + key_values = record.get_key_values() + for key_name, value in key_values.items(): + if isinstance(value, list): + if len(value) > 0: + if isinstance(value[0], FileDetails): + file_details = value + for file_detail in file_details: + print( + "Record FileDetails FileName: " + file_detail.get_file_name__s()) + print( + "Record FileDetails FileId: " + file_detail.get_file_id__s()) + print( + "Record FileDetails FileSize: " + file_detail.get_size__s()) + print( + "Record FileDetails id: " + str(file_detail.get_id())) + elif isinstance(value[0], Reminder): + reminders = value + for reminder in reminders: + print("Reminder Period: " + + reminder.get_period()) + print("Reminder Unit: " + + reminder.get_unit()) + elif isinstance(value[0], Choice): + choice_list = value + print(key_name) + print('Values') + for choice in choice_list: + print(choice.get_value()) + elif isinstance(value[0], Participants): + participants = value + for participant in participants: + print("Record Participants Name: ") + print(participant.get_name()) + print( + "Record Participants Invited: " + str(participant.get_invited())) + print( + "Record Participants Type: " + participant.get_type()) + print( + "Record Participants Participant: " + participant.get_participant()) + print( + "Record Participants Status: " + participant.get_status()) + elif isinstance(value[0], Tax): + tax = value[0] + print("Record Tax Name: " + + tax.get_value()) + print("Record Tax ID: " + + str(tax.get_id())) + elif isinstance(value[0], ImageUpload): + image_uploads = value + for image_upload in image_uploads: + print("RelatedRecord Id: " + + str(image_upload.get_id())) + print("RelatedRecord FileId: " + + image_upload.get_file_id__s()) + print( + "RelatedRecord SequenceNumber: " + image_upload.get_sequence_number()) + print("RelatedRecord Size: " + + str(image_upload.get_size__s())) + print("RelatedRecord State: " + + str(image_upload.get_state__s())) + print( + "RelatedRecord File_Name: " + image_upload.get_file_name__s()) + print( + "RelatedRecord PreviewId: " + str(image_upload.get_preview_id__s())) + print( + "RelatedRecord Description: " + str(image_upload.get_description())) + elif isinstance(value[0], Tag): + tags = value + if tags is not None: + for tag in tags: + print( + "Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + + str(tag.get_id())) + elif isinstance(value[0], PricingDetails): + pricing_details = value + for pricing_detail in pricing_details: + print( + "Record PricingDetails ToRange: " + str(pricing_detail.get_to_range())) + print( + "Record PricingDetails Discount: " + str(pricing_detail.get_discount())) + print( + "Record PricingDetails ID: " + str(pricing_detail.get_id())) + print("Record PricingDetails FromRange: " + str( + pricing_detail.get_from_range())) + elif isinstance(value[0], Record): + record_list = value + for each_record in record_list: + for key, val in each_record.get_key_values().items(): + print( + str(key) + " : " + str(val)) + elif isinstance(value[0], LineTax): + line_taxes = value + for line_tax in line_taxes: + print("Record LineTax Percentage: " + str( + line_tax.get_percentage())) + print( + "Record LineTax Name: " + line_tax.get_name()) + print("Record LineTax Id: " + + str(line_tax.get_id())) + print("Record LineTax Value: " + + str(line_tax.get_value())) + elif isinstance(value[0], Comment): + comments = value + for comment in comments: + print("Comment-ID: " + + str(comment.get_id())) + print("Comment-Content: " + + comment.get_comment_content()) + print("Comment-Commented_By: " + + comment.get_commented_by()) + print("Comment-Commented Time: " + + str(comment.get_commented_time())) + elif isinstance(value[0], Attachment): + attachments = value + for attachment in attachments: + print('Record Attachment ID : ' + + str(attachment.get_id())) + owner = attachment.get_owner() + if owner is not None: + print( + "Record Attachment Owner - Name: " + owner.get_name()) + print( + "Record Attachment Owner - ID: " + str(owner.get_id())) + print( + "Record Attachment Owner - Email: " + owner.get_email()) + print("Record Attachment Modified Time: " + str( + attachment.get_modified_time())) + print( + "Record Attachment File Name: " + attachment.get_file_name()) + print( + "Record Attachment Created Time: " + str(attachment.get_created_time())) + print( + "Record Attachment File Size: " + str(attachment.get_size())) + parent_id = attachment.get_parent_id() + if parent_id is not None: + print( + "Record Attachment parent record Name: ") + print( + parent_id.get_key_value("name")) + print( + "Record Attachment parent record ID: " + str(parent_id.get_id())) + print( + "Record Attachment is Editable: " + str(attachment.get_editable())) + print( + "Record Attachment File ID: " + str(attachment.get_file_id())) + print( + "Record Attachment File Type: " + str(attachment.get_type())) + print( + "Record Attachment seModule: " + str(attachment.get_se_module())) + modified_by = attachment.get_modified_by() + if modified_by is not None: + print( + "Record Attachment Modified By - Name: " + modified_by.get_name()) + print( + "Record Attachment Modified By - ID: " + str(modified_by.get_id())) + print( + "Record Attachment Modified By - Email: " + modified_by.get_email()) + print( + "Record Attachment State: " + attachment.get_state()) + created_by = attachment.get_created_by() + if created_by is not None: + print( + "Record Attachment Created By - Name: " + created_by.get_name()) + print( + "Record Attachment Created By - ID: " + str(created_by.get_id())) + print( + "Record Attachment Created By - Email: " + created_by.get_email()) + print( + "Record Attachment LinkUrl: " + str(attachment.get_link_url())) + else: + print(key_name) + for each_value in value: + print(str(each_value)) + elif isinstance(value, MinifiedUser): + print("Record " + key_name + + " User-ID: " + str(value.get_id())) + print("Record " + key_name + + " User-Name: " + value.get_name()) + print("Record " + key_name + + " User-Email: " + value.get_email()) + elif isinstance(value, MinifiedLayout): + print(key_name + " ID: " + str(value.get_id())) + print(key_name + " Name: " + value.get_name()) + elif isinstance(value, Record): + print(key_name + " Record ID: " + + str(value.get_id())) + print(key_name + " Record Name: " + + value.get_key_value('name')) + elif isinstance(value, Choice): + print(key_name + " : " + value.get_value()) + elif isinstance(value, RemindAt): + print(key_name + " : " + value.get_alarm()) + elif isinstance(value, RecurringActivity): + print(key_name) + print("RRULE: " + value.get_rrule()) + elif isinstance(value, Consent): + print("Record Consent ID: " + + str(value.get_id())) + created_by = value.get_created_by() + if created_by is not None: + print( + "Record Consent Created By - Name: " + created_by.get_name()) + print( + "Record Consent Created By - ID: " + str(created_by.get_id())) + print( + "Record Consent Created By - Email: " + created_by.get_email()) + print("Record Consent CreatedTime: " + + str(value.get_created_time())) + if value.get_modified_time() is not None: + print("Record Consent ModifiedTime: " + + str(value.get_modified_time())) + owner = value.get_owner() + if owner is not None: + print( + "Record Consent Created By - Name: " + owner.get_name()) + print( + "Record Consent Created By - ID: " + str(owner.get_id())) + print( + "Record Consent Created By - Email: " + owner.get_email()) + print("Record Consent ContactThroughEmail: " + + str(value.get_contact_through_email())) + print("Record Consent ContactThroughSocial: " + + str(value.get_contact_through_social())) + print("Record Consent ContactThroughSurvey: " + + str(value.get_contact_through_survey())) + print("Record Consent ContactThroughPhone: " + + str(value.get_contact_through_phone())) + print("Record Consent MailSentTime: " + + str(value.get_mail_sent_time())) + print("Record Consent ConsentDate: " + + str(value.get_consent_date())) + print("Record Consent ConsentRemarks: " + + value.get_consent_remarks()) + print("Record Consent ConsentThrough: " + + value.get_consent_through()) + print("Record Consent DataProcessingBasis: " + + value.get_data_processing_basis()) + # To get custom values + print("Record Consent Lawful Reason: " + + str(value.get_key_value("Lawful_Reason"))) + elif isinstance(value, dict): + for key, val in value.items(): + print(key + " : " + str(val)) + else: + print(key_name + " : " + str(value)) + elif isinstance(response_object, FileBodyWrapper): + 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: + for chunk in stream_wrapper.get_stream(): + f.write(chunk) + f.close() + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module_api_name = "Leads" +record_id = 347502001 +destination_folder = "/Users/docs/file" +GetRecord.initialize() +GetRecord.get_record(module_api_name, record_id, destination_folder) diff --git a/samples/record/GetRecords.py b/samples/record/GetRecords.py new file mode 100644 index 0000000..45520b9 --- /dev/null +++ b/samples/record/GetRecords.py @@ -0,0 +1,377 @@ +from datetime import datetime + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, ParameterMap, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.attachments import Attachment +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.layouts import MinifiedLayout +from zohocrmsdk.src.com.zoho.crm.api.record import RecordOperations, GetRecordsParam, GetRecordsHeader, ResponseWrapper, \ + FileDetails, Reminder, Participants, ImageUpload, PricingDetails, Record, LineTax, Comment, RemindAt, \ + RecurringActivity, Consent, APIException +from zohocrmsdk.src.com.zoho.crm.api.tags import Tag +from zohocrmsdk.src.com.zoho.crm.api.taxes import Tax +from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class GetRecords: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_records(module_api_name): + """ + This method is used to get all the records of a module and print the response. + :param module_api_name: The API Name of the module to fetch records + """ + """ + example + module_api_name = 'Leads' + """ + record_operations = RecordOperations(module_api_name) + param_instance = ParameterMap() + # Possible parameters for Get Records operation + param_instance.add(GetRecordsParam.page, 1) + param_instance.add(GetRecordsParam.per_page, 120) + param_instance.add(GetRecordsParam.approved, 'both') + param_instance.add(GetRecordsParam.converted, 'both') + param_instance.add(GetRecordsParam.cvid, '34096430087501') + ids = ["External1256", "3477061004352001"] + for each_id in ids: + param_instance.add(GetRecordsParam.ids, each_id) + param_instance.add(GetRecordsParam.uid, '34096430302031') + field_names = ["Company", "Email"] + for field in field_names: + param_instance.add(GetRecordsParam.fields, field) + param_instance.add(GetRecordsParam.sort_by, 'Email') + param_instance.add(GetRecordsParam.sort_order, 'desc') + start_date_time = datetime(2020, 1, 1, 0, 0, 0) + param_instance.add(GetRecordsParam.startdatetime, start_date_time) + end_date_time = datetime(2020, 7, 1, 0, 0, 0) + param_instance.add(GetRecordsParam.enddatetime, end_date_time) + param_instance.add(GetRecordsParam.territory_id, '34096430505351') + param_instance.add(GetRecordsParam.include_child, "true") + header_instance = HeaderMap() + # Possible headers for Get Records operation + header_instance.add(GetRecordsHeader.if_modified_since, + datetime.fromisoformat('2020-01-01T00:00:00+05:30')) + # header_instance.add(GetRecordsHeader.x_external, "Leads.External") + # Call get_records method that takes ParameterMap Instance, HeaderMap Instance and module_api_name as parameters + response = record_operations.get_records(param_instance, header_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + print("Record ID: " + str(record.get_id())) + created_by = record.get_created_by() + if created_by is not None: + print("Record Created By - Name: " + + created_by.get_name()) + print("Record Created By - ID: " + + str(created_by.get_id())) + print("Record Created By - Email: " + + created_by.get_email()) + print("Record CreatedTime: " + + str(record.get_created_time())) + if record.get_modified_time() is not None: + print("Record ModifiedTime: " + + str(record.get_modified_time())) + modified_by = record.get_modified_by() + if modified_by is not None: + print("Record Modified By - Name: " + + modified_by.get_name()) + print("Record Modified By - ID: " + + str(modified_by.get_id())) + print("Record Modified By - Email: " + + modified_by.get_email()) + tags = record.get_tag() + if tags is not None: + for tag in tags: + print("Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + str(tag.get_id())) + # To get particular field value + print("Record Field Value: " + + str(record.get_key_value('Last_Name'))) + print('Record KeyValues: ') + key_values = record.get_key_values() + for key_name, value in key_values.items(): + if isinstance(value, list): + if len(value) > 0: + if isinstance(value[0], FileDetails): + file_details = value + for file_detail in file_details: + print( + "Record FileDetails FileName: " + file_detail.get_file_name__s()) + print( + "Record FileDetails FileId: " + file_detail.get_file_id__s()) + print( + "Record FileDetails FileSize: " + file_detail.get_size__s()) + print( + "Record FileDetails id: " + str(file_detail.get_id())) + elif isinstance(value[0], Reminder): + reminders = value + for reminder in reminders: + print("Reminder Period: " + + reminder.get_period()) + print("Reminder Unit: " + + reminder.get_unit()) + elif isinstance(value[0], Choice): + choice_list = value + print(key_name) + print('Values') + for choice in choice_list: + print(choice.get_value()) + elif isinstance(value[0], Participants): + participants = value + for participant in participants: + print("Record Participants Name: ") + print(participant.get_name()) + print( + "Record Participants Invited: " + str(participant.get_invited())) + print( + "Record Participants Type: " + participant.get_type()) + print( + "Record Participants Participant: " + participant.get_participant()) + print( + "Record Participants Status: " + participant.get_status()) + elif isinstance(value[0], Tax): + tax = value[0] + print("Record Tax Name: " + + tax.get_value()) + print("Record Tax ID: " + + str(tax.get_id())) + elif isinstance(value[0], Tag): + tags = value + if tags is not None: + for tag in tags: + print( + "Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + + str(tag.get_id())) + elif isinstance(value[0], ImageUpload): + image_uploads = value + for image_upload in image_uploads: + print("RelatedRecord Id: " + + str(image_upload.get_id())) + print("RelatedRecord FileId: " + + image_upload.get_file_id__s()) + print( + "RelatedRecord SequenceNumber: " + image_upload.get_sequence_number()) + print("RelatedRecord Size: " + + str(image_upload.get_size__S())) + print("RelatedRecord State: " + + str(image_upload.get_state__S())) + print( + "RelatedRecord File_Name: " + image_upload.get_file_name__s()) + print( + "RelatedRecord PreviewId: " + image_upload.get_preview_id__S()) + print( + "RelatedRecord Description: " + str(image_upload.get_description())) + elif isinstance(value[0], PricingDetails): + pricing_details = value + for pricing_detail in pricing_details: + print( + "Record PricingDetails ToRange: " + str(pricing_detail.get_to_range())) + print( + "Record PricingDetails Discount: " + str(pricing_detail.get_discount())) + print( + "Record PricingDetails ID: " + str(pricing_detail.get_id())) + print("Record PricingDetails FromRange: " + str( + pricing_detail.get_from_range())) + elif isinstance(value[0], Record): + record_list = value + for each_record in record_list: + for key, val in each_record.get_key_values().items(): + print( + str(key) + " : " + str(val)) + elif isinstance(value[0], LineTax): + line_taxes = value + for line_tax in line_taxes: + print("Record LineTax Percentage: " + str( + line_tax.get_percentage())) + print( + "Record LineTax Name: " + line_tax.get_name()) + print("Record LineTax Id: " + + str(line_tax.get_id())) + print("Record LineTax Value: " + + str(line_tax.get_value())) + elif isinstance(value[0], Comment): + comments = value + for comment in comments: + print("Comment-ID: " + + str(comment.get_id())) + print( + "Comment-Content: " + str(comment.get_comment_content())) + print("Comment-Commented_By: " + + str(comment.get_commented_by())) + print("Comment-Commented Time: " + + str(comment.get_commented_time())) + elif isinstance(value[0], Attachment): + attachments = value + for attachment in attachments: + print('Record Attachment ID : ' + + str(attachment.get_id())) + owner = attachment.get_owner() + if owner is not None: + print( + "Record Attachment Owner - Name: " + owner.get_name()) + print( + "Record Attachment Owner - ID: " + str(owner.get_id())) + print( + "Record Attachment Owner - Email: " + owner.get_email()) + print("Record Attachment Modified Time: " + str( + attachment.get_modified_time())) + print( + "Record Attachment File Name: " + attachment.get_file_name()) + print( + "Record Attachment Created Time: " + str(attachment.get_created_time())) + print( + "Record Attachment File Size: " + str(attachment.get_size())) + parent_id = attachment.get_parent_id() + if parent_id is not None: + print( + "Record Attachment parent record Name: ") + print( + parent_id.get_key_value("name")) + print( + "Record Attachment parent record ID: " + str(parent_id.get_id())) + print( + "Record Attachment is Editable: " + str(attachment.get_editable())) + print( + "Record Attachment File ID: " + str(attachment.get_file_id())) + print( + "Record Attachment File Type: " + str(attachment.get_type())) + print( + "Record Attachment seModule: " + str(attachment.get_se_module())) + modified_by = attachment.get_modified_by() + if modified_by is not None: + print( + "Record Attachment Modified By - Name: " + modified_by.get_name()) + print( + "Record Attachment Modified By - ID: " + str(modified_by.get_id())) + print( + "Record Attachment Modified By - Email: " + modified_by.get_email()) + print( + "Record Attachment State: " + attachment.get_state()) + created_by = attachment.get_created_by() + if created_by is not None: + print( + "Record Attachment Created By - Name: " + created_by.get_name()) + print( + "Record Attachment Created By - ID: " + str(created_by.get_id())) + print( + "Record Attachment Created By - Email: " + created_by.get_email()) + print( + "Record Attachment LinkUrl: " + str(attachment.get_link_url())) + else: + print(key_name) + for each_value in value: + print(str(each_value)) + elif isinstance(value, MinifiedUser): + print("Record " + key_name + + " User-ID: " + str(value.get_id())) + print("Record " + key_name + + " User-Name: " + value.get_name()) + print("Record " + key_name + + " User-Email: " + value.get_email()) + elif isinstance(value, MinifiedLayout): + print(key_name + " ID: " + str(value.get_id())) + print(key_name + " Name: " + value.get_name()) + elif isinstance(value, Record): + print(key_name + " Record ID: " + + str(value.get_id())) + print(key_name + " Record Name: ") + print(value.get_key_value('name')) + elif isinstance(value, Choice): + print(key_name + " : " + value.get_value()) + elif isinstance(value, RemindAt): + print(key_name + " : " + value.get_alarm()) + elif isinstance(value, RecurringActivity): + print(key_name) + print("RRULE: " + value.get_rrule()) + elif isinstance(value, Consent): + print("Record Consent ID: " + + str(value.get_id())) + created_by = value.get_created_by() + if created_by is not None: + print( + "Record Consent Created By - Name: " + created_by.get_name()) + print( + "Record Consent Created By - ID: " + str(created_by.get_id())) + print( + "Record Consent Created By - Email: " + created_by.get_email()) + print("Record Consent CreatedTime: " + + str(value.get_created_time())) + if value.get_modified_time() is not None: + print("Record Consent ModifiedTime: " + + str(value.get_modified_time())) + owner = value.get_owner() + if owner is not None: + print( + "Record Consent Created By - Name: " + owner.get_name()) + print( + "Record Consent Created By - ID: " + str(owner.get_id())) + print( + "Record Consent Created By - Email: " + owner.get_email()) + print("Record Consent ContactThroughEmail: " + + str(value.get_contact_through_email())) + print("Record Consent ContactThroughSocial: " + + str(value.get_contact_through_social())) + print("Record Consent ContactThroughSurvey: " + + str(value.get_contact_through_survey())) + print("Record Consent ContactThroughPhone: " + + str(value.get_contact_through_phone())) + print("Record Consent MailSentTime: " + + str(value.get_mail_sent_time())) + print("Record Consent ConsentDate: " + + str(value.get_consent_date())) + print("Record Consent ConsentRemarks: " + + value.get_consent_remarks()) + print("Record Consent ConsentThrough: " + + value.get_consent_through()) + print("Record Consent DataProcessingBasis: " + + value.get_data_processing_basis()) + # To get custom values + print("Record Consent Lawful Reason: " + + str(value.get_key_value("Lawful_Reason"))) + elif isinstance(value, dict): + for key, val in value.items(): + print(key + " : " + str(val)) + else: + print(key_name + " : " + str(value)) + info = response_object.get_info() + if info is not None: + if info.get_per_page() is not None: + print('Record Info PerPage: ' + + str(info.get_per_page())) + if info.get_page() is not None: + print('Record Info Page: ' + str(info.get_page())) + if info.get_count() is not None: + print('Record Info Count: ' + + str(info.get_count())) + if info.get_more_records() is not None: + print('Record Info MoreRecords: ' + + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module_api_name = "Leads" +GetRecords.initialize() +GetRecords.get_records(module_api_name) diff --git a/samples/record/__init__.py b/samples/record/__init__.py new file mode 100644 index 0000000..e146260 --- /dev/null +++ b/samples/record/__init__.py @@ -0,0 +1,2 @@ +from .GetRecords import GetRecords +from .GetRecord import GetRecord diff --git a/samples/user_groups/CreateGroup.py b/samples/user_groups/CreateGroup.py new file mode 100644 index 0000000..a818781 --- /dev/null +++ b/samples/user_groups/CreateGroup.py @@ -0,0 +1,70 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, BodyWrapper, Groups, Sources, Source, \ + ActionWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class CreateGroup(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def create_group(): + user_groups_operations = UserGroupsOperations() + request = BodyWrapper() + user_list =[] + user_1 = Groups() + user_1.set_name("test_group") + user_1.set_description("my group") + sources = [] + source = Sources() + source.set_type(Choice("users")) + source1 = Source() + source1.set_id(324234324233) + source.set_source(source1) + sources.append(source) + user_1.set_sources(sources) + user_list.append(user_1) + request.set_user_groups(user_list) + response = user_groups_operations.create_groups(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_user_groups() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +CreateGroup.initialize() +CreateGroup.create_group() diff --git a/samples/user_groups/DeleteGroup.py b/samples/user_groups/DeleteGroup.py new file mode 100644 index 0000000..2947704 --- /dev/null +++ b/samples/user_groups/DeleteGroup.py @@ -0,0 +1,54 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, APIException, ActionWrapper, \ + SuccessResponse + + +class DeleteGroup: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def delete_group(group_id): + user_group_operations = UserGroupsOperations() + response = user_group_operations.delete_group(group_id) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_user_groups() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +DeleteGroup.initialize() +DeleteGroup.delete_group(group_id=44028001219057) \ No newline at end of file diff --git a/samples/user_groups/GetAssociatedUsersCount.py b/samples/user_groups/GetAssociatedUsersCount.py new file mode 100644 index 0000000..cdb3b6a --- /dev/null +++ b/samples/user_groups/GetAssociatedUsersCount.py @@ -0,0 +1,54 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, AssociatedUserCount, APIException + + +class GetAssociatedUsersCount(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_associated_users_count(): + user_groups_operations = UserGroupsOperations() + response = user_groups_operations.get_associated_users_count() + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, AssociatedUserCount): + associated_users_count = response_object.get_associated_users_count() + if associated_users_count is not None: + for associated_user in associated_users_count: + print("AssociatedUSer count " + str(associated_user.get_count())) + user_group = associated_user.get_user_group() + if user_group is not None: + print("Associated Name: " + user_group.get_name()) + print("AssociatedUser Id: " + str(user_group.get_id())) + info = response_object.get_info() + if info is not None: + if info.get_per_page() is not None: + print("User Info PerPage: " + str(info.get_per_page())) + if info.get_count() is not None: + print("User Info Count: " + str(info.get_count())) + if info.get_page() is not None: + print("User Info Page: " + str(info.get_page())) + if info.get_more_records() is not None: + print("User Info MoreRecords: " + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetAssociatedUsersCount.initialize() +GetAssociatedUsersCount.get_associated_users_count() \ No newline at end of file diff --git a/samples/user_groups/GetAssociations.py b/samples/user_groups/GetAssociations.py new file mode 100644 index 0000000..4990cb1 --- /dev/null +++ b/samples/user_groups/GetAssociations.py @@ -0,0 +1,52 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, AssociationWrapper, APIException + + +class GetAssociations(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_associations(group_id): + user_group_operations = UserGroupsOperations() + response = user_group_operations.get_associations(group_id) + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, AssociationWrapper): + association_wrapper = response_object + associations = association_wrapper.get_associations() + if associations is not None: + for association_response in associations: + print("Associations Type: " + association_response.get_type()) + resource = association_response.get_resource() + if resource is not None: + print("Associations Resource Id: " + str(resource.get_id())) + print("Associations Resource Name : " + resource.get_name()) + detail = association_response.get_detail() + if detail is not None: + module = detail.get_module() + if module is not None: + print("Associations Module Id : " + str(module.get_id())) + print("Associations Module api_name : " + module.get_api_name()) + print("Associations Module : " + module.get_module()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetAssociations.initialize() +GetAssociations.get_associations(group_id=44028001326019) \ No newline at end of file diff --git a/samples/user_groups/GetGroup.py b/samples/user_groups/GetGroup.py new file mode 100644 index 0000000..795efc6 --- /dev/null +++ b/samples/user_groups/GetGroup.py @@ -0,0 +1,60 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import ParameterMap, Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, ResponseWrapper, APIException + + +class GetGroup(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_group(group_id): + user_group_operations = UserGroupsOperations() + response = user_group_operations.get_group(group_id) + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, ResponseWrapper): + users = response_object.get_user_groups() + for user in users: + created_by = user.get_created_by() + if created_by is not None: + print("UserGroups Created By User-Name: " + created_by.get_name()) + print("UserGroups Created By User-ID: " + str(created_by.get_id())) + modifiedBy = user.get_modified_by() + if modifiedBy is not None: + print("UserGroups Modified By User-Name: " + modifiedBy.get_name()) + print("UserGroups Modified By User-ID: " + str(modifiedBy.get_id())) + print("User ModifiedTime: " + str(user.get_modified_time())) + print("User CreatedTime: " + str(user.get_created_time())) + print("UserGroups Description: " + user.get_description()) + print("UserGroups Id: " + str(user.get_id())) + print("UserGroups Name: " + user.get_name()) + sources = user.get_sources() + if sources is not None: + for source in sources: + print("user_groups sources type: " + source.get_type().get_value()) + source1 = source.get_source() + if source1 is not None: + print("UserGroups Sources Id : " + str(source1.get_id())) + print("userGroups sources subprdinates: " + source1.get_subordinates()) + print("userGroups Sources subTerritories : " + source.get_sub_territories()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetGroup.initialize() +GetGroup.get_group(group_id=44028001219057) \ No newline at end of file diff --git a/samples/user_groups/GetGroupedCounts.py b/samples/user_groups/GetGroupedCounts.py new file mode 100644 index 0000000..c60c1a6 --- /dev/null +++ b/samples/user_groups/GetGroupedCounts.py @@ -0,0 +1,53 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, ParameterMap +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, GroupedCountWrapper, APIException, \ + GetGroupedCountsParam + + +class GetGroupedCounts: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_grouped_counts(group_id): + user_group_operations = UserGroupsOperations() + param_instance = ParameterMap() + param_instance.add(GetGroupedCountsParam.group_by, "status") + response = user_group_operations.get_grouped_counts(group_id, param_instance) + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, GroupedCountWrapper): + grouped_counts = response_object.get_grouped_counts() + for count in grouped_counts: + print("User Status: " + count.get_status().get_value()) + print("User Count: " + str(count.get_count())) + info = response_object.get_info() + if info is not None: + if info.get_per_page() is not None: + print("User Info PerPage: " + str(info.get_per_page())) + if info.get_count() is not None: + print("User Info Count: " + str(info.get_count())) + if info.get_page() is not None: + print("User Info Page: " + str(info.get_page())) + if info.get_more_records() is not None: + print("User Info MoreRecords: " + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetGroupedCounts.initialize() +GetGroupedCounts.get_grouped_counts(group_id=3477061000017236002) diff --git a/samples/user_groups/GetGroups.py b/samples/user_groups/GetGroups.py new file mode 100644 index 0000000..df0a332 --- /dev/null +++ b/samples/user_groups/GetGroups.py @@ -0,0 +1,79 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.api.logger import Logger +from zohocrmsdk.src.com.zoho.crm.api import ParameterMap, Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, ResponseWrapper, APIException, Criteria, Field, GetGroupsParam + + +class GetGroups(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_groups(): + user_group_operations = UserGroupsOperations() + criteria = Criteria() + criteria.set_comparator("equal") + field = Field() + field.set_api_name("name") + criteria.set_field(field) + criteria.set_value("group") + param_instance = ParameterMap() + param_instance.add(GetGroupsParam.filters, criteria) + response = user_group_operations.get_groups(param_instance) + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, ResponseWrapper): + users = response_object.get_user_groups() + for user in users: + created_by = user.get_created_by() + if created_by is not None: + print("UserGroups Created By User-Name: " + created_by.get_name()) + print("UserGroups Created By User-ID: " + str(created_by.get_id())) + modifiedBy = user.get_modified_by() + if modifiedBy is not None: + print("UserGroups Modified By User-Name: " + modifiedBy.get_name()) + print("UserGroups Modified By User-ID: " + str(modifiedBy.get_id())) + print("User ModifiedTime: " + str(user.get_modified_time())) + print("User CreatedTime: " + str(user.get_created_time())) + print("UserGroups Description: " + user.get_description()) + print("UserGroups Id: " + str(user.get_id())) + print("UserGroups Name: " + user.get_name()) + sources = user.get_sources() + if sources is not None: + for source in sources: + print("user_groups sources type: " + source.get_type().get_value()) + source1 = source.get_source() + if source1 is not None: + print("UserGroups Sources Id : " + str(source1.get_id())) + print("userGroups sources subprdinates: " + source1.get_subordinates()) + print("userGroups Sources subTerritories : " + source.get_sub_territories()) + info = response_object.get_info() + if info is not None: + if info.get_per_page() is not None: + print("User Info PerPage: " + str(info.get_per_page())) + if info.get_count() is not None: + print("User Info Count: " + str(info.get_count())) + if info.get_page() is not None: + print("User Info Page: " + str(info.get_page())) + if info.get_more_records() is not None: + print("User Info MoreRecords: " + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetGroups.initialize() +GetGroups.get_groups() \ No newline at end of file diff --git a/samples/user_groups/GetSources.py b/samples/user_groups/GetSources.py new file mode 100644 index 0000000..806a4e4 --- /dev/null +++ b/samples/user_groups/GetSources.py @@ -0,0 +1,55 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import ParameterMap, Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, SourcesWrapper, APIException + + +class GetSources(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_sources(group_id): + user_group_operations = UserGroupsOperations() + param_instance = ParameterMap() + response = user_group_operations.get_sources(group_id, param_instance) + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, SourcesWrapper): + sources = response_object.get_sources() + for source in sources: + source1 = source.get_source() + if source1 is not None: + print("Sources user_name: " + source1.get_name()) + print("sources user_id: " + str(source1.get_id())) + print("sources Type : " + source.get_type().get_value()) + print("Source Subordiunates: " + str(source.get_subordinates())) + info = response_object.get_info() + if info is not None: + if info.get_per_page() is not None: + print("Sources Info PerPage: " + str(info.get_per_page())) + if info.get_count() is not None: + print("Sources Info Count: " + str(info.get_count())) + if info.get_page() is not None: + print("Sources Info Page: " + str(info.get_page())) + if info.get_more_records() is not None: + print("Sources Info MoreRecords: " + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetSources.initialize() +GetSources.get_sources(group_id=44028001219057) \ No newline at end of file diff --git a/samples/user_groups/GetSourcesCount.py b/samples/user_groups/GetSourcesCount.py new file mode 100644 index 0000000..32177f0 --- /dev/null +++ b/samples/user_groups/GetSourcesCount.py @@ -0,0 +1,46 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, SourcesCountWrapper, APIException + + +class GetSourcesCount: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_sources_count(group_id): + user_group_operations = UserGroupsOperations() + response = user_group_operations.get_sources_count(group_id) + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, SourcesCountWrapper): + sources_count = response_object.get_sources_count() + for count in sources_count: + print("sources Count Territories: " + str(count.get_territories())) + print("sources Count Roles: " + str(count.get_roles())) + print("sources Count Groups: " + str(count.get_groups())) + users = count.get_users() + if users is not None: + print("Sources Users Inactive: " + str(users.get_inactive())) + print("Sources Users Deleted: " + str(users.get_deleted())) + print("Sources Users Groups: " + str(users.get_active())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetSourcesCount.initialize() +GetSourcesCount.get_sources_count(group_id=3477061000017236002) diff --git a/samples/user_groups/UpdateGroup.py b/samples/user_groups/UpdateGroup.py new file mode 100644 index 0000000..39ceeb0 --- /dev/null +++ b/samples/user_groups/UpdateGroup.py @@ -0,0 +1,71 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, BodyWrapper, Groups, Sources, Source, \ + ActionWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class UpdateGroup(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_group(group_id): + user_groups_operations = UserGroupsOperations() + request = BodyWrapper() + user_list =[] + user_1 = Groups() + user_1.set_name("test_group_edited") + user_1.set_description("my group") + sources = [] + source = Sources() + source.set_type(Choice("roles")) + source1 = Source() + source1.set_id(440280031151) + source.set_source(source1) + sources.append(source) + user_1.set_sources(sources) + user_list.append(user_1) + request.set_user_groups(user_list) + response = user_groups_operations.update_group(group_id, request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_user_groups() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +id = 44028001219057 +UpdateGroup.initialize() +UpdateGroup.update_group(id) \ No newline at end of file diff --git a/samples/user_groups/UpdateGroups.py b/samples/user_groups/UpdateGroups.py new file mode 100644 index 0000000..b63d052 --- /dev/null +++ b/samples/user_groups/UpdateGroups.py @@ -0,0 +1,71 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.user_groups import UserGroupsOperations, BodyWrapper, Groups, Sources, Source, \ + ActionWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class UpdateGroups(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_groups(): + user_groups_operations = UserGroupsOperations() + request = BodyWrapper() + user_list =[] + user_1 = Groups() + user_1.set_id(32421423423412) + user_1.set_name("test_group") + user_1.set_description("my group") + sources = [] + source = Sources() + source.set_type(Choice("users")) + source1 = Source() + source1.set_id(324234324233) + source.set_source(source1) + sources.append(source) + user_1.set_sources(sources) + user_list.append(user_1) + request.set_user_groups(user_list) + response = user_groups_operations.update_groups(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_user_groups() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +UpdateGroups.initialize() +UpdateGroups.update_groups() diff --git a/samples/user_groups/__init__.py b/samples/user_groups/__init__.py new file mode 100644 index 0000000..ddaa685 --- /dev/null +++ b/samples/user_groups/__init__.py @@ -0,0 +1,10 @@ +from .CreateGroup import CreateGroup +from .DeleteGroup import DeleteGroup +from .GetSources import GetSources +from .GetAssociations import GetAssociations +from .GetAssociatedUsersCount import GetAssociatedUsersCount +from .GetGroups import GetGroups +from .GetGroup import GetGroup +from .UpdateGroups import UpdateGroups +from .UpdateGroup import UpdateGroup +from .GetGroupedCounts import GetGroupedCounts \ No newline at end of file diff --git a/setup.cfg b/setup.cfg new file mode 100755 index 0000000..3480374 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,2 @@ +[bdist_wheel] +universal=1 \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..3b64d59 --- /dev/null +++ b/setup.py @@ -0,0 +1,46 @@ +from setuptools import setup, find_packages +# To use a consistent encoding +from codecs import open +from os import path + +here = path.abspath(path.dirname(__file__)) + +# Get the long description from the README file +with open(path.join(here, 'README.md'), encoding='utf-8') as f: + long_description = f.read() + +setup( + name='zohocrmsdk7_0', + version='1.0.0', + description='Zoho CRM SDK for ZOHO CRM v7 APIs', + long_description=long_description, + long_description_content_type='text/markdown', + url='https://github.com/zoho/zohocrm-python-sdk-7.0', + author='Zoho CRM API Team', + author_email='support@zohocrm.com', + scripts=[], + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Intended Audience :: Developers', + 'License :: OSI Approved :: Apache Software License', + 'Topic :: Software Development :: Build Tools', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + ], + install_requires=[ + 'requests', + 'python-dateutil', + 'urllib3', + 'mysql-connector-python', + 'setuptools' + ], + keywords=['development', 'zoho', 'crm', 'api', 'zcrmsdk', 'zohocrmsdk' 'sdk', 'zcrm','zohocrmsdk7_0'], + packages=find_packages(), + include_package_data=True, + license='Apache Software License, Version 2.0, http://www.apache.org/licenses/LICENSE-2.0', +) diff --git a/versions/1.0.0/README.md b/versions/1.0.0/README.md new file mode 100755 index 0000000..6fbb6f5 --- /dev/null +++ b/versions/1.0.0/README.md @@ -0,0 +1,935 @@ +License +======= + + Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED + All rights reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + +# ZOHO CRM PYTHON SDK 7.0 for API version 7 + +## Table Of Contents + +* [Overview](#overview) +* [Registering a Zoho Client](#registering-a-zoho-client) +* [Environmental Setup](#environmental-setup) +* [Including the SDK in your project](#including-the-sdk-in-your-project) +* [Persistence](#token-persistence) + * [DataBase Persistence](#database-persistence) + * [File Persistence](#file-persistence) + * [Custom Persistence](#custom-persistence) +* [Configuration](#configuration) +* [Initialization](#initializing-the-application) +* [Class Hierarchy](#class-hierarchy) +* [Responses And Exceptions](#responses-and-exceptions) +* [Threading](#threading-in-the-python-sdk) + * [Multithreading in a Multi-User App](#multithreading-in-a-multi-user-app) + * [Multi-threading in a Single User App](#multi-threading-in-a-single-user-app) +* [Sample Code](#sdk-sample-code) +## Overview + +Zoho CRM PYTHON SDK offers a way to create client Python applications that can be integrated with Zoho CRM. + +## Registering a Zoho Client + +Since Zoho CRM APIs are authenticated with OAuth2 standards, you should register your client app with Zoho. To register your app: + +- Visit this page [https://api-console.zoho.com](https://api-console.zoho.com) + +- Click on `ADD CLIENT`. + +- Choose the `Client Type`. + +- Enter **Client Name**, **Client Domain** or **Homepage URL** and **Authorized Redirect URIs** then click `CREATE`. + +- Your Client app will be created. + +- Select the created OAuth client. + +- Generate grant token by providing the necessary scopes, time duration (the duration for which the generated token is valid) and Scope Description. + +## Environmental Setup + +Python SDK is installable through **pip**. **pip** is a tool for dependency management in Python. SDK expects the following from the client app. + +- Client app must have Python(version 3 and above) + +- Python SDK must be installed into client app through **pip**. + +## Including the SDK in your project + +- Install **Python** from [python.org](https://www.python.org/downloads/) (if not installed). + +- Install **Python SDK** + - Navigate to the workspace of your client app. + - Run the command below: + + ```sh + pip install zohocrmsdk7_0 + ``` +- The Python SDK will be installed in your client application. + +## Token Persistence + +Token persistence refers to storing and utilizing the authentication tokens that are provided by Zoho. Token persistence enables the SDK to automatically refresh the access token after initialization using the refresh token without the need for user intervention. There are three ways provided by the SDK in which persistence can be utilized. They are DataBase Persistence, File Persistence, and Custom Persistence. Please note that the default method of token persistence provided by the Zoho CRM SDK is File persistence. + +### Table of Contents + +- [DataBase Persistence](#database-persistence) + +- [File Persistence](#file-persistence) + +- [Custom Persistence](#custom-persistence) + +### Implementing OAuth Persistence + +Once the application is authorized, OAuth access and refresh tokens can be used for subsequent user data requests to Zoho CRM. Hence, they need to be persisted by the client app. + +The persistence is achieved by writing an implementation of the inbuilt Abstract Base Class **[TokenStore](zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py)**, which has the following callback methods. + +- **find_token(self, [token](zohocrmsdk/src/com/zoho/api/authenticator/token.py))** - invoked before firing a request to fetch the saved tokens. This method should return implementation of inbuilt **Token Class** object for the library to process it. + +- **save_token(self, [token](zohocrmsdk/src/com/zoho/api/authenticator/token.py))** - invoked after fetching access and refresh tokens from Zoho. + +- **delete_token(self, id)** - The method to delete the particular stored token based on unique ID + +- **get_tokens(self)** - The method to get the all the stored tokens. + +- **delete_tokens(self)** - The method to delete all the stored tokens. + +- **find_token_by_id(self, id)** - The method to retrieve the user's token details based on unique ID. + +Note: +- id is a String. +- token is an instance of Token Class. + +### DataBase Persistence + +In case the user prefers to use default DataBase persistence, **MySQL** can be used. + +- Create a table in your Database with required columns + + - id varchar(10) + + - user_name varchar(255) + + - client_id varchar(255) + + - client_secret varchar(255) + + - refresh_token varchar(255) + + - access_token varchar(255) + + - grant_token varchar(255) + + - expiry_time varchar(20) + + - redirect_url varchar(255) + + - api_domain varchar(255) + +Note: +- Custom database name and table name can be set in DBStore instance. + +#### MySQL Query + +```sql +CREATE TABLE oauthtoken ( + id varchar(10) NOT NULL, + user_name varchar(255), + client_id varchar(255), + client_secret varchar(255), + refresh_token varchar(255), + access_token varchar(255), + grant_token varchar(255), + expiry_time varchar(20), + redirect_url varchar(255), + api_domain varchar(255), + primary key (id) +) +``` + +#### Create DBStore object + +```python +from zohocrmsdk.src.com.zoho.api.authenticator.store import DBStore +""" +DBStore takes the following parameters +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" +6-> DataBase table name . Default value "oauthtoken" +""" +# store = DBStore() + +store = DBStore(host='host_name', database_name='database_name', user_name='user_name', password='password', port_number='port_number', table_name = "table_name") +``` + +### File Persistence + +In case of File Persistence, the user can persist tokens in the local drive, by providing the absolute file path to the FileStore object. + +- The File contains + - id + + - user_name + + - client_id + + - client_secret + + - refresh_token + + - access_token + + - grant_token + + - expiry_time + + - redirect_url + + - api_domain + +#### Create FileStore object + +```python +from zohocrmsdk.src.com.zoho.api.authenticator.store import FileStore +""" +FileStore takes the following parameter +1 -> Absolute file path of the file to persist tokens +""" +store = FileStore(file_path='/Users/username/Documents/python_sdk_token.txt') +``` + +### Custom Persistence +Users can create their own logic for storing and retrieving authentication tokens using the custom persistence technique. To use Custom Persistence, you must implement **[TokenStore](zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py)** and override the methods. + +```python +from zohocrmsdk.src.com.zoho.api.authenticator.store import TokenStore + +class CustomStore(TokenStore): + + def __init__(self): + pass + + def find_token(self, token): + """ + Parameters: + token (Token) : A Token (zohocrmsdk.src.com.zoho.api.authenticator.OAuthToken) class instance + """ + + # Add code to get the token + return None + + def save_token(self, token): + """ + Parameters: + token (Token) : A Token (zohocrmsdk.src.com.zoho.api.authenticator.OAuthToken) class instance + """ + + # Add code to save the token + + def delete_token(self, id): + """ + Parameters: + id (String) : id representing the unique token id + """ + + # Add code to delete the token + + def get_tokens(self): + """ + Returns: + list: List of stored tokens + """ + + # Add code to get all the stored tokens + + def delete_tokens(self): + + # Add code to delete all the stored tokens + + def find_token_by_id(self, id): + """ + The method to get id token details. + + Parameters: + id (String) : A String id. + + Returns: + Token : A Token class instance representing the id token details. + """ +``` + +## Configuration + +Before you get started with creating your Python application, you need to register your client and authenticate the app with Zoho. + +| Mandatory Keys | Optional Keys | +|:---------------| :------------ | +| token | logger | +| environment | store | +| | sdk_config | +| | proxy | +| | resource_path | +---- + +The **environment** key contains the domain information to make API calls. The **token** key represents the OAuth info, including the clientID, clientSecret, grantToken, redirectURL, refreshToken or accessToken depending on the flow that you use. Refer to ##create an instance of OAuthToken## for more details. + +- Configure the API environment which decides the domain and the URL to make API calls. + ```python + from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + """ + 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 **OAuthToken** with the information that you get after registering your Zoho client. In the context of token persistence, the grant token flow and refresh token flow involve storing and persisting the token. However, the access token flow does not involve token persistence and the access token is directly utilized for API calls. Depending on the tokens available with you, choose grantToken flow, refreshToken flow or accessToken flow. + + - By default, the findUser key is set to true, to set userSignature. However, this requires the ***ZohoCRM.users.READ*** and ***ZohoCRM.org.READ*** scopes to be mandatory. If you do not want to set user_signature, you must set the find_user key to false. + + - Use the following method for **grantToken flow :** + + ```python + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + token = OAuthToken(client_id= "clientId", client_secret="clientSecret", grant_token="grantToken", redirect_url="redirectURL") + ``` + - Use the following method for **refreshToken flow :** + ```python + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + token = OAuthToken(client_id= "clientId", client_secret="clientSecret", refresh_token="refreshToken", redirect_url="redirectURL") + ``` + - Use the following method for **accessToken flow :** + ```python + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + token = OAuthToken(access_token="accessToken") + ``` + - Use the following method for **Id flow :** + ```python + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + token = OAuthToken(id="tokenId") + ``` + +- Create an instance of **Logger** Class to log exception and API information. + ```python + from zohocrmsdk.src.com.zoho.api.logger import Logger + + """ + 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/python_sdk_log.log") + ``` + +- Create an instance of **TokenStore** to persist tokens, used for authenticating all the requests. By default, the SDK creates the sdk_tokens.txt created in the current working directory) to persist the tokens. + + - Use the following method for DB Store + ```python + from zohocrmsdk.src.com.zoho.api.authenticator.store import DBStore + """ + DBStore takes the following parameters + 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" + 6 -> DataBase table name. Default value "oauthtoken" + """ + # store = DBStore() + + store = DBStore(host='host_name', database_name='database_name', user_name='user_name', password='password', port_number='port_number', table_name = "table_name") + ``` + - Use the following method for File Store + ```python + from zohocrmsdk.src.com.zoho.api.authenticator.store import FileStore + """ + FileStore takes the following parameter + 1 -> Absolute file path of the file to persist tokens + """ + store = FileStore(file_path='/Users/python_sdk_tokens.txt') + ``` + - Use the following method for Custom Store + ```python + token_store = CustomStore() + ``` +- Create an instance of SDKConfig containing SDK configurations. + ```python + from zohocrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig + + """ + By default, the SDK creates the SDKConfig instance + auto_refresh_fields (Default value is False) + 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(zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py) + + pick_list_validation (Default value is True) + 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 + + connect_timeout (Default value is None) + A Float field to set connect timeout + + read_timeout (Default value is None) + A Float field to set read timeout + """ + config = SDKConfig(auto_refresh_fields=True, pick_list_validation=False, connect_timeout=None, read_timeout=None) + ``` + +- The path containing the absolute directory path to store user specific files containing module fields information. By default, the SDK stores the user-specific files within a folder in the current working directory. + ```python + resource_path = '/Users/python-app' + ``` + +- Create an instance of RequestProxy containing the proxy properties of the user. + ```python + from zohocrmsdk.src.com.zoho.crm.api.request_proxy import RequestProxy + """ + RequestProxy takes the following parameters + 1 -> Host + 2 -> Port Number + 3 -> User Name. Default value is None + 4 -> Password. Default value is an empty string + """ + # request_proxy = RequestProxy(host='proxyHost', port=80) + request_proxy = RequestProxy(host='proxyHost', port=80, user='userName', password='password') + ``` + +## Initializing the Application + +Initialize the SDK using the following code. + +```python +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.api.authenticator.store import DBStore, FileStore +from zohocrmsdk.src.com.zoho.api.logger import Logger +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig +from zohocrmsdk.src.com.zoho.crm.api.request_proxy import RequestProxy + + +class SDKInitializer(object): + + @staticmethod + def initialize(): + logger = Logger.get_instance(level=Logger.Levels.INFO, + file_path='/Users/user_name/Documents/python_sdk_log.log') + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id='clientId', client_secret='clientSecret', grant_token='grant_token', + refresh_token="refresh_token", redirect_url='redirectURL', id="token_id") + # store = FileStore(file_path='/Users/username/Documents/python_sdk_tokens.txt') + store = DBStore(host='host_name', database_name='database_name', user_name='user_name', password='password', + port_number='port_number', table_name="table_name") + config = SDKConfig(auto_refresh_fields=True, pick_list_validation=False, connect_timeout=None, + read_timeout=None) + resource_path = '/Users/python-app' + # request_proxy = RequestProxy(host='host', port=8080) + request_proxy = RequestProxy(host='host', port=8080, user='user', password='password') + """ + Call the static initialize method of Initializer class that takes the following arguments + 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(environment=environment, token=token, store=store, sdk_config=config, + resource_path=resource_path, logger=logger, proxy=request_proxy) + + +SDKInitializer.initialize() + + +``` +- Note: + - id: This is the unique id of the token which is auto-generated after successful SDK initialization. + - The value of id param in **OAuthToken** class should not match its parameter name. + +- You can now access the functionalities of the SDK. Refer to the sample codes to make various API calls through the SDK. + +## Class Hierarchy + +![classdiagram](class_hierarchy.png) + +## Responses and Exceptions + +All SDK methods return an instance of the APIResponse class. + +After a successful API request, the **get_object()** method returns an instance of the **ResponseWrapper** (for **GET**) or the **ActionWrapper** (for **POST, PUT, DELETE**) + +Whenever the API returns an error response, the **get_object()** returns an instance of **APIException** class. + +**ResponseWrapper** (for **GET** requests) and **ActionWrapper** (for **POST, PUT, DELETE** requests) are the expected objects for Zoho CRM APIs’ responses + +However, some specific operations have different expected objects, such as the following: + +- Operations involving records in Tags + - **RecordActionWrapper** + +- Getting Record Count for a specific Tag operation + - **CountWrapper** + +- Operations involving BaseCurrency + - **BaseCurrencyActionWrapper** + +- Lead convert operation + - **ConvertActionWrapper** + +- Retrieving Deleted records operation + - **DeletedRecordsWrapper** + +- Record image download operation + - **FileBodyWrapper** + +- MassUpdate record operations + - **MassUpdateActionWrapper** + - **MassUpdateResponseWrapper** + +### GET Requests + +- The **get_object()** returns an instance of one of the following classes, based on the return type. + + - Most of the APIs follows the **Common** Structure as below. + + - The **ResponseHandler class** encompasses the following + - **ResponseWrapper class** (for **application/json** responses) + - **FileBodyWrapper class** (for File download responses) + - **APIException class** + + +- Some of the APIs follow the **Particular** Structure as below. + + - The **ResponseHandler class** encompasses the following + - The **ResponseHandler interface** encompasses the following + - **HistoryWrapper class** (for **application/json** responses in **backup** API, holds the list of instances of **History class** and instance of **Info class**) + - **UrlsWrapper class** (for **application/json** responses in **backup** API, holds the instance of **Urls class**) + - **SourcesCountWrapper class** (for **application/json** responses in **UserGroups** API, holds the List of instances of **SourceCount class**) + - **SourcesWrapper class** (for **application/json** responses in **Usergroups** APi, holds the List of instances of **Sources class** and instance of **Info class**) + + + - The **ResponseWrapper class** in **BulkWrite** API encompasses the following + - **BulkWriteResponse class** (for **application/json** responses) + - **APIException class** + + - The **CountHandler class** encompasses the following + - **CountWrapper class** (for **application/json** responses in **Record** API, holds the Long **count**) + - **APIException class** + + - The **DeletedRecordsHandler class** encompasses the following + - **DeletedRecordsWrapper class** (for **application/json** responses in **Record** API, holds the list of instances of **DeletedRecord class** and instance of **Info class**) + - **APIException class** + + - The **DownloadHandler class** encompasses the following + - **FileBodyWrapper class** (for File download responses) + - **APIException class** + + - The **MassUpdateResponseHandler class** encompasses the following + - **MassUpdateResponseWrapper class** (for **application/json** responses in **Record** API, holds the list of instances of **MassUpdateResponse class**) + - **APIException class** + + - The **MassUpdateResponse class** encompasses of following + - **MassUpdate class** (for **application/json** responses) + - **APIException class** + + - The **ValidationHandler class** in **UserTerritories** API encomposses the following + - **ValidationWrapper class** (for **application/json** responses, holds the list of instances of **ValidationGroup class**) + - **APIException class** + + - The **ValidationGroup class** in **UserTerritories** API encompasses the following + - **Validation class** + - **BulkValidation class** + +### POST, PUT, DELETE Requests + +- The **getObject()** of the returned APIResponse instance returns the response as follows. + +- Most of the APIs follows the **Common** Structure as. + + - The **ActionHandler class** encompasses the following + - **ActionWrapper class** (for **application/json** responses) + - **APIException class** + + - The **ActionWrapper class** contains **Property/Properties** that may contain one/list of **ActionResponse class**. + + - The **ActionResponse class** encompasses the following + - **SuccessResponse class** (for **application/json** responses) + - **APIException class** + +- Some of the APIs follow the **Particular** Structure as. + + - The **ActionHandler class** encompasses the following + - **ActionWrapper class** (for **application/json** responses) + - **APIException class** + + - The **ActionWrapper class** contains **Property/Properties** that may contain one/list of **ActionResponse class**. + + - The **ActionResponse class** encompasses the following + - **BusinessHoursCreated class** (for **application/json** responses in **BusinessHours** API) + - **MassDeleteScheduled class** (for **application/json** responses in **MassDeleteCVID** API) + - **APIEXception class** + + - The **RecordActionHandler class** encompasses the following + - **RecordActionWrapper class** (for **application/json** responses in **Tags** API, holds the list of instance of **RecordActionResponse class**, Boolean **wfScheduler**, String **successCount** and Boolean **lockedCount**) + - **APIException class** + + - **RecordActionResponse class** encompasses the following + - **RecordSuccessResponse class** (for **application/json** responses) + - **APIException class** + + - The **ActionHandler class** in **Currencies** API encompasses the following + - **BaseCurrencyActionWrapper class** (for **application/json** responses) + - **APIException class** + + - The **BaseCurrencyActionWrapper class** contains **Property/Properties** that contain **BaseCurrencyActionResponse class**. + + - The **BaseCurrencyActionResponse class** encompasses the following + - **SuccessResponse class** (for **application/json** responses) + - **APIException class** + + - The **MassUpdateActionHandler class** encompasses the following + - **MassUpdateActionWrapper class** (for **application/json** responses in **Record** API, holds the list of instances of **MassUpdateActionResponse class**) + - **APIException class** + + - The **MassUpdateActionResponse class** encompasses of following + - **MassUpdateSuccessResponse class** (for **application/json** responses) + - **APIException class** + + - The **FileHandler class** in **Record** API encompasses the following + - **SuccessResponse class** (for **application/json** responses) + - **APIException class** + + - The **SignActionHandler class** in **MailMerge** API encompasses the following + - **SignActionWrapper class** (for **application/json** responses) + - **APIException class** + + - The **DeleteActionHandler class** encompasses the following + - **DeleteActionWrapper class** (for **application/json** responses in **ShareRecords** API, holds the instance of **DeleteActionResponse class**) + - **APIException class** + - The **DeleteActionResponse class** encompasses the following + - **SuccessResponse class** (for **application/json** responses) + - **APIException class** + + - The **TransferActionHandler class** in **UserTerritories** API encompasses the following + - **TransferActionWrapper class** (fro **application/json** responses , holds the list of instances of **TransferActionResponse class**) + + - The **TransferActionResponse class** encompasses the following + - **SuccessResponse class** (for **application/json** responses) + - **APIException class** + + - The **ActionResponse class** in **Territories** API encompasses the following + - **Success class** (for **application/json** responses) + - **APIException class** + + - The **TransferPipelineActionHandler class** in **Pipeline** API encompasses the following + - **TransferPipelineActionWrapper class** (for **application/json** responses, holds the list of insatnces of **TransferPipelineActionResponse class**) + - **APIException class** + + - The **TransferPipelineActionResponse class** in **Pipeline** API encompasses the following + - **TransferPipelineSuccessResponse class** (for **application/json** responses) + - **APIException class** + +For example, when you insert two records, and one of them was inserted successfully while the other one failed, the ActionWrapper will contain one instance each of the SuccessResponse and APIException classes. + +All other exceptions such as SDK anomalies and other unexpected behaviours are thrown under the SDKException class. + +## Multithreading in a Multi-user App + +Multi-threading for multi-users is achieved using Initializer's static **switch_user()** method. +switch_user() takes the value initialized previously for enviroment, token and sdk_config incase None is passed (or default value is passed). In case of request_proxy, if intended, the value has to be passed again else None(default value) will be taken. + +```python +# without proxy +Initializer.switch_user(environment=environment, token=token, sdk_config=sdk_config_instance) + +# with proxy +Initializer.switch_user(environment=environment, token=token, sdk_config=sdk_config_instance, proxy=request_proxy) +``` + +Here is a sample code to depict multi-threading for a multi-user app. + +```python +import threading +from zohocrmsdk.src.com.zoho.crm.api.parameter_map import ParameterMap +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter, EUDataCenter +from zohocrmsdk.src.com.zoho.api.authenticator.store import DBStore +from zohocrmsdk.src.com.zoho.api.logger import Logger +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.record import * +from zohocrmsdk.src.com.zoho.crm.api.request_proxy import RequestProxy +from zohocrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig + + +class MultiThread(threading.Thread): + + def __init__(self, environment, token, module_api_name, sdk_config, proxy=None): + super().__init__() + self.environment = environment + self.token = token + self.module_api_name = module_api_name + self.sdk_config = sdk_config + self.proxy = proxy + + def run(self): + try: + Initializer.switch_user(environment=self.environment, token=self.token, sdk_config=self.sdk_config, + proxy=self.proxy) + param_instance = ParameterMap() + param_instance.add(GetRecordsParam.fields, "id") + response = RecordOperations(self.module_api_name).get_records(param_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + for key, value in record.get_key_values().items(): + print(key + " : " + str(value)) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + except Exception as e: + print(e) + + @staticmethod + def call(): + logger = Logger.get_instance(level=Logger.Levels.INFO, + file_path="/Users/user_name/Documents/python_sdk_log.log") + token1 = OAuthToken(client_id="clientId1", client_secret="clientSecret1", grant_token="Grant Token", + refresh_token="refresh_token", id="id") + environment1 = USDataCenter.PRODUCTION() + store = DBStore() + sdk_config_1 = SDKConfig(auto_refresh_fields=True, pick_list_validation=False) + resource_path = '/Users/user_name/Documents/python-app' + user1_module_api_name = 'Leads' + user2_module_api_name = 'Contacts' + environment2 = EUDataCenter.SANDBOX() + sdk_config_2 = SDKConfig(auto_refresh_fields=False, pick_list_validation=True) + token2 = OAuthToken(client_id="clientId2", client_secret="clientSecret2", grant_token="GRANT Token", + refresh_token="refresh_token", redirect_url="redirectURL", id="id") + request_proxy_user_2 = RequestProxy("host", 8080) + Initializer.initialize(environment=environment1, token=token1, store=store, sdk_config=sdk_config_1, + resource_path=resource_path, logger=logger) + t1 = MultiThread(environment1, token1, user1_module_api_name, sdk_config_1) + t2 = MultiThread(environment2, token2, user2_module_api_name, sdk_config_2, request_proxy_user_2) + t1.start() + t2.start() + t1.join() + t2.join() + + +MultiThread.call() + +``` + +- The program execution starts from **call()**. + +- The details of **user1** are given in the variables token1, environment1. + +- Similarly, the details of another user **user2** are given in the variables token2, environment2. + +- For each user, an instance of **MultiThread class** is created. + +- When the **start()** is called which in-turn invokes the **run()**, the details of user1 are passed to the **switch_user** method through the **MultiThread object**. Therefore, this creates a thread for user1. + +- Similarly, When the **start()** is invoked again, the details of user2 are passed to the **switch_user** function through the **MultiThread object**. Therefore, this creates a thread for user2. + +### Multi-threading in a Single User App + +Here is a sample code to depict multi-threading for a single-user app. + +```python +import threading +from zohocrmsdk.src.com.zoho.crm.api.parameter_map import ParameterMap +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.api.authenticator.store import DBStore +from zohocrmsdk.src.com.zoho.api.logger import Logger +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig +from zohocrmsdk.src.com.zoho.crm.api.record import * + + +class MultiThread(threading.Thread): + + def __init__(self, module_api_name): + super().__init__() + self.module_api_name = module_api_name + + def run(self): + try: + print("Calling Get Records for module: " + self.module_api_name) + param_instance = ParameterMap() + param_instance.add(GetRecordsParam.fields, "id") + response = RecordOperations(self.module_api_name).get_records(param_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + for key, value in record.get_key_values().items(): + print(key + " : " + str(value)) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + except Exception as e: + print(e) + + @staticmethod + def call(): + logger = Logger.get_instance(level=Logger.Levels.INFO, + file_path="/Users/user_name/Documents/python_sdk_log.log") + token = OAuthToken(client_id="clientId", client_secret="clientSecret", grant_token="grant_token", + refresh_token="refresh_token", redirect_url="redirectURL", id="id") + environment = USDataCenter.PRODUCTION() + store = DBStore() + sdk_config = SDKConfig() + resource_path = '/Users/user_name/Documents/python-app' + Initializer.initialize(environment=environment, token=token, store=store, sdk_config=sdk_config, + resource_path=resource_path, logger=logger) + t1 = MultiThread('Leads') + t2 = MultiThread('Quotes') + t1.start() + t2.start() + t1.join() + t2.join() + + +MultiThread.call() + + +``` + +- The program execution starts from **call()** where the SDK is initialized with the details of the user. + +- When the **start()** is called which in-turn invokes the run(), the module_api_name is switched through the MultiThread object. Therefore, this creates a thread for the particular MultiThread instance. + +## SDK Sample code + +```python +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.record import RecordOperations, BodyWrapper, Record, Field, ActionWrapper, SuccessResponse, APIException + + +class CreateRecords: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def create_records(module_api_name): + """ + This method is used to create records of a module and print the response. + :param module_api_name: The API Name of the module to create records. + """ + """ + example + module_api_name = 'Leads' + """ + record_operations = RecordOperations(module_api_name) + request = BodyWrapper() + # List to hold Record instances + records_list = [] + record = Record() + """ + Call add_field_value method that takes two arguments + Import the zcrmsdk.src.com.zoho.crm.api.record.field file + 1 -> Call Field "." and choose the module from the displayed list and press "." and choose the field name from the displayed list. + 2 -> Value + """ + record.add_field_value(Field.Leads.last_name(), 'Python SDK') + record.add_field_value(Field.Leads.first_name(), 'New') + record.add_field_value(Field.Leads.company(), 'Zoho') + record.add_field_value(Field.Leads.city(), 'City') + record.add_field_value(Field.Leads.annual_revenue(), 1231.1) + + records_list.append(record) + request.set_data(records_list) + header_instance = HeaderMap() + response = record_operations.create_records(request, header_instance) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_data() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + + action_response.get_message().get_value()) + elif isinstance(action_response, APIException): + print("Status: " + + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + + action_response.get_message().get_value()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module_api_name = "Leads" +CreateRecords.initialize() +CreateRecords.create_records(module_api_name) +``` diff --git a/versions/1.0.0/class_hierarchy.png b/versions/1.0.0/class_hierarchy.png new file mode 100755 index 0000000..6d3072b Binary files /dev/null and b/versions/1.0.0/class_hierarchy.png differ diff --git a/versions/1.0.0/samples/__init__.py b/versions/1.0.0/samples/__init__.py new file mode 100644 index 0000000..fdf2d85 --- /dev/null +++ b/versions/1.0.0/samples/__init__.py @@ -0,0 +1,6 @@ +from . import bulk_write +from . import org +from . import business_hours +from . import coql +from . import record +from . import modules diff --git a/versions/1.0.0/samples/bulk_write/CreateBulkWriteJob.py b/versions/1.0.0/samples/bulk_write/CreateBulkWriteJob.py new file mode 100644 index 0000000..8a280e7 --- /dev/null +++ b/versions/1.0.0/samples/bulk_write/CreateBulkWriteJob.py @@ -0,0 +1,121 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, RequestWrapper, CallBack, Resource, \ + FieldMapping, SuccessResponse, APIException, DefaultValue +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class CreateBulkWriteJob(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def create_bulk_write_job(module_api_name, file_id): + """ + This method is used to create bulk write job with the uploaded file ID + :param module_api_name: The API Name of the module. + :param file_id: The ID of the uploaded file to create BulkWrite Job. + example + module_api_name = 'Leads' + file_id = 3409643002212140 + """ + bulk_write_operations = BulkWriteOperations() + request = RequestWrapper() + call_back = CallBack() + call_back.set_url("https://www.example.com/callback") + call_back.set_method(Choice('post')) + # The Bulk Read Job's details is posted to this URL on successful completion / failure of the job. + request.set_callback(call_back) + request.set_character_encoding('UTF-8') + # To set the type of operation you want to perform on the bulk write job. + request.set_operation(Choice('update')) + request.set_ignore_empty(True) + resources = [] + resource = Resource() + # To set the type of module that you want to import. The value is data. + resource.set_type(Choice('data')) + # To set API name of the module that you select for bulk write job. + # Specifies the API Name of the module to be read. + module = MinifiedModule() + module.set_api_name(module_api_name) + resource.set_module(module) + # To set the fileId obtained from file upload API. + resource.set_file_id(file_id) + # To set a field as a unique field or ID of a record. + resource.set_find_by('id') + field_mappings = [] + field_mapping = FieldMapping() + # To set API name of the field present in Zoho module object that you want to import. + field_mapping.set_api_name('Email') + # To set the column index of the field you want to map to the CRM field. + field_mapping.set_index(1) + field_mappings.append(field_mapping) + field_mapping = FieldMapping() + # To set API name of the field present in Zoho module object that you want to import. + field_mapping.set_api_name('Company') + # To set the column index of the field you want to map to the CRM field. + field_mapping.set_index(2) + field_mappings.append(field_mapping) + field_mapping = FieldMapping() + # To set API name of the field present in Zoho module object that you want to import. + field_mapping.set_api_name('Last_Name') + # To set the column index of the field you want to map to the CRM field. + field_mapping.set_index(0) + field_mappings.append(field_mapping) + # field_mapping = FieldMapping() + # # To set API name of the field present in Zoho module object that you want to import. + # field_mapping.set_api_name('Phone') + # # To set the column index of the field you want to map to the CRM field. + # field_mapping.set_index(3) + # field_mappings.append(field_mapping) + field_mapping = FieldMapping() + field_mapping.set_api_name('id') + field_mapping.set_index(4) + field_mappings.append(field_mapping) + field_mapping = FieldMapping() + field_mapping.set_api_name('Website') + default_value = DefaultValue() + default_value.set_value("www.zohoapis.com") + # To set the default value for an empty column in the uploaded file. + field_mapping.set_default_value(default_value) + field_mappings.append(field_mapping) + resource.set_field_mappings(field_mappings) + module = MinifiedModule() + module.set_api_name(module_api_name) + resource.set_module(module) + resources.append(resource) + request.set_resource(resources) + # Call create_bulk_write_job method that takes RequestWrapper instance as parameter + response = bulk_write_operations.create_bulk_write_job(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module = "Leads" +file_id = "3477471001" +CreateBulkWriteJob.initialize() +CreateBulkWriteJob.create_bulk_write_job(module, file_id) \ No newline at end of file diff --git a/versions/1.0.0/samples/bulk_write/DownloadBulkWriteResult.py b/versions/1.0.0/samples/bulk_write/DownloadBulkWriteResult.py new file mode 100644 index 0000000..4b7738b --- /dev/null +++ b/versions/1.0.0/samples/bulk_write/DownloadBulkWriteResult.py @@ -0,0 +1,61 @@ +import os + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, FileBodyWrapper, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + +class DownloadBulkWriteResult(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def download_bulk_write_result(download_url, destination_folder): + """ + This method is used to download the result of bulk write job. + :param download_url: The URL present in the download_url key in the response of Get Bulk Write Job Details. + :param destination_folder: The absolute path where downloaded file has to be stored. + """ + """ + example + download_url = "https://download-accl.zoho.com/6735/bulk-write/347706122009/347706122009.zip" + destination_folder = "/Users/user_name/Documents" + """ + bulk_write_operations = BulkWriteOperations() + # Call download_bulk_write_result method that takes download_url as parameter + response = bulk_write_operations.download_bulk_write_result(download_url) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, FileBodyWrapper): + stream_wrapper = response_object.get_file() + # Construct the file name by joining the destination_folder 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: + for chunk in stream_wrapper.get_stream(): + f.write(chunk) + f.close() + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +download_url = "https://download-accl.zoho.com/v2/crm/6045/bulk-write/3477441008/3477061008.zip" +destination_folder = "/Users/file" +DownloadBulkWriteResult.initialize() +DownloadBulkWriteResult.download_bulk_write_result(download_url, destination_folder) \ No newline at end of file diff --git a/versions/1.0.0/samples/bulk_write/GetBulkWriteJobDetails.py b/versions/1.0.0/samples/bulk_write/GetBulkWriteJobDetails.py new file mode 100644 index 0000000..a6af67a --- /dev/null +++ b/versions/1.0.0/samples/bulk_write/GetBulkWriteJobDetails.py @@ -0,0 +1,98 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, BulkWriteResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + +class GetBulkWriteJobDetails(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_bulk_write_job_details(job_id): + """ + This method is used to get the details of a bulk write job performed previously. + :param job_id: The unique ID of the bulk write job. + """ + """ + example + job_id = 3477061005615003 + """ + bulk_write_operations = BulkWriteOperations() + # Call get_bulk_write_job_details method that takes job_id as parameter + response = bulk_write_operations.get_bulk_write_job_details(job_id) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, BulkWriteResponse): + print("Bulk write Job Status: " + response_object.get_status()) + print("Bulk write CharacterEncoding: ") + print(response_object.get_character_encoding()) + resources = response_object.get_resource() + if resources is not None: + for resource in resources: + print("Bulk write Resource Status: " + resource.get_status().get_value()) + print("Bulk write Resource Type: " + resource.get_type().get_value()) + print("Bulk write Resource Module: ") + print(resource.get_module().get_id()) + print("Bulk write Resource Module: " + resource.get_module().get_api_name()) + field_mappings = resource.get_field_mappings() + if field_mappings is not None: + for field_mapping in field_mappings: + print("Bulk write Resource FieldMapping Module: " + field_mapping.get_api_name()) + if field_mapping.get_index() is not None: + print( + "Bulk write Resource FieldMapping Index: " + str(field_mapping.get_index())) + if field_mapping.get_format() is not None: + print("Bulk write Resource FieldMapping Format: " + field_mapping.get_format()) + if field_mapping.get_find_by() is not None: + print("Bulk write Resource FieldMapping FindBy: " + field_mapping.get_find_by()) + if field_mapping.get_module() is not None: + print("Bulk write Resource FieldMapping module: " + field_mapping.get_module()) + default_value = field_mapping.get_default_value() + if default_value is not None: + print('Default values' + default_value.get_value()) + + file = resource.get_file() + if file is not None: + print("Bulk write Resource File Status: " + file.get_status().get_value()) + print("Bulk write Resource File Name: " + file.get_name()) + print("Bulk write Resource File AddedCount: " + str(file.get_added_count())) + print("Bulk write Resource File SkippedCount: " + str(file.get_skipped_count())) + print("Bulk write Resource File UpdatedCount: " + str(file.get_updated_count())) + print("Bulk write Resource File TotalCount: " + str(file.get_total_count())) + callback = response_object.get_callback() + if callback is not None: + print("Bulk write CallBack Url: " + callback.get_url()) + print("Bulk write CallBack Method: " + callback.get_method().get_value()) + print("Bulk write ID: " + str(response_object.get_id())) + result = response_object.get_result() + if result is not None: + print("Bulk write DownloadUrl: " + result.get_download_url()) + created_by = response_object.get_created_by() + if created_by is not None: + print("Bulkwrite Created By - Name: " + created_by.get_name()) + print("Bulkwrite Created By - ID: " + str(created_by.get_id())) + print("Bulk write Operation: " + response_object.get_operation()) + print("Bulk write File CreatedTime: " + str(response_object.get_created_time())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +job_id = "347703001" +GetBulkWriteJobDetails.initialize() +GetBulkWriteJobDetails.get_bulk_write_job_details(job_id) diff --git a/versions/1.0.0/samples/bulk_write/UploadFile.py b/versions/1.0.0/samples/bulk_write/UploadFile.py new file mode 100644 index 0000000..3c5f2a5 --- /dev/null +++ b/versions/1.0.0/samples/bulk_write/UploadFile.py @@ -0,0 +1,89 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.bulk_write import BulkWriteOperations, FileBodyWrapper, UploadFileHeader, \ + SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper + + +class UploadFile(object): + + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def upload_file(org_id, absolute_file_path): + """ + This method is used to upload a CSV file in ZIP format for bulk write API. The response contains the file_id. + :param org_id: The unique ID (zgid) of your organization obtained through the Organization API. + :param absolute_file_path: The absoluteFilePath of the zip file you want to upload. + """ + """ + example + org_id = "6045" + absolute_file_path = "/Users/user_name/Documents/Leads.zip" + """ + bulk_write_operations = BulkWriteOperations() + file_body_wrapper = FileBodyWrapper() + """ + StreamWrapper can be initialized in any of the following ways + * param 1 -> fileName + * param 2 -> Read Stream. + """ + # stream_wrapper = StreamWrapper(stream=open(absolute_file_path, 'rb')) + """ + * param 1 -> fileName + * param 2 -> Read Stream + * param 3 -> Absolute File Path of the file to be attached + """ + stream_wrapper = StreamWrapper(file_path=absolute_file_path) + file_body_wrapper.set_file(stream_wrapper) + header_instance = HeaderMap() + # Possible parameters for upload_file operation + header_instance.add(UploadFileHeader.feature, "bulk-write") + header_instance.add(UploadFileHeader.x_crm_org, org_id) + # Call upload_file method that takes FileBodyWrapper instance and header_instance as parameter + response = bulk_write_operations.upload_file(file_body_wrapper, header_instance) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + elif isinstance(response_object, APIException): + if response_object.get_status() is not None: + print("Status: " + response_object.get_status().get_value()) + if response_object.get_code() is not None: + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + if details is not None: + for key, value in details.items(): + print(key + ' : ' + str(value)) + if response_object.get_error_message() is not None: + print("Error Message: " + response_object.get_error_message().get_value()) + print('Error Code: ' + str(response_object.get_error_code())) + if response_object.get_x_error() is not None: + print('XError: ' + response_object.get_x_error().get_value()) + if response_object.get_info() is not None: + print("Info: " + response_object.get_info().get_value()) + if response_object.get_x_info() is not None: + print("XInfo: " + response_object.get_x_info().get_value()) + if response_object.get_message() is not None: + print("Message: " + response_object.get_message().get_value()) + print('HttpStatus: ' + str(response_object.get_http_status())) + + +org_id = "6045" +absolute_path = "/Users/Leads.zip" +UploadFile.initialize() +UploadFile.upload_file(org_id, absolute_path) diff --git a/versions/1.0.0/samples/bulk_write/__init__.py b/versions/1.0.0/samples/bulk_write/__init__.py new file mode 100644 index 0000000..4c41942 --- /dev/null +++ b/versions/1.0.0/samples/bulk_write/__init__.py @@ -0,0 +1,4 @@ +from .UploadFile import UploadFile +from .CreateBulkWriteJob import CreateBulkWriteJob +from .DownloadBulkWriteResult import DownloadBulkWriteResult +from .GetBulkWriteJobDetails import GetBulkWriteJobDetails diff --git a/versions/1.0.0/samples/business_hours/CreateBusinessHours.py b/versions/1.0.0/samples/business_hours/CreateBusinessHours.py new file mode 100644 index 0000000..0f7853b --- /dev/null +++ b/versions/1.0.0/samples/business_hours/CreateBusinessHours.py @@ -0,0 +1,73 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.business_hours import BusinessHoursOperations, BodyWrapper, BusinessHours, \ + BreakHoursCustomTiming, APIException, ActionWrapper, SuccessResponse +from zohocrmsdk.src.com.zoho.crm.api.dc import INDataCenter +from zohocrmsdk.src.com.zoho.crm.api.util.choice import Choice + + +class CreateBusinessHours: + @staticmethod + def initialize(): + environment = INDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def create_business_hours(): + business_hours_operations = BusinessHoursOperations() + request = BodyWrapper() + business_hours = BusinessHours() + business_days = [Choice("Monday")] + business_hours.set_business_days(business_days) + business_hours.set_week_starts_on(Choice("Monday")) + bhct = BreakHoursCustomTiming() + bhct.set_days(Choice("Monday")) + business_timings = ["10:00", "11:00"] + bhct.set_business_timing(business_timings) + custom_timing = [bhct] + business_hours.set_custom_timing(custom_timing) + business_hours.set_same_as_everyday(False) + # when same_as_everyday is true + daily_timing = ["10:00", "11:00"] + business_hours.set_daily_timing(daily_timing) + # + business_hours.set_type(Choice("custom")) + request.set_business_hours(business_hours) + response = business_hours_operations.create_business_hours(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_business_hours() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +CreateBusinessHours.initialize() +CreateBusinessHours.create_business_hours() diff --git a/versions/1.0.0/samples/business_hours/GetBusinessHours.py b/versions/1.0.0/samples/business_hours/GetBusinessHours.py new file mode 100644 index 0000000..4477651 --- /dev/null +++ b/versions/1.0.0/samples/business_hours/GetBusinessHours.py @@ -0,0 +1,66 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.business_hours import BusinessHoursOperations, ResponseWrapper, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter + + +class GetBusinessHours(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_business_hours(): + business_hours_operations = BusinessHoursOperations() + response = business_hours_operations.get_business_hours() + if response is not None: + 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 + response_object = response.get_object() + if isinstance(response_object, ResponseWrapper): + responseWrapper = response_object + business_hours = responseWrapper.get_business_hours() + business_days = business_hours.get_business_days() + if business_days is not None: + print("businessdays : ") + for business_day in business_days: + print(business_day) + else: + print("businessdays : None") + custom_timing = business_hours.get_custom_timing() + if custom_timing is not None: + print("custom_timing :") + for bhct in custom_timing: + print("days: " + bhct.get_days().get_value()) + business_timings = bhct.get_business_timing() + for business_timing in business_timings: + print("business_timings : " + business_timing) + else: + print("custom_timing : None") + daily_timing = business_hours.get_daily_timing() + if daily_timing is not None: + print("daily_timings : ") + for daily_timing1 in daily_timing: + print(daily_timing1) + else: + print("daily_timings : None") + print("week_starts_on : " + business_hours.get_week_starts_on().get_value()) + print("same_as_everyday : " + str(business_hours.get_same_as_everyday())) + print("businesshours_id : " + str(business_hours.get_id())) + print("businesshours_type : " + business_hours.get_type().get_value()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +GetBusinessHours.initialize() +GetBusinessHours.get_business_hours() diff --git a/versions/1.0.0/samples/business_hours/UpdateBusinessHours.py b/versions/1.0.0/samples/business_hours/UpdateBusinessHours.py new file mode 100644 index 0000000..f7a4488 --- /dev/null +++ b/versions/1.0.0/samples/business_hours/UpdateBusinessHours.py @@ -0,0 +1,83 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.business_hours import BusinessHoursOperations, BodyWrapper, BusinessHours, \ + BreakHoursCustomTiming, ActionWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class UpdateBusinessHours(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_business_hours(): + business_hours_operations = BusinessHoursOperations() + request = BodyWrapper() + business_hours = BusinessHours() + business_days = [Choice("Monday")] + business_hours.set_business_days(business_days) + business_hours.set_week_starts_on(Choice("Monday")) + business_hours.set_same_as_everyday(False) # when same_as_everyday is true + business_hours.set_id(44028001017425) + bhct = BreakHoursCustomTiming() + bhct.set_days(Choice("Monday")) + business_timings = ["09:00", "17:00"] + bhct.set_business_timing(business_timings) + + bhct1 = BreakHoursCustomTiming() + bhct1.set_days(Choice("Tuesday")) + business_timing1 = ["10:30", "17:00"] + bhct1.set_business_timing(business_timing1) + + bhct2 = BreakHoursCustomTiming() + bhct2.set_days(Choice("Wednesday")) + business_timing2 = ["10:30", "17:00"] + bhct2.set_business_timing(business_timing2) + + custom_timing = [bhct, bhct1, bhct2] + business_hours.set_custom_timing(custom_timing) + daily_timing = ["10:00", "11:00"] + business_hours.set_daily_timing(daily_timing) + + business_hours.set_type(Choice("custom")) + request.set_business_hours(business_hours) + response = business_hours_operations.update_business_hours(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response = response_object.get_business_hours() + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message().get_value()) + + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +UpdateBusinessHours.initialize() +UpdateBusinessHours.update_business_hours() \ No newline at end of file diff --git a/versions/1.0.0/samples/business_hours/__init__.py b/versions/1.0.0/samples/business_hours/__init__.py new file mode 100644 index 0000000..320134a --- /dev/null +++ b/versions/1.0.0/samples/business_hours/__init__.py @@ -0,0 +1,3 @@ +from .GetBusinessHours import GetBusinessHours +from .CreateBusinessHours import CreateBusinessHours +from .UpdateBusinessHours import UpdateBusinessHours diff --git a/versions/1.0.0/samples/coql/GetRecords.py b/versions/1.0.0/samples/coql/GetRecords.py new file mode 100644 index 0000000..a0a43fb --- /dev/null +++ b/versions/1.0.0/samples/coql/GetRecords.py @@ -0,0 +1,83 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.coql import CoqlOperations, BodyWrapper, ResponseWrapper, APIException + + +class GetRecords(object): + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_records(): + + """ + This method is used to get records from the module through a COQL query. + """ + query_operations = CoqlOperations() + body_wrapper = BodyWrapper() + select_query = "select Last_Name, Account_Name.Parent_Account, Account_Name.Parent_Account.Account_Name,First_Name, Full_Name, Created_Time from Contacts where Last_Name is not null limit 200" + body_wrapper.set_select_query(select_query) + response = query_operations.get_records(body_wrapper) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + print("Record ID: " + str(record.get_id())) + created_by = record.get_created_by() + if created_by is not None: + print("Record Created By - Name: " + created_by.get_name()) + print("Record Created By - ID: " + created_by.get_id()) + print("Record Created By - Email: " + created_by.get_email()) + print("Record CreatedTime: " + str(record.get_created_time())) + if record.get_modified_time() is not None: + print("Record ModifiedTime: " + str(record.get_modified_time())) + modified_by = record.get_modified_by() + if modified_by is not None: + print("Record Modified By - Name: " + modified_by.get_name()) + print("Record Modified By - ID: " + modified_by.get_id()) + print("Record Modified By - Email: " + modified_by.get_email()) + print('Record KeyValues: ') + key_values = record.get_key_values() + for key_name, value in key_values.items(): + if isinstance(value, list): + print("Record KeyName : " + key_name) + for data in value: + if isinstance(data, dict): + for dict_key, dict_value in data.items(): + print(dict_key + " : " + str(dict_value)) + else: + print(str(data)) + elif isinstance(value, dict): + print("Record KeyName : " + key_name + " - Value : ") + for dict_key, dict_value in value.items(): + print(dict_key + " : " + str(dict_value)) + else: + print("Record KeyName : " + key_name + " - Value : " + str(value)) + info = response_object.get_info() + if info is not None: + if info.get_count() is not None: + print('Record Info Count: ' + str(info.get_count())) + if info.get_more_records() is not None: + print('Record Info MoreRecords: ' + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +GetRecords.initialize() +GetRecords.get_records() diff --git a/versions/1.0.0/samples/coql/__init__.py b/versions/1.0.0/samples/coql/__init__.py new file mode 100644 index 0000000..1391861 --- /dev/null +++ b/versions/1.0.0/samples/coql/__init__.py @@ -0,0 +1 @@ +from .GetRecords import GetRecords diff --git a/versions/1.0.0/samples/custom_store/README.md b/versions/1.0.0/samples/custom_store/README.md new file mode 100644 index 0000000..29668c2 --- /dev/null +++ b/versions/1.0.0/samples/custom_store/README.md @@ -0,0 +1,72 @@ +Custom Store Token Store Persistence +------------------------------------ +Our Python SDK comes with built-in support for File Persistence, which stores your tokens in a file at a location of your choosing, and DB Persistence, which stores your tokens in a MySQL database. However, if these options don't align with your specific requirements, or if you want to use a database other than MySQL or any other storage method, you can leverage Custom Persistence, where you can define your own storage logic through the TokenStore class. To do this, you need to implement the TokenStore interface and override its methods accordingly. + +We have added examples for three different types using custom persistence: + +### 1. [SQLite3 DB](custom_store_sqlite.py): + +In this case, the tokens are persisted in a file on disk. The data in this database persists even after the program exits, as long as the file is not deleted. + +The sqlite3.connect('zohooauth.db') command in Python is used to create a connection to an SQLite database stored in a file called zohooauth.db. + +Persistent Database: + - The database is stored on disk in the file zohooauth.db. + - The data in this database persists even after the program exits, as long as the file is not deleted. + - If the zohooauth.db file does not exist, it will be created. + - If the zohooauth.db file already exists, the command will open a connection to this existing database. + +Initialization Sample Code: +```python + try: + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="client_id", client_secret="client_secret", refresh_token="refresh_token") + store = CustomStoreSQLite() + Initializer.initialize(environment=environment, token=token, store=store) + except Exception as ex: + print(ex) +``` +Please check out the complete sample code [here](custom_store_sqlite.py). + +### 2. [In-Memory SQLite3 DB](custom_store_in_memory.py) + +In this case, the tokens are persisted in the RAM, and not on disk. Once the connection to the DB is closed, the DB and all its data will be deleted. + +The sqlite3.connect(':memory:') command in Python is used to create an in-memory SQLite database. This type of database resides entirely in RAM and does not persist to disk. Here are the key points about using an in-memory SQLite database: + +Temporary Database: + - The database exists only while the connection is open. + - Once the connection is closed, the database and all its data are lost. + +Initialization Sample Code: +```python + try: + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="client_id", client_secret="client_secret", refresh_token="refresh_token") + store = CustomStore() + Initializer.initialize(environment=environment, token=token, store=store) + except Exception as ex: + print(ex) +``` +Please check out the complete sample code [here](custom_store_in_memory.py). + +### 3. [Custom Store List](custom_store_list.py) + +In this case, the token details are stored in a list object. The data exists only while the app is running. + +The token details stored in list. + +Temporary Storage: + - The data exists only while the app is running. + +Initialization Sample Code: +```python + try: + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="client_id", client_secret="client_secret", refresh_token="refresh_token") + store = CustomStoreList() + Initializer.initialize(environment=environment, token=token, store=store) + except Exception as ex: + print(ex) +``` +Please check out the complete sample code [here](custom_store_list.py). \ No newline at end of file diff --git a/versions/1.0.0/samples/custom_store/custom_store_in_memory.py b/versions/1.0.0/samples/custom_store/custom_store_in_memory.py new file mode 100644 index 0000000..66ae817 --- /dev/null +++ b/versions/1.0.0/samples/custom_store/custom_store_in_memory.py @@ -0,0 +1,282 @@ +from sqlite3 import Error + +from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +import sqlite3 + +class CustomStore(TokenStore): + + """ + This class to store user token details to the MySQL DataBase. + """ + + def __init__(self): + + """ + Creates a DBStore class instance with the specified parameters. + """ + self.db_name = ':memory:' + self.connection = sqlite3.connect(self.db_name) + if not self.check_table_exists(): + cursor = self.connection.cursor() + cursor.execute("CREATE TABLE oauthtoken (id varchar(10) NOT NULL,user_name varchar(255), client_id varchar(255), client_secret varchar(255), refresh_token varchar(255), access_token varchar(255), grant_token varchar(255), expiry_time varchar(20), redirect_url varchar(255), api_domain varchar(255), primary key (id))") + cursor.close() + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + def find_token(self, token): + cursor = None + try: + if isinstance(token, OAuthToken): + oauth_token = token + query = "select * from oauthtoken" + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query= query + " where access_token='" + oauth_token.get_access_token() + "'" + elif oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + cursor = self.connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + if result is None: + return None + self.set_merge_data(oauth_token, result) + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1, cause=ex) + finally: + cursor.close() if cursor is not None else None + return token + + @staticmethod + def get_data(next_record): + return next_record if next_record is not None else None + + @staticmethod + def set_merge_data(oauth_token, next_record): + if oauth_token.get_id() is None: + oauth_token.set_id(CustomStore.get_data(next_record[0])) + if oauth_token.get_user_signature() is None: + name = CustomStore.get_data(next_record[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(CustomStore.get_data(next_record[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(CustomStore.get_data(next_record[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(CustomStore.get_data(next_record[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(CustomStore.get_data(next_record[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(CustomStore.get_data(next_record[6])) + if oauth_token.get_expires_in() is None: + expiresIn = CustomStore.get_data(next_record[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(CustomStore.get_data(next_record[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(CustomStore.get_data(next_record[9])) + + def save_token(self, token): + if not isinstance(token, OAuthToken): + return + cursor = None + try: + oauth_token = token + query = "update oauthtoken set " + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + self.set_token(oauth_token) + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and len(oauth_token.get_access_token()) > 0 and \ + self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query = query + self.set_token(oauth_token) + " where access_token='" + oauth_token.get_access_token() + "'" + elif ((oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0) or + (oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0)) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + self.set_token(oauth_token) + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + self.set_token(oauth_token) + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + try: + cursor = self.connection.cursor() + cursor.execute(query) + if cursor.rowcount <= 0: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1) + if oauth_token.get_id() is None: + newId = str(self.generate_id()) + oauth_token.set_id(newId) + query = "insert into oauthtoken (id,user_name,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url,api_domain) values (?,?,?,?,?,?,?,?,?,?);" + val = (token.get_id(), token.get_user_signature().get_name() if token.get_user_signature() is not None else None, token.get_client_id(), token.get_client_secret(), token.get_refresh_token(), token.get_access_token(), token.get_grant_token(), token.get_expires_in(), token.get_redirect_url(), token.get_api_domain()) + cursor.execute(query, val) + except Error as e: + raise e + finally: + self.connection.commit() + cursor.close() if cursor is not None else None + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.SAVE_TOKEN_DB_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def set_token(self, oauth_token): + query = [] + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query.append(self.set_token_info(Constants.USER_NAME, name)) + if oauth_token.get_api_domain() is not None: + query.append(self.set_token_info(Constants.API_DOMAIN, oauth_token.get_api_domain())) + if oauth_token.get_client_id() is not None: + query.append(self.set_token_info(Constants.CLIENT_ID, oauth_token.get_client_id())) + if oauth_token.get_client_secret() is not None: + query.append(self.set_token_info(Constants.CLIENT_SECRET, oauth_token.get_client_secret())) + if oauth_token.get_refresh_token() is not None: + query.append(self.set_token_info(Constants.REFRESH_TOKEN, oauth_token.get_refresh_token())) + if oauth_token.get_access_token() is not None: + query.append(self.set_token_info(Constants.ACCESS_TOKEN, oauth_token.get_access_token())) + if oauth_token.get_grant_token() is not None: + query.append(self.set_token_info(Constants.GRANT_TOKEN, oauth_token.get_grant_token())) + if oauth_token.get_expires_in() is not None: + query.append(self.set_token_info(Constants.EXPIRY_TIME, oauth_token.get_expires_in())) + if oauth_token.get_redirect_url() is not None: + query.append(self.set_token_info(Constants.REDIRECT_URL, oauth_token.get_redirect_url())) + return str.join(",", query) + + @staticmethod + def set_token_info(key, value): + return key + "='" + value + "'" + + def delete_token(self, id): + cursor = None + try: + try: + cursor = self.connection.cursor() + query = "delete from oauthtoken where id= " + id + ";" + cursor.execute(query) + self.connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKEN_DB_ERROR, cause=ex) + + def get_tokens(self): + cursor = None + try: + tokens = [] + try: + cursor = self.connection.cursor() + query = "select * from oauthtoken;" + cursor.execute(query) + results = cursor.fetchall() + for result in results: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, result) + tokens.append(oauth_token) + return tokens + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_DB_ERROR, cause=ex) + + def delete_tokens(self): + cursor = None + try: + try: + cursor = self.connection.cursor() + query = "delete from oauthtoken;" + cursor.execute(query) + self.connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_DB_ERROR, cause=ex) + + def find_token_by_id(self, id): + cursor = None + try: + try: + query = "select * from oauthtoken where id='" + id + "'" + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + cursor = self.connection.cursor() + cursor.execute(query) + results = cursor.fetchall() + if results is None or len(results) <= 0: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_DB_ERROR) + for result in results: + self.set_merge_data(oauth_token, result) + return oauth_token + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_BY_ID_DB_ERROR, cause=ex) + + def generate_id(self): + cursor = None + try: + query = "select max(id) as id from oauthtoken;" + cursor = self.connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + max1 = result[0] + if max1 is None: + return 1 + else: + return int(max1) + 1 + except Exception as e1: + raise SDKException(Constants.TOKEN_STORE, Constants.GENERATE_TOKEN_ID_ERROR, cause=e1) + finally: + cursor.close() if cursor is not None else None + + def check_table_exists(self): + cursor = None + try: + cursor = self.connection.cursor() + # Query to check if table exists + cursor.execute("SELECT * FROM oauthtoken limit 1") + table = cursor.fetchone() + return table is not None + except Exception as e1: + return False + finally: + cursor.close() if cursor is not None else None \ No newline at end of file diff --git a/versions/1.0.0/samples/custom_store/custom_store_list.py b/versions/1.0.0/samples/custom_store/custom_store_list.py new file mode 100644 index 0000000..c867082 --- /dev/null +++ b/versions/1.0.0/samples/custom_store/custom_store_list.py @@ -0,0 +1,223 @@ +from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + + +class CustomStoreList(TokenStore): + + def __init__(self): + self.store = [] + + def find_token(self, token): + if not isinstance(token, OAuthToken): + return token + try: + oauth_token = token + is_row_present = False + data = self.store + for next_record in data: + if len(next_record) == 0: + continue + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + return oauth_token + if not is_row_present: + return None + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_FILE_ERROR, cause=ex) + + def set_merge_data(self, oauth_token, next_record): + if oauth_token.get_id() is None: + oauth_token.set_id(self.get_data(next_record[0])) + if oauth_token.get_user_signature() is None: + name = self.get_data(next_record[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(self.get_data(next_record[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(self.get_data(next_record[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(self.get_data(next_record[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(self.get_data(next_record[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(self.get_data(next_record[6])) + if oauth_token.get_expires_in() is None: + expires_in = self.get_data(next_record[7]) + if expires_in is not None: + oauth_token.set_expires_in(str(expires_in)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(self.get_data(next_record[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(self.get_data(next_record[9])) + + def check_condition(self, oauth_token, next_record): + is_row_present = False + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + user_name = self.get_data(next_record[1]) + if name is not None and len(name) > 0 and user_name is not None and len(user_name) > 0 and name == user_name: + is_row_present = True + elif oauth_token.get_access_token() is not None and self.are_all_objects_null( + [oauth_token.get_client_id(), oauth_token.get_client_secret()]): + access_token = self.get_data(next_record[5]) + if access_token is not None and len(access_token) > 0 and len( + oauth_token.get_access_token()) > 0 and oauth_token.get_access_token() == access_token: + is_row_present = True + elif ( + oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + grant_token = self.get_data(next_record[6]) + refresh_token = self.get_data(next_record[4]) + if grant_token is not None and len(grant_token) > 0 and oauth_token.get_grant_token() is not None and len( + oauth_token.get_grant_token()) > 0 and oauth_token.get_grant_token() == grant_token: + is_row_present = True + elif refresh_token is not None and len( + refresh_token) > 0 and oauth_token.get_refresh_token() is not None and len( + oauth_token.get_refresh_token()) > 0 and oauth_token.get_refresh_token() == refresh_token: + is_row_present = True + return is_row_present + + def save_token(self, token): + if isinstance(token, OAuthToken): + try: + is_row_present = False + oauth_token = token + all_contents = self.store + for next_record in all_contents: + if len(next_record) > 0: + if oauth_token.get_id() is not None: + id = self.get_data(next_record[0]) + if id is not None and oauth_token.get_id() is not None and id == oauth_token.get_id(): + is_row_present= True + else: + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + i = all_contents.index(next_record) + all_contents[i] = self.set_token(oauth_token) + break + else: + all_contents.remove(next_record) + if not is_row_present: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if ( + oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None): + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_FILE_ERROR1) + if oauth_token.get_id() is None: + new_id = self.generate_id(all_contents) + oauth_token.set_id(new_id) + all_contents.append(self.set_token(oauth_token)) + self.store = all_contents + except Exception as error: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.SAVE_TOKEN_FILE_ERROR, cause=error) + + @staticmethod + def set_token(oauth_token): + data = [] + data.insert(0, oauth_token.get_id()) + data.insert(1, oauth_token.get_user_signature().get_name() if oauth_token.get_user_signature() is not None else "") + data.insert(2, oauth_token.get_client_id()) + data.insert(3, oauth_token.get_client_secret()) + data.insert(4, oauth_token.get_refresh_token()) + data.insert(5, oauth_token.get_access_token()) + data.insert(6, oauth_token.get_grant_token()) + data.insert(7, oauth_token.get_expires_in()) + data.insert(8, oauth_token.get_redirect_url()) + data.insert(9, oauth_token.get_api_domain()) + return data + + def delete_token(self, id): + try: + is_row_present = False + all_contents = self.store + for i in range(len(all_contents)): + next_record = all_contents[i] + if len(next_record) > 1: + record_id = self.get_data(next_record[0]) + if record_id is not None and record_id == id: + is_row_present = True + all_contents.pop(i) + break + self.store = all_contents + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e2: + raise SDKException(Constants.TOKEN_STORE, Constants.DELETE_TOKENS_FILE_ERROR, cause=e2) + + def get_tokens(self): + tokens = [] + try: + for next_record in self.store: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, next_record) + tokens.append(oauth_token) + return tokens + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_FILE_ERROR, cause=ex) + + def delete_tokens(self): + try: + self.store = [] + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_FILE_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def find_token_by_id(self, id): + try: + is_row_present = False + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + all_contents = self.store + for content in all_contents: + if content[0] == id: + is_row_present = True + self.set_merge_data(oauth_token, content) + return oauth_token + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR, cause=e) + return None + + @staticmethod + def get_data(value): + return value if (value is not None and len(value) > 0) else None + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + @staticmethod + def generate_id(all_contents): + maxValue = 0 + if len(all_contents) > 0: + for i in range(len(all_contents) - 1): + next_record = all_contents[i + 1] + if next_record is not None and len(next_record) > 1 and len(next_record[0]) > 0: + if maxValue < int(next_record[0]): + maxValue = int(next_record[0]) + return str(maxValue + 1) diff --git a/versions/1.0.0/samples/custom_store/custom_store_sqlite.py b/versions/1.0.0/samples/custom_store/custom_store_sqlite.py new file mode 100644 index 0000000..401b2e7 --- /dev/null +++ b/versions/1.0.0/samples/custom_store/custom_store_sqlite.py @@ -0,0 +1,306 @@ +from sqlite3 import Error + +from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore +from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +import sqlite3 + +# use aws lambda +# import os +# os.chdir("/tmp") + +class CustomStoreSQLite(TokenStore): + + """ + This class to store user token details to the MySQL DataBase. + """ + + def __init__(self): + + """ + Creates a DBStore class instance with the specified parameters. + """ + self.db_name = 'zohooauth.db' + if not self.check_table_exists(): + connection = sqlite3.connect(self.db_name) + cursor = connection.cursor() + cursor.execute("CREATE TABLE oauthtoken (id varchar(10) NOT NULL,user_name varchar(255), client_id varchar(255), client_secret varchar(255), refresh_token varchar(255), access_token varchar(255), grant_token varchar(255), expiry_time varchar(20), redirect_url varchar(255), api_domain varchar(255), primary key (id))") + cursor.close() + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + def find_token(self, token): + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + if isinstance(token, OAuthToken): + oauth_token = token + query = "select * from oauthtoken" + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query= query + " where access_token='" + oauth_token.get_access_token() + "'" + elif oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + if result is None: + return None + self.set_merge_data(oauth_token, result) + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1, cause=ex) + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + return token + + @staticmethod + def get_data(next_record): + return next_record if next_record is not None else None + + @staticmethod + def set_merge_data(oauth_token, next_record): + if oauth_token.get_id() is None: + oauth_token.set_id(CustomStoreSQLite.get_data(next_record[0])) + if oauth_token.get_user_signature() is None: + name = CustomStoreSQLite.get_data(next_record[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(CustomStoreSQLite.get_data(next_record[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(CustomStoreSQLite.get_data(next_record[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(CustomStoreSQLite.get_data(next_record[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(CustomStoreSQLite.get_data(next_record[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(CustomStoreSQLite.get_data(next_record[6])) + if oauth_token.get_expires_in() is None: + expiresIn = CustomStoreSQLite.get_data(next_record[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(CustomStoreSQLite.get_data(next_record[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(CustomStoreSQLite.get_data(next_record[9])) + + def save_token(self, token): + if not isinstance(token, OAuthToken): + return + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + oauth_token = token + query = "update oauthtoken set " + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + self.set_token(oauth_token) + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and len(oauth_token.get_access_token()) > 0 and \ + self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query = query + self.set_token(oauth_token) + " where access_token='" + oauth_token.get_access_token() + "'" + elif ((oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0) or + (oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0)) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + self.set_token(oauth_token) + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + self.set_token(oauth_token) + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + try: + cursor = connection.cursor() + cursor.execute(query) + if cursor.rowcount <= 0: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1) + if oauth_token.get_id() is None: + newId = str(self.generate_id()) + oauth_token.set_id(newId) + query = "insert into oauthtoken (id,user_name,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url,api_domain) values (?,?,?,?,?,?,?,?,?,?);" + val = (token.get_id(), token.get_user_signature().get_name() if token.get_user_signature() is not None else None, token.get_client_id(), token.get_client_secret(), token.get_refresh_token(), token.get_access_token(), token.get_grant_token(), token.get_expires_in(), token.get_redirect_url(), token.get_api_domain()) + cursor.execute(query, val) + except Error as e: + raise e + finally: + connection.commit() + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.SAVE_TOKEN_DB_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def set_token(self, oauth_token): + query = [] + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query.append(self.set_token_info(Constants.USER_NAME, name)) + if oauth_token.get_api_domain() is not None: + query.append(self.set_token_info(Constants.API_DOMAIN, oauth_token.get_api_domain())) + if oauth_token.get_client_id() is not None: + query.append(self.set_token_info(Constants.CLIENT_ID, oauth_token.get_client_id())) + if oauth_token.get_client_secret() is not None: + query.append(self.set_token_info(Constants.CLIENT_SECRET, oauth_token.get_client_secret())) + if oauth_token.get_refresh_token() is not None: + query.append(self.set_token_info(Constants.REFRESH_TOKEN, oauth_token.get_refresh_token())) + if oauth_token.get_access_token() is not None: + query.append(self.set_token_info(Constants.ACCESS_TOKEN, oauth_token.get_access_token())) + if oauth_token.get_grant_token() is not None: + query.append(self.set_token_info(Constants.GRANT_TOKEN, oauth_token.get_grant_token())) + if oauth_token.get_expires_in() is not None: + query.append(self.set_token_info(Constants.EXPIRY_TIME, oauth_token.get_expires_in())) + if oauth_token.get_redirect_url() is not None: + query.append(self.set_token_info(Constants.REDIRECT_URL, oauth_token.get_redirect_url())) + return str.join(",", query) + + @staticmethod + def set_token_info(key, value): + return key + "='" + value + "'" + + def delete_token(self, id): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + try: + cursor = connection.cursor() + query = "delete from oauthtoken where id= " + id + ";" + cursor.execute(query) + connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKEN_DB_ERROR, cause=ex) + + def get_tokens(self): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + tokens = [] + try: + cursor = connection.cursor() + query = "select * from oauthtoken;" + cursor.execute(query) + results = cursor.fetchall() + for result in results: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, result) + tokens.append(oauth_token) + return tokens + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_DB_ERROR, cause=ex) + + def delete_tokens(self): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + try: + cursor = connection.cursor() + query = "delete from oauthtoken;" + cursor.execute(query) + self.connection.commit() + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_DB_ERROR, cause=ex) + + def find_token_by_id(self, id): + cursor = None + try: + connection = sqlite3.connect(self.db_name) + try: + query = "select * from oauthtoken where id='" + id + "'" + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + cursor = connection.cursor() + cursor.execute(query) + results = cursor.fetchall() + if results is None or len(results) <= 0: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_DB_ERROR) + for result in results: + self.set_merge_data(oauth_token, result) + return oauth_token + except Error as ex: + raise ex + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_BY_ID_DB_ERROR, cause=ex) + + def generate_id(self): + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + query = "select max(id) as id from oauthtoken;" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + max1 = result[0] + if max1 is None: + return 1 + else: + return int(max1) + 1 + except Exception as e1: + raise SDKException(Constants.TOKEN_STORE, Constants.GENERATE_TOKEN_ID_ERROR, cause=e1) + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + def check_table_exists(self): + cursor = None + connection = None + try: + connection = sqlite3.connect(self.db_name) + cursor = connection.cursor() + # Query to check if table exists + cursor.execute("SELECT * FROM oauthtoken limit 1") + table = cursor.fetchone() + return table is not None + except Exception as e1: + return False + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None \ No newline at end of file diff --git a/versions/1.0.0/samples/modules/GetModule.py b/versions/1.0.0/samples/modules/GetModule.py new file mode 100644 index 0000000..c86a3e0 --- /dev/null +++ b/versions/1.0.0/samples/modules/GetModule.py @@ -0,0 +1,172 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, ResponseWrapper, APIException + + +class GetModule: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_module(id): + """ + This method is used to get metadata about single module with it's API Name and print the response. + :param module_api_name: The API Name of the module to obtain metadata + """ + """ + example + module_api_name = "Leads"; + """ + modules_operations = ModulesOperations() + # Call get_module method that takes module_api_name as parameter + response = modules_operations.get_module(id) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + modules_list = response_object.get_modules() + for module in modules_list: + print("Module ID: " + str(module.get_id())) + print("Module API Name: " + str(module.get_api_name())) + print("Module Name: " + str(module.get_module_name())) + print("Module Is Convertable: " + str(bool(module.get_convertable()))) + print("Module Is editable: " + str(bool(module.get_editable()))) + print("Module Is deletable: " + str(bool(module.get_deletable()))) + print("Module Web Link: " + str(module.get_web_link())) + print("Module Singular Label: " + str(module.get_singular_label())) + if module.get_modified_time() is not None: + print("Module Modified Time: " + str(module.get_modified_time())) + print("Module Is viewable: " + str(bool(module.get_viewable()))) + print("Module Is API supported: " + str(bool(module.get_api_supported()))) + print("Module Is creatable: " + str(module.get_creatable())) + print("Module Plural Label: " + str(bool(module.get_plural_label()))) + print("Module Generated Type: " + str(bool(module.get_generated_type()))) + print("Module Is blueprintsupported: " + str(bool(module.get_isblueprintsupported()))) + print("Module is Visible: " + str(bool(module.get_visible()))) + om_demand_properties = module.get_on_demand_properties() + if om_demand_properties is not None: + for om_demand_property in om_demand_properties: + print("\n Module onDemandProperties Fields: ") + print(om_demand_property) + arguments = module.get_arguments() + if arguments is not None: + for argument in arguments: + print('Module Argument Name: ' + argument.get_name()) + print("Module Argument Value: " + argument.get_value()) + modified_by_user = module.get_modified_by() + if modified_by_user is not None: + print("Module Modified By User-ID: " + str(modified_by_user.get_id())) + print("Module Modified By User-Name: " + str(modified_by_user.get_name())) + print("Module Is Global Search Supported: " + str(bool(module.get_global_search_supported()))) + print("Module Presence Sub Menu: " + str(bool(module.get_presence_sub_menu()))) + print("Module Is Triggers Supported: " + str(bool(module.get_triggers_supported()))) + print("Module Is Feeds Required: " + str(bool(module.get_feeds_required()))) + print("Module Is Scoring Supported: " + str(bool(module.get_scoring_supported()))) + print("Module Is Webform Supported: " + str(bool(module.get_webform_supported()))) + print("Module Is Kanban view: " + str(bool(module.get_kanban_view()))) + if module.get_kanban_view_supported() is not None: + print("Module Is Kanban view Supported: " + str(bool(module.get_kanban_view_supported()))) + print("Module Show as tab: " + str(bool(module.get_show_as_tab()))) + print("Module Filter Status: " + str(bool(module.get_filter_status()))) + print("Module Quick Create: " + str(bool(module.get_quick_create()))) + print("Module Is email template Supported: " + str(bool(module.get_emailtemplate_support()))) + print("Module Is inventory template Supported: " + str( + bool(module.get_inventory_template_supported()))) + print("Module Description: " + str(module.get_description())) + print("Module Display Field: " + str(module.get_display_field())) + print("Module Visibility: " + str(module.get_visibility())) + print("Module Business card field limit: " + str(module.get_business_card_field_limit())) + print("Module Per page: " + str(module.get_per_page())) + print("Module Sequence Number: " + str(module.get_sequence_number())) + custom_view = module.get_custom_view() + if custom_view is not None: + GetModule.print_custom_view(custom_view) + profiles = module.get_profiles() + if profiles is not None and len(profiles) > 0: + for profile in profiles: + print('Name: ' + str(profile.get_name())) + print('ID: ' + str(profile.get_id())) + search_layout_fields = module.get_search_layout_fields() + if search_layout_fields is not None: + print("Module SearchLayoutFields Fields: ") + for field in search_layout_fields: + print(field, end=",") + print('\n') + related_list_properties = module.get_related_list_properties() + if related_list_properties is not None: + print('Module RelatedListProperties Sort By:' + str(related_list_properties.get_sort_by())) + print('Module RelatedListProperties Sort Order:' + str( + related_list_properties.get_sort_order())) + fields = related_list_properties.get_fields() + if fields is not None: + print('Module RelatedListProperties Fields') + for field in fields: + print(field, end=",") + print('\n') + properties = module.get_properties() + if properties is not None: + print("Module Properties Fields: ") + for property in properties: + print(property, end=',') + print('\n') + parent_module = module.get_parent_module() + if parent_module is not None and parent_module.get_api_name() is not None: + print('Module Parent Module Id: ' + str(parent_module.get_id())) + print('Module Parent Module Name: ' + str(parent_module.get_api_name())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + @staticmethod + def print_custom_view(custom_view): + print('CustomView ID: ' + str(custom_view.get_id())) + print('CustomView Name: ' + str(custom_view.get_name())) + print('CustomView System Name: ' + str(custom_view.get_system_name())) + print('CustomView Display Value: ' + str(custom_view.get_display_value())) + print('CustomView Is default: ' + str(custom_view.get_default())) + print('CustomView SortBy: ' + str(custom_view.get_sort_by())) + if custom_view.get_sort_order() is not None: + print('CustomView SortOrder: ' + str(custom_view.get_sort_order())) + print('CustomView Is System Defined: ' + str(custom_view.get_system_defined())) + if custom_view.get_favorite() is not None: + print('CustomView Favorite: ' + str(custom_view.get_favorite())) + criteria = custom_view.get_criteria() + if criteria is not None: + GetModule.print_criteria(criteria) + fields = custom_view.get_fields() + if fields is not None: + print('Fields') + for field in fields: + print(field.get_api_name()) + + @staticmethod + def print_criteria(criteria): + if criteria.get_comparator() is not None: + print('CustomView Criteria Comparator: ' + criteria.get_comparator()) + if criteria.get_field() is not None: + print('CustomView Criteria Field api name: ' + criteria.get_field().get_api_name()) + if criteria.get_value() is not None: + print('CustomView Criteria Value: ' + str(criteria.get_value())) + criteria_group = criteria.get_group() + if criteria_group is not None: + for each_criteria in criteria_group: + GetModule.print_criteria(each_criteria) + if criteria.get_group_operator() is not None: + print('CustomView Criteria Group Operator: ' + criteria.get_group_operator().get_value()) + + +module_id = 34775367 +GetModule.initialize() +GetModule.get_module(module_id) diff --git a/versions/1.0.0/samples/modules/GetModuleByAPIName.py b/versions/1.0.0/samples/modules/GetModuleByAPIName.py new file mode 100644 index 0000000..768a4a9 --- /dev/null +++ b/versions/1.0.0/samples/modules/GetModuleByAPIName.py @@ -0,0 +1,173 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, ResponseWrapper, APIException + + +class GetModule: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_module_by_api_name(module_api_name): + """ + This method is used to get metadata about single module with it's API Name and print the response. + :param module_api_name: The API Name of the module to obtain metadata + """ + """ + example + module_api_name = "Leads"; + """ + modules_operations = ModulesOperations() + # Call get_module method that takes module_api_name as parameter + response = modules_operations.get_module_by_api_name(module_api_name) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + modules_list = response_object.get_modules() + for module in modules_list: + print("Module ID: " + str(module.get_id())) + print("Module API Name: " + str(module.get_api_name())) + print("Module Name: " + str(module.get_module_name())) + print("Module Is Convertable: " + str(bool(module.get_convertable()))) + print("Module Is editable: " + str(bool(module.get_editable()))) + print("Module Is deletable: " + str(bool(module.get_deletable()))) + print("Module Web Link: " + str(module.get_web_link())) + print("Module Singular Label: " + str(module.get_singular_label())) + if module.get_modified_time() is not None: + print("Module Modified Time: " + str(module.get_modified_time())) + print("Module Is viewable: " + str(bool(module.get_viewable()))) + print("Module Is API supported: " + str(bool(module.get_api_supported()))) + print("Module Is creatable: " + str(module.get_creatable())) + print("Module Plural Label: " + str(bool(module.get_plural_label()))) + print("Module Generated Type: " + str(bool(module.get_generated_type()))) + print("Module Is blueprintsupported: " + str(bool(module.get_isblueprintsupported()))) + print("Module is Visible: " + str(bool(module.get_visible()))) + om_demand_properties = module.get_on_demand_properties() + if om_demand_properties is not None: + for om_demand_property in om_demand_properties: + print("\n Module onDemandProperties Fields: ") + print(om_demand_property) + arguments = module.get_arguments() + if arguments is not None: + for argument in arguments: + print('Module Argument Name: ' + argument.get_name()) + print("Module Argument Value: " + argument.get_value()) + modified_by_user = module.get_modified_by() + if modified_by_user is not None: + print("Module Modified By User-ID: " + str(modified_by_user.get_id())) + print("Module Modified By User-Name: " + str(modified_by_user.get_name())) + print("Module Is Global Search Supported: " + str(bool(module.get_global_search_supported()))) + print("Module Presence Sub Menu: " + str(bool(module.get_presence_sub_menu()))) + print("Module Is Triggers Supported: " + str(bool(module.get_triggers_supported()))) + print("Module Is Feeds Required: " + str(bool(module.get_feeds_required()))) + print("Module Is Scoring Supported: " + str(bool(module.get_scoring_supported()))) + print("Module Is Webform Supported: " + str(bool(module.get_webform_supported()))) + print("Module Is Kanban view: " + str(bool(module.get_kanban_view()))) + if module.get_kanban_view_supported() is not None: + print("Module Is Kanban view Supported: " + str(bool(module.get_kanban_view_supported()))) + print("Module Show as tab: " + str(bool(module.get_show_as_tab()))) + print("Module Filter Status: " + str(bool(module.get_filter_status()))) + print("Module Quick Create: " + str(bool(module.get_quick_create()))) + print("Module Is email template Supported: " + str(bool(module.get_emailtemplate_support()))) + print("Module Is inventory template Supported: " + str( + bool(module.get_inventory_template_supported()))) + print("Module Description: " + str(module.get_description())) + print("Module Display Field: " + str(module.get_display_field())) + print("Module Visibility: " + str(module.get_visibility())) + print("Module Business card field limit: " + str(module.get_business_card_field_limit())) + print("Module Per page: " + str(module.get_per_page())) + print("Module Sequence Number: " + str(module.get_sequence_number())) + custom_view = module.get_custom_view() + if custom_view is not None: + GetModule.print_custom_view(custom_view) + profiles = module.get_profiles() + if profiles is not None and len(profiles) > 0: + for profile in profiles: + print('Name: ' + str(profile.get_name())) + print('ID: ' + str(profile.get_id())) + search_layout_fields = module.get_search_layout_fields() + if search_layout_fields is not None: + print("Module SearchLayoutFields Fields: ") + for field in search_layout_fields: + print(field, end=",") + print('\n') + related_list_properties = module.get_related_list_properties() + if related_list_properties is not None: + print('Module RelatedListProperties Sort By:' + str(related_list_properties.get_sort_by())) + print('Module RelatedListProperties Sort Order:' + str( + related_list_properties.get_sort_order())) + fields = related_list_properties.get_fields() + if fields is not None: + print('Module RelatedListProperties Fields') + for field in fields: + print(field, end=",") + print('\n') + properties = module.get_properties() + if properties is not None: + print("Module Properties Fields: ") + for property in properties: + print(property, end=',') + print('\n') + parent_module = module.get_parent_module() + if parent_module is not None and parent_module.get_api_name() is not None: + print('Module Parent Module Id: ' + str(parent_module.get_id())) + print('Module Parent Module Name: ' + str(parent_module.get_api_name())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + @staticmethod + def print_custom_view(custom_view): + print('CustomView ID: ' + str(custom_view.get_id())) + print('CustomView Name: ' + str(custom_view.get_name())) + print('CustomView System Name: ' + str(custom_view.get_system_name())) + print('CustomView Display Value: ' + str(custom_view.get_display_value())) + print('CustomView Is default: ' + str(custom_view.get_default())) + print('CustomView SortBy: ' + str(custom_view.get_sort_by())) + if custom_view.get_sort_order() is not None: + print('CustomView SortOrder: ' + str(custom_view.get_sort_order())) + print('CustomView Is System Defined: ' + str(custom_view.get_system_defined())) + if custom_view.get_favorite() is not None: + print('CustomView Favorite: ' + str(custom_view.get_favorite())) + criteria = custom_view.get_criteria() + if criteria is not None: + GetModule.print_criteria(criteria) + fields = custom_view.get_fields() + if fields is not None: + print('Fields') + for field in fields: + print(field.get_api_name()) + + @staticmethod + def print_criteria(criteria): + if criteria.get_comparator() is not None: + print('CustomView Criteria Comparator: ' + criteria.get_comparator()) + if criteria.get_field() is not None: + print('CustomView Criteria Field api name: ' + criteria.get_field().get_api_name()) + if criteria.get_value() is not None: + print('CustomView Criteria Value: ' + str(criteria.get_value())) + criteria_group = criteria.get_group() + if criteria_group is not None: + for each_criteria in criteria_group: + GetModule.print_criteria(each_criteria) + if criteria.get_group_operator() is not None: + print('CustomView Criteria Group Operator: ' + criteria.get_group_operator().get_value()) + + +module_api_name = "Leads" +GetModule.initialize() +GetModule.get_module_by_api_name(module_api_name) diff --git a/versions/1.0.0/samples/modules/GetModules.py b/versions/1.0.0/samples/modules/GetModules.py new file mode 100644 index 0000000..c035f5a --- /dev/null +++ b/versions/1.0.0/samples/modules/GetModules.py @@ -0,0 +1,131 @@ +from datetime import datetime +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, GetModulesHeader, ResponseWrapper, APIException + + +class GetModules: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_modules(): + """ + This method is used to get metadata about all the modules and print the response. + """ + modules_operations = ModulesOperations() + header_instance = HeaderMap() + # Add header to HeaderMap instance, if necessary + header_instance.add(GetModulesHeader.if_modified_since, datetime(2020, 1, 1, 10, 1, 1)) + # Call get_modules method that takes header_instance as parameter + response = modules_operations.get_modules(header_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + modules_list = response_object.get_modules() + for module in modules_list: + print("Module ID: " + str(module.get_id())) + print("Module API Name: " + str(module.get_api_name())) + print("Module Name: " + str(module.get_module_name())) + print("Module Is Convertable: " + str(bool(module.get_convertable()))) + print("Module Is editable: " + str(bool(module.get_editable()))) + print("Module Is deletable: " + str(bool(module.get_deletable()))) + print("Module Web Link: " + str(module.get_web_link())) + print("Module Singular Label: " + str(module.get_singular_label())) + if module.get_modified_time() is not None: + print("Module Modified Time: " + str(module.get_modified_time())) + print("Module Is viewable: " + str(bool(module.get_viewable()))) + print("Module Is API supported: " + str(bool(module.get_api_supported()))) + print("Module Is creatable: " + str(module.get_creatable())) + print("Module Plural Label: " + str(bool(module.get_plural_label()))) + print("Module Generated Type: " + str(bool(module.get_generated_type()))) + arguments = module.get_arguments() + if arguments is not None: + for argument in arguments: + print('Module Argument Name: ' + argument.get_name()) + print("Module Argument Value: " + argument.get_value()) + modified_by_user = module.get_modified_by() + if modified_by_user is not None: + print("Module Modified By User-ID: " + str(modified_by_user.get_id())) + print("Module Modified By User-Name: " + str(modified_by_user.get_name())) + print("Module Is Global Search Supported: " + str(bool(module.get_global_search_supported()))) + print("Module Is blueprintsupported: " + str(bool(module.get_isblueprintsupported()))) + print("Module is Visible: " + str(bool(module.get_visible()))) + om_demand_properties = module.get_on_demand_properties() + if om_demand_properties is not None: + for om_demand_property in om_demand_properties: + print("\n Module onDemandProperties Fields: ") + print(om_demand_property) + print("Module Presence Sub Menu: " + str(bool(module.get_presence_sub_menu()))) + print("Module Is Triggers Supported: " + str(bool(module.get_triggers_supported()))) + print("Module Is Feeds Required: " + str(bool(module.get_feeds_required()))) + print("Module Is Scoring Supported: " + str(bool(module.get_scoring_supported()))) + print("Module Is Webform Supported: " + str(bool(module.get_webform_supported()))) + if module.get_kanban_view() is not None: + print("Module Is Kanban view: " + str(bool(module.get_kanban_view()))) + print("Module Is Kanban view Supported: " + str(bool(module.get_kanban_view_supported()))) + print("Module Show as tab: " + str(bool(module.get_show_as_tab()))) + print("Module Filter Status: " + str(bool(module.get_filter_status()))) + print("Module Quick Create: " + str(bool(module.get_quick_create()))) + print("Module Is email template Supported: " + str(bool(module.get_emailtemplate_support()))) + print("Module Is inventory template Supported: " + str( + bool(module.get_inventory_template_supported()))) + print("Module Description: " + str(module.get_description())) + print("Module Display Field: " + str(module.get_display_field())) + print("Module Visibility: " + str(module.get_visibility())) + print("Module Business card field limit: " + str(module.get_business_card_field_limit())) + print("Module Per page: " + str(module.get_per_page())) + print("Module Sequence Number: " + str(module.get_sequence_number())) + profiles = module.get_profiles() + if profiles is not None and len(profiles) > 0: + for profile in profiles: + print('Name: ' + str(profile.get_name())) + print('ID: ' + str(profile.get_id())) + search_layout_fields = module.get_search_layout_fields() + if search_layout_fields is not None: + print("Module SearchLayoutFields Fields: ") + for field in search_layout_fields: + print(field, end=",") + print('\n') + related_list_properties = module.get_related_list_properties() + if related_list_properties is not None: + print('Module RelatedListProperties Sort By:' + str(related_list_properties.get_sort_by())) + print('Module RelatedListProperties Sort Order:' + str( + related_list_properties.get_sort_order())) + fields = related_list_properties.get_fields() + if fields is not None: + print('Module RelatedListProperties Fields') + for field in fields: + print(field, end=",") + print('\n') + properties = module.get_properties() + if properties is not None: + print("Module Properties Fields: ") + for property in properties: + print(property, end=',') + print('\n') + parent_module = module.get_parent_module() + if parent_module is not None and parent_module.get_api_name() is not None: + print('Module Parent Module Id: ' + str(parent_module.get_id())) + print('Module Parent Module Name: ' + str(parent_module.get_api_name())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetModules.initialize() +GetModules.get_modules() \ No newline at end of file diff --git a/versions/1.0.0/samples/modules/UpdateModuleByAPIName.py b/versions/1.0.0/samples/modules/UpdateModuleByAPIName.py new file mode 100644 index 0000000..300e95d --- /dev/null +++ b/versions/1.0.0/samples/modules/UpdateModuleByAPIName.py @@ -0,0 +1,74 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import ModulesOperations, Modules, BodyWrapper, ActionWrapper, \ + SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.profiles import MinifiedProfile + + +class UpdateModuleByAPIName: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_module_by_api_name(module_api_name): + """ + This method is used to update module details using module APIName and print the response. + :param module_api_name: The API Name of the module to update + """ + """ + example + module_api_name = "Leads"; + """ + modules_operations = ModulesOperations() + modules_list = [] + profiles_list = [] + profile = MinifiedProfile() + profile.set_id(34770610026014) + profiles_list.append(profile) + module = Modules() + module.set_profiles(profiles_list) + modules_list.append(module) + request = BodyWrapper() + request.set_modules(modules_list) + # Call update_module_by_api_name method that takes BodyWrapper instance and module_api_name as parameter + response = modules_operations.update_module_by_api_name(module_api_name, request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_modules() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +module_api_name = "Leads" +UpdateModuleByAPIName.initialize() +UpdateModuleByAPIName.update_module_by_api_name(module_api_name) diff --git a/versions/1.0.0/samples/modules/UpdateModuleById.py b/versions/1.0.0/samples/modules/UpdateModuleById.py new file mode 100644 index 0000000..8cc55a9 --- /dev/null +++ b/versions/1.0.0/samples/modules/UpdateModuleById.py @@ -0,0 +1,78 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.modules import APIException, SuccessResponse, ActionWrapper, ModulesOperations, \ + Modules, BodyWrapper +from zohocrmsdk.src.com.zoho.crm.api.profiles import MinifiedProfile + + +class UpdateModuleById: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def update_module_by_id(module_id): + """ + This method is used to update module details using module Id and print the response. + :param module_id: The id of the module to update + """ + """ + example + module_id = 34096430252001 + """ + modules_operations = ModulesOperations() + modules_list = [] + profiles_list = [] + profile = MinifiedProfile() + # To set the Profile Id + profile.set_id(440280031160) + # profile.set_delete(True) + # Add Profile instance to the list + profiles_list.append(profile) + module = Modules() + module.set_profiles(profiles_list) + # Add the Module instance to list + modules_list.append(module) + request = BodyWrapper() + request.set_modules(modules_list) + # Call update_module_by_id method that takes BodyWrapper instance and module_id as parameter + response = modules_operations.update_module(module_id, request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ActionWrapper): + action_response_list = response_object.get_modules() + for action_response in action_response_list: + if isinstance(action_response, SuccessResponse): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(action_response, APIException): + print("Status: " + action_response.get_status().get_value()) + print("Code: " + action_response.get_code().get_value()) + print("Details") + details = action_response.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + action_response.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +module_id = 3477061000000485367 +UpdateModuleById.initialize() +UpdateModuleById.update_module_by_id(module_id) diff --git a/versions/1.0.0/samples/modules/__init__.py b/versions/1.0.0/samples/modules/__init__.py new file mode 100644 index 0000000..1f9c140 --- /dev/null +++ b/versions/1.0.0/samples/modules/__init__.py @@ -0,0 +1,4 @@ +from .GetModule import GetModule +from .GetModules import GetModules +from .UpdateModuleById import UpdateModuleById +from .UpdateModuleByAPIName import UpdateModuleByAPIName diff --git a/versions/1.0.0/samples/org/DeleteOrganizationPhoto.py b/versions/1.0.0/samples/org/DeleteOrganizationPhoto.py new file mode 100644 index 0000000..0c2fed7 --- /dev/null +++ b/versions/1.0.0/samples/org/DeleteOrganizationPhoto.py @@ -0,0 +1,41 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter, INDataCenter +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, SuccessResponse, APIException + + +class DeleteOrganizationPhoto: + @staticmethod + def initialize(): + environment = INDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def delete_organization_photo(): + org_operations = OrgOperations() + response = org_operations.delete_organization_photo() + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +DeleteOrganizationPhoto.initialize() +DeleteOrganizationPhoto.delete_organization_photo() \ No newline at end of file diff --git a/versions/1.0.0/samples/org/GetOrganization.py b/versions/1.0.0/samples/org/GetOrganization.py new file mode 100644 index 0000000..652d3cb --- /dev/null +++ b/versions/1.0.0/samples/org/GetOrganization.py @@ -0,0 +1,84 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, ResponseWrapper, APIException + + +class GetOrganization: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_organization(): + """ + This method is used to get the organization data and print the response. + """ + org_operations = OrgOperations() + # Call get_organization method + response = org_operations.get_organization() + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + org_list = response_object.get_org() + for org in org_list: + print("Organization Country: " + str(org.get_country())) + hierarchy_preferences = org.get_hierarchy_preferences() + if hierarchy_preferences is not None: + print("Organization HierarchyPreferences Type: " + str(hierarchy_preferences.get_type())) + print("Organization HipaaComplianceEnabled: " + str(org.get_hipaa_compliance_enabled())) + print("Organization PhotoId: " + str(org.get_photo_id())) + print("Organization City: " + str(org.get_city())) + print("Organization Description: " + str(org.get_description())) + print("Organization McStatus: " + str(org.get_mc_status())) + print("Organization GappsEnabled: " + str(org.get_gapps_enabled())) + print("Organization DomainName: " + str(org.get_domain_name())) + print("Organization TranslationEnabled: " + str(org.get_translation_enabled())) + print("Organization Alias: " + str(org.get_alias())) + print("Organization Id: " + str(org.get_id())) + print("Organization State: " + str(org.get_state())) + print("Organization Fax: " + str(org.get_fax())) + print("Organization EmployeeCount: " + str(org.get_employee_count())) + print("Organization Zip: " + str(org.get_zip())) + print("Organization Website: " + str(org.get_website())) + print("Organization CurrencySymbol: " + str(org.get_currency_symbol())) + print("Organization Mobile: " + str(org.get_mobile())) + print("Organization CurrencyLocale: " + str(org.get_currency_locale())) + print("Organization PrimaryZuid: " + str(org.get_primary_zuid())) + print("Organization ZiaPortalId: " + str(org.get_zia_portal_id())) + print("Organization TimeZone: " + str(org.get_time_zone())) + print("Organization Zgid: " + str(org.get_zgid())) + print("Organization CountryCode: " + str(org.get_country_code())) + license_details = org.get_license_details() + if license_details is not None: + print("Organization LicenseDetails PaidExpiry: " + str(license_details.get_paid_expiry())) + print("Organization LicenseDetails UsersLicensePurchased: " + str( + license_details.get_users_license_purchased())) + print("Organization LicenseDetails TrialType: " + str(license_details.get_trial_type())) + print("Organization LicenseDetails TrialExpiry: " + str(license_details.get_trial_expiry())) + print("Organization LicenseDetails Paid: " + str(license_details.get_paid())) + print("Organization LicenseDetails PaidType: " + str(license_details.get_paid_type())) + print("Organization Phone: " + str(org.get_phone())) + print("Organization CompanyName: " + str(org.get_company_name())) + print("Organization PrivacySettings: " + str(org.get_privacy_settings())) + print("Organization PrimaryEmail: " + str(org.get_primary_email())) + print("Organization IsoCode: " + str(org.get_iso_code())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +GetOrganization.initialize() +GetOrganization.get_organization() \ No newline at end of file diff --git a/versions/1.0.0/samples/org/GetOrganizationPhoto.py b/versions/1.0.0/samples/org/GetOrganizationPhoto.py new file mode 100644 index 0000000..e4a2910 --- /dev/null +++ b/versions/1.0.0/samples/org/GetOrganizationPhoto.py @@ -0,0 +1,50 @@ +import os + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, FileBodyWrapper, APIException + + +class GetOrganizationPhoto: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_organization_photo(destination_folder): + org_operations = OrgOperations() + response = org_operations.get_org_photo() + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, FileBodyWrapper): + 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: + for chunk in stream_wrapper.get_stream(): + f.write(chunk) + f.close() + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +destintion_folder = "/Users/sdk-sample/file" +GetOrganizationPhoto.initialize() +GetOrganizationPhoto.get_organization_photo(destintion_folder) diff --git a/versions/1.0.0/samples/org/UploadOrganizationPhoto.py b/versions/1.0.0/samples/org/UploadOrganizationPhoto.py new file mode 100644 index 0000000..ad66e02 --- /dev/null +++ b/versions/1.0.0/samples/org/UploadOrganizationPhoto.py @@ -0,0 +1,66 @@ +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.org import OrgOperations, FileBodyWrapper, SuccessResponse, APIException +from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper + + +class UploadOrganizationPhoto: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def upload_organization_photo(absolute_file_path): + """ + This method is used to upload the brand logo or image of the organization and print the response. + :param absolute_file_path: The absolute file path of the file to be attached + """ + """ + example + absolute_file_path = "/Users/user_name/Desktop/logo.png"; + """ + org_operations = OrgOperations() + request = FileBodyWrapper() + """ + StreamWrapper can be initialized in any of the following ways + * param 1 -> fileName + * param 2 -> Read Stream. + """ + # stream_wrapper = StreamWrapper(stream=open(absolute_file_path, 'rb')) + """ + * param 1 -> fileName + * param 2 -> Read Stream + * param 3 -> Absolute File Path of the file to be attached + """ + stream_wrapper = StreamWrapper(file_path=absolute_file_path) + request.set_file(stream_wrapper) + # Call upload_organization_photo method that takes FileBodyWrapper instance as parameter + response = org_operations.upload_organization_photo(request) + if response is not None: + print('Status Code: ' + str(response.get_status_code())) + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, SuccessResponse): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message()) + + +absolute_file_path = "/Users/Desktop/test.png" +UploadOrganizationPhoto.initialize() +UploadOrganizationPhoto.upload_organization_photo(absolute_file_path) diff --git a/versions/1.0.0/samples/org/__init__.py b/versions/1.0.0/samples/org/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/versions/1.0.0/samples/record/GetRecord.py b/versions/1.0.0/samples/record/GetRecord.py new file mode 100644 index 0000000..de16700 --- /dev/null +++ b/versions/1.0.0/samples/record/GetRecord.py @@ -0,0 +1,371 @@ +import os +from datetime import datetime + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, ParameterMap, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.attachments import Attachment +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.layouts import MinifiedLayout +from zohocrmsdk.src.com.zoho.crm.api.record import RecordOperations, ResponseWrapper, \ + FileDetails, Reminder, Participants, ImageUpload, PricingDetails, Record, LineTax, Comment, RemindAt, \ + RecurringActivity, Consent, FileBodyWrapper, APIException, GetRecordParam, GetRecordHeader +from zohocrmsdk.src.com.zoho.crm.api.tags import Tag +from zohocrmsdk.src.com.zoho.crm.api.taxes import Tax +from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class GetRecord: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_record(module_api_name, record_id, destination_folder): + """ + This method is used to get a single record of a module with ID and print the response. + :param module_api_name: The API Name of the record's module. + :param record_id: The ID of the record to be obtained. + :param destination_folder: The absolute path of the destination folder to store the downloaded attachment Record + """ + """ + example + module_api_name = 'Leads' + record_id = 3477061006603276 + """ + record_operations = RecordOperations(module_api_name) + param_instance = ParameterMap() + # Possible parameters for Get Record operation + param_instance.add(GetRecordParam.cvid, '34096430087501') + param_instance.add(GetRecordParam.approved, 'true') + param_instance.add(GetRecordParam.converted, 'both') + fields = ['id', 'Company', 'MultiSelectLookup'] + for field in fields: + param_instance.add(GetRecordParam.fields, field) + start_date_time = datetime(2020, 1, 1, 10, 10, 10) + param_instance.add(GetRecordParam.startdatetime, start_date_time) + end_date_time = datetime(2023, 7, 7, 10, 10, 10) + param_instance.add(GetRecordParam.enddatetime, end_date_time) + param_instance.add(GetRecordParam.territory_id, '34096430505351') + param_instance.add(GetRecordParam.include_child, 'true') + param_instance.add(GetRecordParam.uid, '34096430500741') + header_instance = HeaderMap() + # Possible headers for Get Record operation + header_instance.add(GetRecordHeader.if_modified_since, datetime.now()) + header_instance.add(GetRecordHeader.x_external, "Leads.External") + # Call getRecord method that takes record_id, module_api_name, param_instance and header_instance as parameter + response = record_operations.get_record(record_id, param_instance, header_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + print("Record ID: " + str(record.get_id())) + created_by = record.get_created_by() + if created_by is not None: + print("Record Created By - Name: " + + created_by.get_name()) + print("Record Created By - ID: " + + str(created_by.get_id())) + print("Record Created By - Email: " + + created_by.get_email()) + print("Record CreatedTime: " + + str(record.get_created_time())) + if record.get_modified_time() is not None: + print("Record ModifiedTime: " + + str(record.get_modified_time())) + modified_by = record.get_modified_by() + if modified_by is not None: + print("Record Modified By - Name: " + + modified_by.get_name()) + print("Record Modified By - ID: " + + str(modified_by.get_id())) + print("Record Modified By - Email: " + + modified_by.get_email()) + tags = record.get_tag() + if tags is not None: + for tag in tags: + print("Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + str(tag.get_id())) + # To get particular field value + print("Record Field Value: " + + str(record.get_key_value('Last_Name'))) + print('Record KeyValues: ') + key_values = record.get_key_values() + for key_name, value in key_values.items(): + if isinstance(value, list): + if len(value) > 0: + if isinstance(value[0], FileDetails): + file_details = value + for file_detail in file_details: + print( + "Record FileDetails FileName: " + file_detail.get_file_name__s()) + print( + "Record FileDetails FileId: " + file_detail.get_file_id__s()) + print( + "Record FileDetails FileSize: " + file_detail.get_size__s()) + print( + "Record FileDetails id: " + str(file_detail.get_id())) + elif isinstance(value[0], Reminder): + reminders = value + for reminder in reminders: + print("Reminder Period: " + + reminder.get_period()) + print("Reminder Unit: " + + reminder.get_unit()) + elif isinstance(value[0], Choice): + choice_list = value + print(key_name) + print('Values') + for choice in choice_list: + print(choice.get_value()) + elif isinstance(value[0], Participants): + participants = value + for participant in participants: + print("Record Participants Name: ") + print(participant.get_name()) + print( + "Record Participants Invited: " + str(participant.get_invited())) + print( + "Record Participants Type: " + participant.get_type()) + print( + "Record Participants Participant: " + participant.get_participant()) + print( + "Record Participants Status: " + participant.get_status()) + elif isinstance(value[0], Tax): + tax = value[0] + print("Record Tax Name: " + + tax.get_value()) + print("Record Tax ID: " + + str(tax.get_id())) + elif isinstance(value[0], ImageUpload): + image_uploads = value + for image_upload in image_uploads: + print("RelatedRecord Id: " + + str(image_upload.get_id())) + print("RelatedRecord FileId: " + + image_upload.get_file_id__s()) + print( + "RelatedRecord SequenceNumber: " + image_upload.get_sequence_number()) + print("RelatedRecord Size: " + + str(image_upload.get_size__s())) + print("RelatedRecord State: " + + str(image_upload.get_state__s())) + print( + "RelatedRecord File_Name: " + image_upload.get_file_name__s()) + print( + "RelatedRecord PreviewId: " + str(image_upload.get_preview_id__s())) + print( + "RelatedRecord Description: " + str(image_upload.get_description())) + elif isinstance(value[0], Tag): + tags = value + if tags is not None: + for tag in tags: + print( + "Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + + str(tag.get_id())) + elif isinstance(value[0], PricingDetails): + pricing_details = value + for pricing_detail in pricing_details: + print( + "Record PricingDetails ToRange: " + str(pricing_detail.get_to_range())) + print( + "Record PricingDetails Discount: " + str(pricing_detail.get_discount())) + print( + "Record PricingDetails ID: " + str(pricing_detail.get_id())) + print("Record PricingDetails FromRange: " + str( + pricing_detail.get_from_range())) + elif isinstance(value[0], Record): + record_list = value + for each_record in record_list: + for key, val in each_record.get_key_values().items(): + print( + str(key) + " : " + str(val)) + elif isinstance(value[0], LineTax): + line_taxes = value + for line_tax in line_taxes: + print("Record LineTax Percentage: " + str( + line_tax.get_percentage())) + print( + "Record LineTax Name: " + line_tax.get_name()) + print("Record LineTax Id: " + + str(line_tax.get_id())) + print("Record LineTax Value: " + + str(line_tax.get_value())) + elif isinstance(value[0], Comment): + comments = value + for comment in comments: + print("Comment-ID: " + + str(comment.get_id())) + print("Comment-Content: " + + comment.get_comment_content()) + print("Comment-Commented_By: " + + comment.get_commented_by()) + print("Comment-Commented Time: " + + str(comment.get_commented_time())) + elif isinstance(value[0], Attachment): + attachments = value + for attachment in attachments: + print('Record Attachment ID : ' + + str(attachment.get_id())) + owner = attachment.get_owner() + if owner is not None: + print( + "Record Attachment Owner - Name: " + owner.get_name()) + print( + "Record Attachment Owner - ID: " + str(owner.get_id())) + print( + "Record Attachment Owner - Email: " + owner.get_email()) + print("Record Attachment Modified Time: " + str( + attachment.get_modified_time())) + print( + "Record Attachment File Name: " + attachment.get_file_name()) + print( + "Record Attachment Created Time: " + str(attachment.get_created_time())) + print( + "Record Attachment File Size: " + str(attachment.get_size())) + parent_id = attachment.get_parent_id() + if parent_id is not None: + print( + "Record Attachment parent record Name: ") + print( + parent_id.get_key_value("name")) + print( + "Record Attachment parent record ID: " + str(parent_id.get_id())) + print( + "Record Attachment is Editable: " + str(attachment.get_editable())) + print( + "Record Attachment File ID: " + str(attachment.get_file_id())) + print( + "Record Attachment File Type: " + str(attachment.get_type())) + print( + "Record Attachment seModule: " + str(attachment.get_se_module())) + modified_by = attachment.get_modified_by() + if modified_by is not None: + print( + "Record Attachment Modified By - Name: " + modified_by.get_name()) + print( + "Record Attachment Modified By - ID: " + str(modified_by.get_id())) + print( + "Record Attachment Modified By - Email: " + modified_by.get_email()) + print( + "Record Attachment State: " + attachment.get_state()) + created_by = attachment.get_created_by() + if created_by is not None: + print( + "Record Attachment Created By - Name: " + created_by.get_name()) + print( + "Record Attachment Created By - ID: " + str(created_by.get_id())) + print( + "Record Attachment Created By - Email: " + created_by.get_email()) + print( + "Record Attachment LinkUrl: " + str(attachment.get_link_url())) + else: + print(key_name) + for each_value in value: + print(str(each_value)) + elif isinstance(value, MinifiedUser): + print("Record " + key_name + + " User-ID: " + str(value.get_id())) + print("Record " + key_name + + " User-Name: " + value.get_name()) + print("Record " + key_name + + " User-Email: " + value.get_email()) + elif isinstance(value, MinifiedLayout): + print(key_name + " ID: " + str(value.get_id())) + print(key_name + " Name: " + value.get_name()) + elif isinstance(value, Record): + print(key_name + " Record ID: " + + str(value.get_id())) + print(key_name + " Record Name: " + + value.get_key_value('name')) + elif isinstance(value, Choice): + print(key_name + " : " + value.get_value()) + elif isinstance(value, RemindAt): + print(key_name + " : " + value.get_alarm()) + elif isinstance(value, RecurringActivity): + print(key_name) + print("RRULE: " + value.get_rrule()) + elif isinstance(value, Consent): + print("Record Consent ID: " + + str(value.get_id())) + created_by = value.get_created_by() + if created_by is not None: + print( + "Record Consent Created By - Name: " + created_by.get_name()) + print( + "Record Consent Created By - ID: " + str(created_by.get_id())) + print( + "Record Consent Created By - Email: " + created_by.get_email()) + print("Record Consent CreatedTime: " + + str(value.get_created_time())) + if value.get_modified_time() is not None: + print("Record Consent ModifiedTime: " + + str(value.get_modified_time())) + owner = value.get_owner() + if owner is not None: + print( + "Record Consent Created By - Name: " + owner.get_name()) + print( + "Record Consent Created By - ID: " + str(owner.get_id())) + print( + "Record Consent Created By - Email: " + owner.get_email()) + print("Record Consent ContactThroughEmail: " + + str(value.get_contact_through_email())) + print("Record Consent ContactThroughSocial: " + + str(value.get_contact_through_social())) + print("Record Consent ContactThroughSurvey: " + + str(value.get_contact_through_survey())) + print("Record Consent ContactThroughPhone: " + + str(value.get_contact_through_phone())) + print("Record Consent MailSentTime: " + + str(value.get_mail_sent_time())) + print("Record Consent ConsentDate: " + + str(value.get_consent_date())) + print("Record Consent ConsentRemarks: " + + value.get_consent_remarks()) + print("Record Consent ConsentThrough: " + + value.get_consent_through()) + print("Record Consent DataProcessingBasis: " + + value.get_data_processing_basis()) + # To get custom values + print("Record Consent Lawful Reason: " + + str(value.get_key_value("Lawful_Reason"))) + elif isinstance(value, dict): + for key, val in value.items(): + print(key + " : " + str(val)) + else: + print(key_name + " : " + str(value)) + elif isinstance(response_object, FileBodyWrapper): + 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: + for chunk in stream_wrapper.get_stream(): + f.write(chunk) + f.close() + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module_api_name = "Leads" +record_id = 347502001 +destination_folder = "/Users/docs/file" +GetRecord.initialize() +GetRecord.get_record(module_api_name, record_id, destination_folder) diff --git a/versions/1.0.0/samples/record/GetRecords.py b/versions/1.0.0/samples/record/GetRecords.py new file mode 100644 index 0000000..45520b9 --- /dev/null +++ b/versions/1.0.0/samples/record/GetRecords.py @@ -0,0 +1,377 @@ +from datetime import datetime + +from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken +from zohocrmsdk.src.com.zoho.crm.api import Initializer, ParameterMap, HeaderMap +from zohocrmsdk.src.com.zoho.crm.api.attachments import Attachment +from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter +from zohocrmsdk.src.com.zoho.crm.api.layouts import MinifiedLayout +from zohocrmsdk.src.com.zoho.crm.api.record import RecordOperations, GetRecordsParam, GetRecordsHeader, ResponseWrapper, \ + FileDetails, Reminder, Participants, ImageUpload, PricingDetails, Record, LineTax, Comment, RemindAt, \ + RecurringActivity, Consent, APIException +from zohocrmsdk.src.com.zoho.crm.api.tags import Tag +from zohocrmsdk.src.com.zoho.crm.api.taxes import Tax +from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser +from zohocrmsdk.src.com.zoho.crm.api.util import Choice + + +class GetRecords: + @staticmethod + def initialize(): + environment = USDataCenter.PRODUCTION() + token = OAuthToken(client_id="clientID", client_secret="clientSecret", refresh_token="refreshToken") + Initializer.initialize(environment, token) + + @staticmethod + def get_records(module_api_name): + """ + This method is used to get all the records of a module and print the response. + :param module_api_name: The API Name of the module to fetch records + """ + """ + example + module_api_name = 'Leads' + """ + record_operations = RecordOperations(module_api_name) + param_instance = ParameterMap() + # Possible parameters for Get Records operation + param_instance.add(GetRecordsParam.page, 1) + param_instance.add(GetRecordsParam.per_page, 120) + param_instance.add(GetRecordsParam.approved, 'both') + param_instance.add(GetRecordsParam.converted, 'both') + param_instance.add(GetRecordsParam.cvid, '34096430087501') + ids = ["External1256", "3477061004352001"] + for each_id in ids: + param_instance.add(GetRecordsParam.ids, each_id) + param_instance.add(GetRecordsParam.uid, '34096430302031') + field_names = ["Company", "Email"] + for field in field_names: + param_instance.add(GetRecordsParam.fields, field) + param_instance.add(GetRecordsParam.sort_by, 'Email') + param_instance.add(GetRecordsParam.sort_order, 'desc') + start_date_time = datetime(2020, 1, 1, 0, 0, 0) + param_instance.add(GetRecordsParam.startdatetime, start_date_time) + end_date_time = datetime(2020, 7, 1, 0, 0, 0) + param_instance.add(GetRecordsParam.enddatetime, end_date_time) + param_instance.add(GetRecordsParam.territory_id, '34096430505351') + param_instance.add(GetRecordsParam.include_child, "true") + header_instance = HeaderMap() + # Possible headers for Get Records operation + header_instance.add(GetRecordsHeader.if_modified_since, + datetime.fromisoformat('2020-01-01T00:00:00+05:30')) + # header_instance.add(GetRecordsHeader.x_external, "Leads.External") + # Call get_records method that takes ParameterMap Instance, HeaderMap Instance and module_api_name as parameters + response = record_operations.get_records(param_instance, header_instance) + if response is not None: + 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 + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + record_list = response_object.get_data() + for record in record_list: + print("Record ID: " + str(record.get_id())) + created_by = record.get_created_by() + if created_by is not None: + print("Record Created By - Name: " + + created_by.get_name()) + print("Record Created By - ID: " + + str(created_by.get_id())) + print("Record Created By - Email: " + + created_by.get_email()) + print("Record CreatedTime: " + + str(record.get_created_time())) + if record.get_modified_time() is not None: + print("Record ModifiedTime: " + + str(record.get_modified_time())) + modified_by = record.get_modified_by() + if modified_by is not None: + print("Record Modified By - Name: " + + modified_by.get_name()) + print("Record Modified By - ID: " + + str(modified_by.get_id())) + print("Record Modified By - Email: " + + modified_by.get_email()) + tags = record.get_tag() + if tags is not None: + for tag in tags: + print("Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + str(tag.get_id())) + # To get particular field value + print("Record Field Value: " + + str(record.get_key_value('Last_Name'))) + print('Record KeyValues: ') + key_values = record.get_key_values() + for key_name, value in key_values.items(): + if isinstance(value, list): + if len(value) > 0: + if isinstance(value[0], FileDetails): + file_details = value + for file_detail in file_details: + print( + "Record FileDetails FileName: " + file_detail.get_file_name__s()) + print( + "Record FileDetails FileId: " + file_detail.get_file_id__s()) + print( + "Record FileDetails FileSize: " + file_detail.get_size__s()) + print( + "Record FileDetails id: " + str(file_detail.get_id())) + elif isinstance(value[0], Reminder): + reminders = value + for reminder in reminders: + print("Reminder Period: " + + reminder.get_period()) + print("Reminder Unit: " + + reminder.get_unit()) + elif isinstance(value[0], Choice): + choice_list = value + print(key_name) + print('Values') + for choice in choice_list: + print(choice.get_value()) + elif isinstance(value[0], Participants): + participants = value + for participant in participants: + print("Record Participants Name: ") + print(participant.get_name()) + print( + "Record Participants Invited: " + str(participant.get_invited())) + print( + "Record Participants Type: " + participant.get_type()) + print( + "Record Participants Participant: " + participant.get_participant()) + print( + "Record Participants Status: " + participant.get_status()) + elif isinstance(value[0], Tax): + tax = value[0] + print("Record Tax Name: " + + tax.get_value()) + print("Record Tax ID: " + + str(tax.get_id())) + elif isinstance(value[0], Tag): + tags = value + if tags is not None: + for tag in tags: + print( + "Record Tag Name: " + tag.get_name()) + print("Record Tag ID: " + + str(tag.get_id())) + elif isinstance(value[0], ImageUpload): + image_uploads = value + for image_upload in image_uploads: + print("RelatedRecord Id: " + + str(image_upload.get_id())) + print("RelatedRecord FileId: " + + image_upload.get_file_id__s()) + print( + "RelatedRecord SequenceNumber: " + image_upload.get_sequence_number()) + print("RelatedRecord Size: " + + str(image_upload.get_size__S())) + print("RelatedRecord State: " + + str(image_upload.get_state__S())) + print( + "RelatedRecord File_Name: " + image_upload.get_file_name__s()) + print( + "RelatedRecord PreviewId: " + image_upload.get_preview_id__S()) + print( + "RelatedRecord Description: " + str(image_upload.get_description())) + elif isinstance(value[0], PricingDetails): + pricing_details = value + for pricing_detail in pricing_details: + print( + "Record PricingDetails ToRange: " + str(pricing_detail.get_to_range())) + print( + "Record PricingDetails Discount: " + str(pricing_detail.get_discount())) + print( + "Record PricingDetails ID: " + str(pricing_detail.get_id())) + print("Record PricingDetails FromRange: " + str( + pricing_detail.get_from_range())) + elif isinstance(value[0], Record): + record_list = value + for each_record in record_list: + for key, val in each_record.get_key_values().items(): + print( + str(key) + " : " + str(val)) + elif isinstance(value[0], LineTax): + line_taxes = value + for line_tax in line_taxes: + print("Record LineTax Percentage: " + str( + line_tax.get_percentage())) + print( + "Record LineTax Name: " + line_tax.get_name()) + print("Record LineTax Id: " + + str(line_tax.get_id())) + print("Record LineTax Value: " + + str(line_tax.get_value())) + elif isinstance(value[0], Comment): + comments = value + for comment in comments: + print("Comment-ID: " + + str(comment.get_id())) + print( + "Comment-Content: " + str(comment.get_comment_content())) + print("Comment-Commented_By: " + + str(comment.get_commented_by())) + print("Comment-Commented Time: " + + str(comment.get_commented_time())) + elif isinstance(value[0], Attachment): + attachments = value + for attachment in attachments: + print('Record Attachment ID : ' + + str(attachment.get_id())) + owner = attachment.get_owner() + if owner is not None: + print( + "Record Attachment Owner - Name: " + owner.get_name()) + print( + "Record Attachment Owner - ID: " + str(owner.get_id())) + print( + "Record Attachment Owner - Email: " + owner.get_email()) + print("Record Attachment Modified Time: " + str( + attachment.get_modified_time())) + print( + "Record Attachment File Name: " + attachment.get_file_name()) + print( + "Record Attachment Created Time: " + str(attachment.get_created_time())) + print( + "Record Attachment File Size: " + str(attachment.get_size())) + parent_id = attachment.get_parent_id() + if parent_id is not None: + print( + "Record Attachment parent record Name: ") + print( + parent_id.get_key_value("name")) + print( + "Record Attachment parent record ID: " + str(parent_id.get_id())) + print( + "Record Attachment is Editable: " + str(attachment.get_editable())) + print( + "Record Attachment File ID: " + str(attachment.get_file_id())) + print( + "Record Attachment File Type: " + str(attachment.get_type())) + print( + "Record Attachment seModule: " + str(attachment.get_se_module())) + modified_by = attachment.get_modified_by() + if modified_by is not None: + print( + "Record Attachment Modified By - Name: " + modified_by.get_name()) + print( + "Record Attachment Modified By - ID: " + str(modified_by.get_id())) + print( + "Record Attachment Modified By - Email: " + modified_by.get_email()) + print( + "Record Attachment State: " + attachment.get_state()) + created_by = attachment.get_created_by() + if created_by is not None: + print( + "Record Attachment Created By - Name: " + created_by.get_name()) + print( + "Record Attachment Created By - ID: " + str(created_by.get_id())) + print( + "Record Attachment Created By - Email: " + created_by.get_email()) + print( + "Record Attachment LinkUrl: " + str(attachment.get_link_url())) + else: + print(key_name) + for each_value in value: + print(str(each_value)) + elif isinstance(value, MinifiedUser): + print("Record " + key_name + + " User-ID: " + str(value.get_id())) + print("Record " + key_name + + " User-Name: " + value.get_name()) + print("Record " + key_name + + " User-Email: " + value.get_email()) + elif isinstance(value, MinifiedLayout): + print(key_name + " ID: " + str(value.get_id())) + print(key_name + " Name: " + value.get_name()) + elif isinstance(value, Record): + print(key_name + " Record ID: " + + str(value.get_id())) + print(key_name + " Record Name: ") + print(value.get_key_value('name')) + elif isinstance(value, Choice): + print(key_name + " : " + value.get_value()) + elif isinstance(value, RemindAt): + print(key_name + " : " + value.get_alarm()) + elif isinstance(value, RecurringActivity): + print(key_name) + print("RRULE: " + value.get_rrule()) + elif isinstance(value, Consent): + print("Record Consent ID: " + + str(value.get_id())) + created_by = value.get_created_by() + if created_by is not None: + print( + "Record Consent Created By - Name: " + created_by.get_name()) + print( + "Record Consent Created By - ID: " + str(created_by.get_id())) + print( + "Record Consent Created By - Email: " + created_by.get_email()) + print("Record Consent CreatedTime: " + + str(value.get_created_time())) + if value.get_modified_time() is not None: + print("Record Consent ModifiedTime: " + + str(value.get_modified_time())) + owner = value.get_owner() + if owner is not None: + print( + "Record Consent Created By - Name: " + owner.get_name()) + print( + "Record Consent Created By - ID: " + str(owner.get_id())) + print( + "Record Consent Created By - Email: " + owner.get_email()) + print("Record Consent ContactThroughEmail: " + + str(value.get_contact_through_email())) + print("Record Consent ContactThroughSocial: " + + str(value.get_contact_through_social())) + print("Record Consent ContactThroughSurvey: " + + str(value.get_contact_through_survey())) + print("Record Consent ContactThroughPhone: " + + str(value.get_contact_through_phone())) + print("Record Consent MailSentTime: " + + str(value.get_mail_sent_time())) + print("Record Consent ConsentDate: " + + str(value.get_consent_date())) + print("Record Consent ConsentRemarks: " + + value.get_consent_remarks()) + print("Record Consent ConsentThrough: " + + value.get_consent_through()) + print("Record Consent DataProcessingBasis: " + + value.get_data_processing_basis()) + # To get custom values + print("Record Consent Lawful Reason: " + + str(value.get_key_value("Lawful_Reason"))) + elif isinstance(value, dict): + for key, val in value.items(): + print(key + " : " + str(val)) + else: + print(key_name + " : " + str(value)) + info = response_object.get_info() + if info is not None: + if info.get_per_page() is not None: + print('Record Info PerPage: ' + + str(info.get_per_page())) + if info.get_page() is not None: + print('Record Info Page: ' + str(info.get_page())) + if info.get_count() is not None: + print('Record Info Count: ' + + str(info.get_count())) + if info.get_more_records() is not None: + print('Record Info MoreRecords: ' + + str(info.get_more_records())) + elif isinstance(response_object, APIException): + print("Status: " + response_object.get_status().get_value()) + print("Code: " + response_object.get_code().get_value()) + print("Details") + details = response_object.get_details() + for key, value in details.items(): + print(key + ' : ' + str(value)) + print("Message: " + response_object.get_message().get_value()) + + +module_api_name = "Leads" +GetRecords.initialize() +GetRecords.get_records(module_api_name) diff --git a/versions/1.0.0/samples/record/__init__.py b/versions/1.0.0/samples/record/__init__.py new file mode 100644 index 0000000..e146260 --- /dev/null +++ b/versions/1.0.0/samples/record/__init__.py @@ -0,0 +1,2 @@ +from .GetRecords import GetRecords +from .GetRecord import GetRecord diff --git a/versions/1.0.0/zohocrmsdk/__init__.py b/versions/1.0.0/zohocrmsdk/__init__.py new file mode 100755 index 0000000..db9863f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/__init__.py @@ -0,0 +1 @@ +from . import src \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/__init__.py b/versions/1.0.0/zohocrmsdk/src/__init__.py new file mode 100755 index 0000000..e742b6a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/__init__.py @@ -0,0 +1 @@ +from . import com \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/__init__.py new file mode 100755 index 0000000..e2b4c1a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/__init__.py @@ -0,0 +1 @@ +from . import zoho \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/__init__.py new file mode 100755 index 0000000..893812e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/__init__.py @@ -0,0 +1,2 @@ +from . import api +from . import crm \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/__init__.py new file mode 100755 index 0000000..beecef6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/__init__.py @@ -0,0 +1,2 @@ +from . import authenticator +from . import logger diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/__init__.py new file mode 100755 index 0000000..ac7dc36 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/__init__.py @@ -0,0 +1,3 @@ +from .token import Token +from .oauth_token import OAuthToken +from . import store diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/oauth_token.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/oauth_token.py new file mode 100755 index 0000000..dad9ebc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/oauth_token.py @@ -0,0 +1,510 @@ +try: + import threading + import logging + import enum + import json + import time + import requests + from .token import Token + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from ...crm.api.util import APIHTTPConnector + from ...crm.api.util import Utility + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from ...crm.api.util.constants import Constants + from ...crm.api.user_signature import UserSignature + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter + +except Exception as e: + import threading + import logging + import enum + import json + import time + import requests + from .token import Token + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from ...crm.api.util import APIHTTPConnector + from ...crm.api.util import Utility + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from ...crm.api.util.constants import Constants + from ...crm.api.dc.data_center import DataCenter + + +class OAuthToken(Token): + """ + This class maintains the tokens and authenticates every request. + """ + + logger = logging.getLogger('SDKLogger') + lock = threading.Lock() + + def __init__(self, client_id=None, client_secret=None, grant_token=None, refresh_token=None, redirect_url=None, + id=None, access_token=None, user_signature=None, api_domain=None, find_user=True): + + """ + Creates an OAuthToken class instance with the specified parameters. + + Parameters: + client_id (str) : A string containing the OAuth client id. + client_secret (str) : A string containing the OAuth client secret. + grant_token (str) : A string containing the GRANT token. + refresh_token (str) : A string containing the REFRESH token. + redirect_url (str) : A string containing the OAuth redirect URL. Default value is None + id (str) : A string containing the Id. Default value is None + user_signature(UserSignature) : An instance of UserSignature + api_domain(str) : A string containing the api_domain + """ + + error = {} + + if grant_token is None and refresh_token is None and id is None and access_token is None and user_signature is None: + raise SDKException(code=Constants.MANDATORY_VALUE_ERROR, message=Constants.MANDATORY_KEY_ERROR, + details=Constants.OAUTH_MANDATORY_KEYS) + + if id is None and access_token is None and user_signature is None: + if not isinstance(client_id, str): + error[Constants.FIELD] = Constants.CLIENT_ID + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if not isinstance(client_secret, str): + error[Constants.FIELD] = Constants.CLIENT_SECRET + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if grant_token is not None and not isinstance(grant_token, str): + error[Constants.FIELD] = Constants.GRANT_TOKEN + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if refresh_token is not None and not isinstance(refresh_token, str): + error[Constants.FIELD] = Constants.REFRESH_TOKEN + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if redirect_url is not None and not isinstance(redirect_url, str): + error[Constants.FIELD] = Constants.REDIRECT_URI + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if id is not None and not isinstance(id, str): + error[Constants.FIELD] = Constants.ID + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if access_token is not None and not isinstance(access_token, str): + error[Constants.FIELD] = Constants.ACCESS_TOKEN + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if user_signature is not None and not isinstance(user_signature, UserSignature): + error[Constants.FIELD] = Constants.USER_NAME + error[Constants.EXPECTED_TYPE] = Constants.USER_SIGNATURE_ERROR_MESSAGE + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + self.__client_id = client_id + self.__client_secret = client_secret + self.__redirect_url = redirect_url + self.__grant_token = grant_token + self.__refresh_token = refresh_token + self.__id = id + self.__access_token = access_token + self.__expires_in = None + self.__user_signature = user_signature + self.__api_domain = api_domain + self.__find_user = find_user + + def get_client_id(self): + """ + This is a getter method to get __client_id. + + Returns: + string: A string representing __client_id + """ + + return self.__client_id + + def get_client_secret(self): + """ + This is a getter method to get __client_secret. + + Returns: + string: A string representing __client_secret + """ + + return self.__client_secret + + def get_redirect_url(self): + """ + This is a getter method to get __redirect_url. + + Returns: + string: A string representing __redirect_url + """ + + return self.__redirect_url + + def get_grant_token(self): + """ + This is a getter method to get __grant_token. + + Returns: + string: A string representing __grant_token + """ + return self.__grant_token + + def get_refresh_token(self): + """ + This is a getter method to get __refresh_token. + + Returns: + string: A string representing __refresh_token + """ + + return self.__refresh_token + + def get_access_token(self): + """ + This is a getter method to get __access_token. + + Returns: + string: A string representing __access_token + """ + + return self.__access_token + + def get_id(self): + """ + This is a getter method to get __id. + + Returns: + string: A string representing __id + """ + + return self.__id + + def get_expires_in(self): + """ + This is a getter method to get __expires_in. + + Returns: + string: A string representing __expires_in + """ + + return self.__expires_in + + def get_user_signature(self): + """ + This is a getter method to get __user_signature + + Returns: + user_signature(UserSignature) : An instance of UserSignature + """ + + return self.__user_signature + + def get_api_domain(self): + """ + This is a getter method to get api_domain + + Returns: + string: A string representing __api_domain + """ + + return self.__api_domain + + def set_grant_token(self, grant_token): + """ + This is a setter method to set __grant_token. + + """ + self.__grant_token = grant_token + + def set_refresh_token(self, refresh_token): + """ + This is a setter method to set __refresh_token. + + """ + self.__refresh_token = refresh_token + + def set_redirect_url(self, redirect_url): + """ + This is a setter method to set __redirect_url. + + """ + self.__redirect_url = redirect_url + + def set_access_token(self, access_token): + """ + This is a setter method to set __access_token. + + """ + + self.__access_token = access_token + + def set_client_id(self, client_id): + """ + This is a setter method to set __client_id. + + """ + + self.__client_id = client_id + + def set_client_secret(self, client_secret): + """ + This is a setter method to set __client_secret. + + """ + + self.__client_secret = client_secret + + def set_id(self, id): + """ + This is a setter method to set __id. + + """ + + self.__id = id + + def set_expires_in(self, expires_in): + """ + This is a setter method to set __expires_in. + + """ + + self.__expires_in = expires_in + + def set_user_signature(self, user_signature): + """ + This is a setter method to set __user_signature. + + """ + + self.__user_signature = user_signature + + def set_api_domain(self, api_domain): + """ + This is a setter method to set __api_domain + """ + + self.__api_domain = api_domain + + def generate_token(self): + self.get_token() + + def get_token(self): + initializer = Initializer.get_initializer() + store = initializer.store + + oauth_token = None + if self.get_id() is not None: + oauth_token = store.find_token_by_id(self.get_id()) + self.merge_objects(self, oauth_token) + oauth_token.__find_user = self.__find_user + else: + oauth_token = store.find_token(self) + if oauth_token is None: + if self.get_user_signature() is not None: + self.check_token_details() + oauth_token = self + if oauth_token.get_api_domain() is None or len(oauth_token.get_api_domain()) <= 0: + if initializer.environment is None: + raise SDKException(Constants.ENVIRONMENT_ERROR_1, Constants.ENVIRONMENT_ERROR_MESSAGE + ":") + oauth_token.set_api_domain(initializer.environment.url) + environment = DataCenter.get(oauth_token.get_api_domain()) + if environment is not None: + try: + initializer = Initializer.get_initializer() + setattr(initializer, Constants.ENVIRONMENT, environment) + except Exception as e: + raise SDKException(Constants.ENVIRONMENT_ERROR_RESPONSE + ":", cause=e) + else: + if initializer.environment is None: + raise SDKException(Constants.ENVIRONMENT_ERROR_1, Constants.ENVIRONMENT_ERROR_MESSAGE + ":") + + url = initializer.environment.accounts_url + save = False + if oauth_token.get_access_token() is None or len(oauth_token.get_access_token()) == 0: + if oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + logging.getLogger("SDKLogger").info(Constants.ACCESS_TOKEN_USING_REFRESH_TOKEN_MESSAGE) + oauth_token.refresh_access_token(oauth_token, url) + else: + logging.getLogger("SDKLogger").info(Constants.ACCESS_TOKEN_USING_GRANT_TOKEN_MESSAGE) + oauth_token.generate_access_token(oauth_token, url) + save = True + elif (oauth_token.get_expires_in() is not None and len(oauth_token.get_expires_in()) > 0 and int( + oauth_token.get_expires_in()) - int(time.time() * 1000) < 5000): + logging.getLogger("SDKLogger").info(Constants.REFRESH_TOKEN_MESSAGE) + oauth_token.refresh_access_token(oauth_token, url) + save = True + elif oauth_token.get_expires_in() is None and oauth_token.get_access_token() is not None and \ + oauth_token.get_id() is None: + + save = True + if save: + try: + if oauth_token.__user_signature is None and oauth_token.__find_user: + try: + user_name = Utility().get_user_name(oauth_token.get_access_token()) + if user_name is not None: + oauth_token.set_user_signature(UserSignature(user_name)) + except SDKException as ex: + logging.getLogger("SDKLogger").error(Constants.API_EXCEPTION, ex) + store.save_token(oauth_token) + except Exception as ex: + logging.getLogger("SDKLogger").error(Constants.SAVE_TOKEN_ERROR, ex) + return oauth_token.get_access_token() + + def check_token_details(self): + if self.are_all_objects_null([self.__grant_token, self.__refresh_token]): + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.GET_TOKEN_BY_USER_NAME_ERROR + " - " + + str.join(", ", Constants.OAUTH_MANDATORY_KEYS2)) + return True + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + @staticmethod + def merge_objects(first, second): + try: + fields = dir(first) + for field1 in fields: + if any(field2 in field1 for field2 in Constants.OAUTH_TOKEN_FIELDS): + if not field1.startswith('__'): + value1 = getattr(first, field1) + value2 = getattr(second, field1) + value = value1 if value1 is not None else value2 + setattr(first, field1, value) + + except Exception as ex: + raise SDKException(Constants.MERGE_OBJECT, cause=ex) + + def authenticate(self, url_connection): + if Constants.AUTHORIZATION not in url_connection.headers: + url_connection.add_header(Constants.AUTHORIZATION, Constants.OAUTH_HEADER_PREFIX + self.get_token()) + + def refresh_access_token(self, oauth_token, url): + try: + body = { + Constants.REFRESH_TOKEN: oauth_token.__refresh_token, + Constants.CLIENT_ID: oauth_token.__client_id, + Constants.CLIENT_SECRET: oauth_token.__client_secret, + Constants.GRANT_TYPE: Constants.REFRESH_TOKEN + } + + response = requests.post(url, data=body, params=None, headers=None, allow_redirects=False).json() + self.parse_response(oauth_token, response) + + except SDKException as ex: + raise ex + + except Exception as ex: + raise SDKException(code=Constants.SAVE_TOKEN_ERROR, cause=ex) + + return oauth_token + + def generate_access_token(self, oauth_token, url): + try: + body = { + Constants.CLIENT_ID: oauth_token.__client_id, + Constants.CLIENT_SECRET: oauth_token.__client_secret, + Constants.REDIRECT_URI: oauth_token.__redirect_url if oauth_token.__redirect_url is not None else None, + Constants.GRANT_TYPE: Constants.GRANT_TYPE_AUTH_CODE, + Constants.CODE: oauth_token.__grant_token + } + + headers = dict() + headers[Constants.USER_AGENT_KEY] = Constants.USER_AGENT + response = requests.post(url, data=body, params=None, headers=headers, allow_redirects=True).json() + self.parse_response(oauth_token, response) + + except SDKException as ex: + raise ex + + except Exception as ex: + raise SDKException(code=Constants.SAVE_TOKEN_ERROR, cause=ex) + + return self + + def parse_response(self, oauth_token, response): + response_json = dict(response) + + if Constants.ACCESS_TOKEN not in response_json: + raise SDKException(code=Constants.INVALID_TOKEN_ERROR, message=str(response_json.get( + Constants.ERROR_KEY)) if Constants.ERROR_KEY in response_json else Constants.NO_ACCESS_TOKEN_ERROR) + + oauth_token.__access_token = response_json.get(Constants.ACCESS_TOKEN) + oauth_token.__expires_in = str(int(time.time() * 1000) + self.get_token_expires_in(response=response_json)) + + if Constants.REFRESH_TOKEN in response_json: + oauth_token.__refresh_token = response_json.get(Constants.REFRESH_TOKEN) + + if Constants.API_DOMAIN in response_json: + oauth_token.__api_domain = response_json.get(Constants.API_DOMAIN) + + return oauth_token + + @staticmethod + def get_token_expires_in(response): + return int(response[Constants.EXPIRES_IN]) if Constants.EXPIRES_IN_SEC in response else int( + response[Constants.EXPIRES_IN]) * 1000 + + def remove(self): + try: + Initializer.get_initializer().store.delete_token(self.get_id()) + return True + except Exception: + return False + + def revoke(self, id1): + try: + if Initializer.get_initializer() is None: + raise SDKException(Constants.SDK_UNINITIALIZATION_ERROR, Constants.SDK_UNINITIALIZATION_MESSAGE) + initializer = Initializer.get_initializer() + store = initializer.store + url = initializer.environment.accounts_url + is_revoke = False + oauthToken = OAuthToken() + oauthToken.set_id(id1) + store.find_token(oauthToken) + if oauthToken is not None and oauthToken.get_refresh_token() is not None: + is_revoke = self.revoke_refresh_token(oauthToken.get_refresh_token(), url + Constants.REVOKE_URL) + logging.getLogger("SDKLogger").info(Constants.ID + " : " + id1 + Constants.REFRESH_TOKEN_REMOVED) + else: + logging.getLogger("SDKLogger").info(Constants.ID + " : " + id1 + Constants.TOKEN_NOT_FOUND) + + return is_revoke + except SDKException as ex: + raise ex + except Exception as e1: + raise SDKException(cause=e1) + + @staticmethod + def revoke_refresh_token(refreshToken, url): + try: + body = { + Constants.TOKEN: refreshToken + } + headers = dict() + response = requests.post(url, data=body, params=None, headers=headers, allow_redirects=True).json() + responseJSON = dict(response) + if (responseJSON is not None and Constants.STATUS in responseJSON and responseJSON.get( + Constants.STATUS) == Constants.STATUS_SUCCESS): + return True + return False + except SDKException as ex: + raise ex + except Exception as e3: + raise SDKException(Constants.REVOKE_TOKEN_ERROR, cause=e3) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/__init__.py new file mode 100755 index 0000000..e71b51d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/__init__.py @@ -0,0 +1,3 @@ +from .db_store import DBStore +from .file_store import FileStore +from .token_store import TokenStore diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/db_store.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/db_store.py new file mode 100755 index 0000000..2c85cbb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/db_store.py @@ -0,0 +1,419 @@ +try: + from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +except Exception as e: + from .token_store import TokenStore + from ..oauth_token import OAuthToken + from ....crm.api.util.constants import Constants + from ....crm.api.exception.sdk_exception import SDKException + from ....crm.api.user_signature import UserSignature + + +class DBStore(TokenStore): + + """ + This class to store user token details to the MySQL DataBase. + """ + + def __init__(self, host=Constants.MYSQL_HOST, database_name=Constants.MYSQL_DATABASE_NAME, + user_name=Constants.MYSQL_USER_NAME, password="", port_number=Constants.MYSQL_PORT_NUMBER, + table_name=Constants.MYSQL_TABLE_NAME): + + """ + Creates a DBStore class instance with the specified parameters. + + Parameters: + host (str) : A string containing the DataBase host name. Default value is localhost + database_name (str) : A string containing the DataBase name. Default value is zohooauth + user_name (str) : A string containing the DataBase user name. Default value is root + password (str) : A string containing the DataBase password. Default value is an empty string + port_number (str) : A string containing the DataBase port number. Default value is 3306 + """ + + self.__host = host + self.__database_name = database_name + self.__user_name = user_name + self.__password = password + self.__port_number = port_number + self.__table_name = table_name + + def get_host(self): + """ + This is a getter method to get __host. + + Returns: + string: A string representing __host + """ + + return self.__host + + def get_database_name(self): + """ + This is a getter method to get __database_name. + + Returns: + string: A string representing __database_name + """ + + return self.__database_name + + def get_user_name(self): + """ + This is a getter method to get __user_name. + + Returns: + string: A string representing __user_name + """ + + return self.__user_name + + def get_password(self): + """ + This is a getter method to get __password. + + Returns: + string: A string representing __password + """ + return self.__password + + def get_port_number(self): + """ + This is a getter method to get __port_number. + + Returns: + string: A string representing __port_number + """ + + return self.__port_number + + def get_table_name(self): + """ + This is a getter method to get __table_name. + + Returns: + string: A string representing __table_name + """ + + return self.__table_name + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + def find_token(self, token): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + connection = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + if isinstance(token, OAuthToken): + oauth_token = token + query = "select * from " + self.__table_name + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query= query + " where access_token='" + oauth_token.get_access_token() + "'" + elif oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + if result is None: + return None + self.set_merge_data(oauth_token, result) + + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1, cause=ex) + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + return token + + @staticmethod + def get_data(next_record): + return next_record if next_record is not None else None + + @staticmethod + def set_merge_data(oauth_token, nextRecord): + if oauth_token.get_id() is None: + oauth_token.set_id(DBStore.get_data(nextRecord[0])) + if oauth_token.get_user_signature() is None: + name = DBStore.get_data(nextRecord[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(DBStore.get_data(nextRecord[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(DBStore.get_data(nextRecord[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(DBStore.get_data(nextRecord[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(DBStore.get_data(nextRecord[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(DBStore.get_data(nextRecord[6])) + if oauth_token.get_expires_in() is None: + expiresIn = DBStore.get_data(nextRecord[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(DBStore.get_data(nextRecord[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(DBStore.get_data(nextRecord[9])) + + def save_token(self, token): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + if not isinstance(token, OAuthToken): + return + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name,password=self.__password, port=self.__port_number) + oauthToken = token + query = "update " + self.__table_name + " set " + if oauthToken.get_user_signature() is not None: + name = oauthToken.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + self.set_token(oauthToken) + " where user_name='" + name + "'" + elif oauthToken.get_access_token() is not None and len(oauthToken.get_access_token()) > 0 and \ + self.are_all_objects_null([oauthToken.get_client_id(), oauthToken.get_client_secret()]): + query = query + self.set_token(oauthToken) + " where access_token='" + oauthToken.get_access_token() + "'" + elif ((oauthToken.get_refresh_token() is not None and len(oauthToken.get_refresh_token()) > 0) or + (oauthToken.get_grant_token() is not None and len(oauthToken.get_grant_token()) > 0)) and oauthToken.get_client_id() is not None and oauthToken.get_client_secret() is not None: + if oauthToken.get_grant_token() is not None and len(oauthToken.get_grant_token()) > 0: + query = query + self.set_token(oauthToken) + " where grant_token='" + oauthToken.get_grant_token() + "'" + elif oauthToken.get_refresh_token() is not None and len(oauthToken.get_refresh_token()) > 0: + query = query + self.set_token(oauthToken) + " where refresh_token='" + oauthToken.get_refresh_token() + "'" + query = query + " limit 1" + try: + cursor = connection.cursor() + cursor.execute(query) + if cursor.rowcount <= 0: + if oauthToken.get_id() is not None or oauthToken.get_user_signature() is not None: + if oauthToken.get_refresh_token() is None and oauthToken.get_grant_token() is None and oauthToken.get_access_token() is None: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1) + if oauthToken.get_id() is None: + newId = str(self.generate_id()) + oauthToken.set_id(newId) + query = "insert into " + self.__table_name + " (id,user_name,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url,api_domain) values (%s,%s,%s,%s,%s,%s,%s,%s,%s,%s);" + val = (token.get_id(), token.get_user_signature().get_name() if token.get_user_signature() is not None else None, token.get_client_id(), token.get_client_secret(), token.get_refresh_token(), token.get_access_token(), token.get_grant_token(), token.get_expires_in(), token.get_redirect_url(), token.get_api_domain()) + cursor.execute(query, val) + except Error as e: + raise e + finally: + connection.commit() + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.SAVE_TOKEN_DB_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauthToken): + oauthToken.set_id(None) + oauthToken.set_user_signature(None) + oauthToken.set_client_id(None) + oauthToken.set_client_secret(None) + oauthToken.set_refresh_token(None) + oauthToken.set_access_token(None) + oauthToken.set_grant_token(None) + oauthToken.set_redirect_url(None) + oauthToken.set_expires_in(None) + oauthToken.set_api_domain(None) + + def set_token(self, oauth_token): + query = [] + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query.append(self.set_token_info(Constants.USER_NAME, name)) + if oauth_token.get_api_domain() is not None: + query.append(self.set_token_info(Constants.API_DOMAIN, oauth_token.get_api_domain())) + if oauth_token.get_client_id() is not None: + query.append(self.set_token_info(Constants.CLIENT_ID, oauth_token.get_client_id())) + if oauth_token.get_client_secret() is not None: + query.append(self.set_token_info(Constants.CLIENT_SECRET, oauth_token.get_client_secret())) + if oauth_token.get_refresh_token() is not None: + query.append(self.set_token_info(Constants.REFRESH_TOKEN, oauth_token.get_refresh_token())) + if oauth_token.get_access_token() is not None: + query.append(self.set_token_info(Constants.ACCESS_TOKEN, oauth_token.get_access_token())) + if oauth_token.get_grant_token() is not None: + query.append(self.set_token_info(Constants.GRANT_TOKEN, oauth_token.get_grant_token())) + if oauth_token.get_expires_in() is not None: + query.append(self.set_token_info(Constants.EXPIRY_TIME, oauth_token.get_expires_in())) + if oauth_token.get_redirect_url() is not None: + query.append(self.set_token_info(Constants.REDIRECT_URL, oauth_token.get_redirect_url())) + return str.join(",", query) + + @staticmethod + def set_token_info(key, value): + return key + "='" + value + "'" + + def delete_token(self, id): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + + try: + cursor = connection.cursor() + query = "delete from " + self.__table_name + " where id= " + id + ";" + cursor.execute(query) + connection.commit() + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKEN_DB_ERROR, cause=ex) + + def get_tokens(self): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + tokens = [] + + try: + cursor = connection.cursor() + query = 'select * from ' + self.__table_name + ";" + cursor.execute(query) + results = cursor.fetchall() + + for result in results: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, result) + tokens.append(oauth_token) + + return tokens + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_DB_ERROR, cause=ex) + + def delete_tokens(self): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + + try: + cursor = connection.cursor() + query = 'delete from ' + self.__table_name + ";" + cursor.execute(query) + connection.commit() + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_DB_ERROR, cause=ex) + + def find_token_by_id(self, id): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + try: + query = "select * from " + self.__table_name + " where id='" + id + "'" + oauthToken = object.__new__(OAuthToken) + self.set_oauth_token(oauthToken) + cursor = connection.cursor() + cursor.execute(query) + results = cursor.fetchall() + if results is None or len(results) <= 0: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_DB_ERROR) + for result in results: + self.set_merge_data(oauthToken, result) + return oauthToken + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_BY_ID_DB_ERROR, cause=ex) + + def generate_id(self): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + connection = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + query = "select max(id) as id from " + self.__table_name + ";" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + max1 = result[0] + if max1 is None: + return 1 + else: + return int(max1) + 1 + except Exception as e1: + raise SDKException(Constants.TOKEN_STORE, Constants.GENERATE_TOKEN_ID_ERROR, cause=e1) + finally: + cursor.close() if connection is not None else None + connection.close() if connection is not None else None \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/file_store.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/file_store.py new file mode 100755 index 0000000..8bd3dfd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/file_store.py @@ -0,0 +1,298 @@ +try: + import os + import csv + from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + from ....crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +except Exception as e: + import os + import csv + from .token_store import TokenStore + from ..oauth_token import OAuthToken + from ....crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + + +class FileStore(TokenStore): + """ + The class to store user token details to the file. + """ + + def __init__(self, file_path): + + """ + Creates an FileStore class instance with the specified parameters. + + Parameters: + file_path (str) : A string containing the absolute file path of the file to store tokens + + """ + + self.file_path = file_path + is_create = False + self.headers = [Constants.ID, Constants.USER_NAME, Constants.CLIENT_ID, Constants.CLIENT_SECRET, + Constants.REFRESH_TOKEN, Constants.ACCESS_TOKEN, Constants.GRANT_TOKEN, Constants.EXPIRY_TIME, + Constants.REDIRECT_URI, Constants.API_DOMAIN] + + if (os.path.exists(file_path) and os.stat(file_path).st_size == 0) or not os.path.exists(file_path): + is_create = True + with open(self.file_path, mode='w', newline='') as token_file: + csv_writer = csv.writer(token_file, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + + csv_writer.writerow(self.headers) + if not is_create: + with open(file_path, 'r') as file: + csvReader = csv.reader(file) + allContents = list(csvReader) + headers = allContents[0] + if len(headers) == 9: + allContents = [arr + [''] for arr in allContents] + allContents[0] = self.headers + with open(file_path, 'w', newline='') as file: + csvWriter = csv.writer(file) + csvWriter.writerows(allContents) + + def find_token(self, token): + if not isinstance(token, OAuthToken): + return token + try: + oauth_token = token + is_row_present = False + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=",") + next(data, None) + for next_record in data: + if len(next_record) == 0: + continue + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + return oauth_token + if not is_row_present: + return None + except IOError as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_FILE_ERROR, cause=ex) + finally: + f.close() + + def set_merge_data(self, oauth_token, nextRecord): + if oauth_token.get_id() is None: + oauth_token.set_id(self.get_data(nextRecord[0])) + if oauth_token.get_user_signature() is None: + name = self.get_data(nextRecord[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(self.get_data(nextRecord[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(self.get_data(nextRecord[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(self.get_data(nextRecord[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(self.get_data(nextRecord[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(self.get_data(nextRecord[6])) + if oauth_token.get_expires_in() is None: + expiresIn = self.get_data(nextRecord[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(self.get_data(nextRecord[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(self.get_data(nextRecord[9])) + + def check_condition(self, oauth_token, nextRecord): + is_row_present = False + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + userName = self.get_data(nextRecord[1]) + if name is not None and len(name) > 0 and userName is not None and len(userName) > 0 and name == userName: + is_row_present = True + elif oauth_token.get_access_token() is not None and self.are_all_objects_null( + [oauth_token.get_client_id(), oauth_token.get_client_secret()]): + accessToken = self.get_data(nextRecord[5]) + if accessToken is not None and len(accessToken) > 0 and len( + oauth_token.get_access_token()) > 0 and oauth_token.get_access_token() == accessToken: + is_row_present = True + elif ( + oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + grantToken = self.get_data(nextRecord[6]) + refreshToken = self.get_data(nextRecord[4]) + if grantToken is not None and len(grantToken) > 0 and oauth_token.get_grant_token() is not None and len( + oauth_token.get_grant_token()) > 0 and oauth_token.get_grant_token() == grantToken: + is_row_present = True + elif refreshToken is not None and len( + refreshToken) > 0 and oauth_token.get_refresh_token() is not None and len( + oauth_token.get_refresh_token()) > 0 and oauth_token.get_refresh_token() == refreshToken: + is_row_present = True + return is_row_present + + def save_token(self, token): + if isinstance(token, OAuthToken): + try: + is_row_present = False + all_contents = list() + oauth_token = token + with open(self.file_path, mode="r") as f: + data = csv.reader(f, delimiter=",") + all_contents = list(data) + for next_record in all_contents: + if len(next_record) > 0: + if oauth_token.get_id() is not None: + id = self.get_data(next_record[0]) + if id is not None and oauth_token.get_id() is not None and id == oauth_token.get_id(): + is_row_present= True + + else: + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + i = all_contents.index(next_record) + all_contents[i] = self.set_token(oauth_token) + break + else: + all_contents.remove(next_record) + if not is_row_present: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if ( + oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None): + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_FILE_ERROR1) + if oauth_token.get_id() is None: + newId = self.generate_id(all_contents) + oauth_token.set_id(newId) + all_contents.append(self.set_token(oauth_token)) + with open(self.file_path, mode='w', newline='') as f: + csv_writer = csv.writer(f, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + csv_writer.writerows(all_contents) + except IOError as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.SAVE_TOKEN_FILE_ERROR, cause=ex) + except Exception as error: + raise error + finally: + f.close() + + @staticmethod + def set_token(oauth_token): + data = [] + data.insert(0, oauth_token.get_id()) + data.insert(1, + oauth_token.get_user_signature().get_name() if oauth_token.get_user_signature() is not None else "") + data.insert(2, oauth_token.get_client_id()) + data.insert(3, oauth_token.get_client_secret()) + data.insert(4, oauth_token.get_refresh_token()) + data.insert(5, oauth_token.get_access_token()) + data.insert(6, oauth_token.get_grant_token()) + data.insert(7, oauth_token.get_expires_in()) + data.insert(8, oauth_token.get_redirect_url()) + data.insert(9, oauth_token.get_api_domain()) + return data + + def delete_token(self, id): + try: + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=',') + all_contents = list(data) + for i in range(len(all_contents)): + next_record = all_contents[i] + if len(next_record) > 1: + recordId = self.get_data(next_record[0]) + if recordId is not None and recordId == id: + is_row_present = True + all_contents.pop(i) + break + with open(self.file_path, mode='w') as f: + csv_writer = csv.writer(f, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + csv_writer.writerows(all_contents) + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e2: + raise SDKException(Constants.TOKEN_STORE, Constants.DELETE_TOKENS_FILE_ERROR, cause=e2) + + def get_tokens(self): + tokens = [] + + try: + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=',') + next(data, None) + for next_record in data: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, next_record) + tokens.append(oauth_token) + + return tokens + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_FILE_ERROR, cause=ex) + + def delete_tokens(self): + try: + with open(self.file_path, mode='w') as token_file: + csv_writer = csv.writer(token_file, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + csv_writer.writerow(self.headers) + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_FILE_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def find_token_by_id(self, id): + try: + is_row_present = False + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=',') + all_contents = list(data) + for content in all_contents: + if content[0] == id: + is_row_present = True + self.set_merge_data(oauth_token, content) + return oauth_token + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR, cause=e) + finally: + f.close() + return None + + @staticmethod + def get_data(value): + return value if (value is not None and len(value) > 0) else None + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + @staticmethod + def generate_id(all_contents): + maxValue = 0 + if len(all_contents) > 0: + for i in range(len(all_contents) - 1): + next_record = all_contents[i + 1] + if next_record is not None and len(next_record) > 1 and len(next_record[0]) > 0: + if maxValue < int(next_record[0]): + maxValue = int(next_record[0]) + return str(maxValue + 1) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py new file mode 100755 index 0000000..fe8fdd9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py @@ -0,0 +1,86 @@ +try: + from abc import ABC, abstractmethod + +except Exception as e: + from abc import ABC, abstractmethod + + +class TokenStore(ABC): + + """ + This class is to store user token details. + """ + + @abstractmethod + def find_token(self, token): + + """ + The method to get user token details. + + Parameters: + token (Token) : A Token class instance. + + Returns: + Token : A Token class instance representing the user token details. + """ + + pass + + @abstractmethod + def save_token(self, token): + + """ + The method to store user token details. + + Parameters: + token (Token) : A Token class instance. + + """ + + pass + + @abstractmethod + def delete_token(self, id): + + """ + The method to delete user token details. + + Parameters: + id (String) : A String representing Token id. + """ + + pass + + @abstractmethod + def get_tokens(self): + + """ + The method to retrieve all the stored tokens. + + Returns: + list : A List of Token instances + """ + + pass + + @abstractmethod + def delete_tokens(self): + + """ + The method to delete all the stored tokens. + """ + + pass + @abstractmethod + def find_token_by_id(self, id): + + """ + The method to get id token details. + + Parameters: + id (String) : A String id. + Returns: + Token : A Token class instance representing the id token details. + """ + + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/token.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/token.py new file mode 100755 index 0000000..267b3cc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/authenticator/token.py @@ -0,0 +1,42 @@ +from abc import abstractmethod, ABC + + +class Token(ABC): + + """ + The class to verify and set token to the APIHTTPConnector instance, to authenticate requests. + """ + + @abstractmethod + def authenticate(self, url_connection): + + """ + The method to set token to APIHTTPConnector instance + + Parameters: + url_connection (APIHTTPConnector) : A APIHTTPConnector class instance. + """ + + pass + + @abstractmethod + def remove(self): + + """ + The method to remove the token from store. + + Returns: + bool: A Boolean value representing the removed status. + """ + pass + + @abstractmethod + def generate_token(self): + + """ + The method to generate the Token + + Returns: + oauthToken (OauthToken) : A OauthToken class instance + """ + pass \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/logger/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/logger/__init__.py new file mode 100755 index 0000000..6e84027 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/logger/__init__.py @@ -0,0 +1,2 @@ +from .logger import Logger, SDKLogger + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/api/logger/logger.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/logger/logger.py new file mode 100755 index 0000000..7ae2646 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/api/logger/logger.py @@ -0,0 +1,93 @@ +try: + import logging + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from ...crm.api.util.constants import Constants +except: + from ...crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + + +class Logger(object): + + """ + This class represents the Logger level and the file path. + """ + + def __init__(self, level, file_path=None): + self.__level = level + self.__file_path = file_path + + def get_level(self): + """ + This is a getter method to get __level. + + Returns: + string: A enum representing __level + """ + + return self.__level + + def get_file_path(self): + """ + This is a getter method to get __file_path. + + Returns: + string: A string representing __file_path + """ + + return self.__file_path + + @staticmethod + def get_instance(level, file_path=None): + + """ + Creates an Logger class instance with the specified log level and file path. + :param level: A Levels class instance containing the log level. + :param file_path: A str containing the log file path. + :return: A Logger class instance. + """ + + return Logger(level=level, file_path=file_path) + + import enum + + class Levels(enum.Enum): + + """ + This class represents the possible logger levels + """ + + CRITICAL = logging.CRITICAL + ERROR = logging.ERROR + WARNING = logging.WARNING + INFO = logging.INFO + DEBUG = logging.DEBUG + NOTSET = logging.NOTSET + + +class SDKLogger(object): + + """ + The class to initialize the SDK logger. + """ + + def __init__(self, logger_instance): + + logger = logging.getLogger('SDKLogger') + logger_level = logger_instance.get_level() + logger_file_path = logger_instance.get_file_path() + if logger_level is not None and logger_level != logging.NOTSET and logger_file_path is not None and logger_file_path != "": + file_handler = logging.FileHandler(logger_file_path) + formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(module)s - %(filename)s - %(funcName)s - %(lineno)d - %(message)s') + file_handler.setLevel(logger_level.name) + file_handler.setFormatter(formatter) + logger.addHandler(file_handler) + if logger_level is not None and Constants.LOGGER_LEVELS.__contains__(logger_level.name): + logger.setLevel(logger_level.name) + + @staticmethod + def initialize(logger_instance): + try: + SDKLogger(logger_instance=logger_instance) + except Exception as ex: + raise SDKException(message=Constants.LOGGER_INITIALIZATION_ERROR, cause=ex) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/__init__.py new file mode 100755 index 0000000..9468875 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/__init__.py @@ -0,0 +1 @@ +from . import api \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/__init__.py new file mode 100644 index 0000000..f1e30c0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/__init__.py @@ -0,0 +1,114 @@ +from . import dc +from . import exception +from . import util +from .header import Header +from .header_map import HeaderMap +from .param import Param +from .parameter_map import ParameterMap +from .initializer import Initializer +from .user_signature import UserSignature +from .request_proxy import RequestProxy +from .sdk_config import SDKConfig +from . import coql +from . import users_transfer_delete +from . import user_type_users +from . import associate_email +from . import unsubscribe_links +from . import unblock_email +from . import layouts +from . import variable_groups +from . import webforms +from . import service_preference +from . import bulk_read +from . import shift_hours +from . import pipeline +from . import field_map_dependency +from . import inventory_convert +from . import users_territories +from . import appointment_preference +from . import users_unavailability +from . import fields +from . import blueprint +from . import privacy_preference +from . import taxes +from . import roles +from . import email_related_records +from . import modules +from . import portal_invite +from . import attachments +from . import find_and_merge +from . import global_picklists +from . import timelines +from . import user_groups +from . import contact_roles +from . import entity_scores +from . import conversion_option +from . import scoring_rules +from . import portals +from . import available_currencies +from . import digest +from . import org +from . import mail_merge +from . import fiscal_year +from . import record_locking_configuration +from . import users +from . import mass_change_owner +from . import custom_views +from . import tags +from . import email_templates +from . import files +from . import mass_convert +from . import privacy_configurable_apps +from . import email_compose_meta +from . import templates +from . import definition +from . import territories +from . import email_drafts +from . import cancel_meetings +from . import territory_users +from . import business_hours +from . import portals_meta +from . import email_sharing_details +from . import share_records +from . import inventory_templates +from . import features +from . import from_addresses +from . import wizards +from . import holidays +from . import profiles +from . import send_mail +from . import mass_delete_cvid +from . import deal_contact_roles +from . import currencies +from . import convert_lead +from . import notes +from . import isc_signature +from . import field_attachments +from . import backup +from . import related_lists +from . import inventory_mass_convert +from . import reschedule_history +from . import variables +from . import related_records +from . import record_locking +from . import change_owner +from . import download_inline_images +from . import assignment_rules +from . import notifications +from . import bulk_write +from . import portal_user_type +from . import download_attachments +from . import record +from . import hipaa_compliance +from . import pick_list_values +from . import zia_people_enrichment +from . import functions +from . import apis +from . import duplicate_check_preference +from . import zia_allowed_field_mappings +from . import cadences +from . import zia_enrichment +from . import audit_log_export +from . import cadences_execution +from . import zia_org_enrichment +from . import mass_delete_tags diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/__init__.py new file mode 100644 index 0000000..b34a5bb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/__init__.py @@ -0,0 +1,6 @@ +from .operation_types import OperationTypes +from .api_exception import APIException +from .supported_api import SupportedAPI +from .response_handler import ResponseHandler +from .apis_operations import APIsOperations, GetSupportedAPIParam +from .response_wrapper import ResponseWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/api_exception.py new file mode 100644 index 0000000..5982980 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.apis.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/apis_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/apis_operations.py new file mode 100644 index 0000000..ccc034a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/apis_operations.py @@ -0,0 +1,52 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class APIsOperations(object): + def __init__(self, filters=None): + """ + Creates an instance of ApisOperations with the given parameters + + Parameters: + filters (string) : A string representing the filters + """ + + if filters is not None and not isinstance(filters, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: str', None, None) + + self.__filters = filters + + + def get_supported_api(self): + """ + The method to get supported api + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__apis' + 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('filters', 'com.zoho.crm.api.Apis.GetSupportedAPIParam'), self.__filters) + try: + from zohocrmsdk.src.com.zoho.crm.api.apis.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetSupportedAPIParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/operation_types.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/operation_types.py new file mode 100644 index 0000000..aa1b5a7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/operation_types.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OperationTypes(object): + def __init__(self): + """Creates an instance of OperationTypes""" + + self.__method = None + self.__oauth_scope = None + self.__max_credits = None + self.__min_credits = None + self.__key_modified = dict() + + def get_method(self): + """ + The method to get the method + + Returns: + string: A string representing the method + """ + + return self.__method + + def set_method(self, method): + """ + The method to set the value to method + + Parameters: + method (string) : A string representing the method + """ + + if method is not None and not isinstance(method, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: method EXPECTED TYPE: str', None, None) + + self.__method = method + self.__key_modified['method'] = 1 + + def get_oauth_scope(self): + """ + The method to get the oauth_scope + + Returns: + string: A string representing the oauth_scope + """ + + return self.__oauth_scope + + def set_oauth_scope(self, oauth_scope): + """ + The method to set the value to oauth_scope + + Parameters: + oauth_scope (string) : A string representing the oauth_scope + """ + + if oauth_scope is not None and not isinstance(oauth_scope, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: oauth_scope EXPECTED TYPE: str', None, None) + + self.__oauth_scope = oauth_scope + self.__key_modified['oauth_scope'] = 1 + + def get_max_credits(self): + """ + The method to get the max_credits + + Returns: + int: An int representing the max_credits + """ + + return self.__max_credits + + def set_max_credits(self, max_credits): + """ + The method to set the value to max_credits + + Parameters: + max_credits (int) : An int representing the max_credits + """ + + if max_credits is not None and not isinstance(max_credits, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: max_credits EXPECTED TYPE: int', None, None) + + self.__max_credits = max_credits + self.__key_modified['max_credits'] = 1 + + def get_min_credits(self): + """ + The method to get the min_credits + + Returns: + int: An int representing the min_credits + """ + + return self.__min_credits + + def set_min_credits(self, min_credits): + """ + The method to set the value to min_credits + + Parameters: + min_credits (int) : An int representing the min_credits + """ + + if min_credits is not None and not isinstance(min_credits, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: min_credits EXPECTED TYPE: int', None, None) + + self.__min_credits = min_credits + self.__key_modified['min_credits'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/response_wrapper.py new file mode 100644 index 0000000..3f1732e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.apis.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__apis = None + self.__key_modified = dict() + + def get_apis(self): + """ + The method to get the apis + + Returns: + list: An instance of list + """ + + return self.__apis + + def set_apis(self, apis): + """ + The method to set the value to apis + + Parameters: + apis (list) : An instance of list + """ + + if apis is not None and not isinstance(apis, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: apis EXPECTED TYPE: list', None, None) + + self.__apis = apis + self.__key_modified['__apis'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/supported_api.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/supported_api.py new file mode 100644 index 0000000..abc6302 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/apis/supported_api.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SupportedAPI(object): + def __init__(self): + """Creates an instance of SupportedAPI""" + + self.__path = None + self.__operation_types = None + self.__key_modified = dict() + + def get_path(self): + """ + The method to get the path + + Returns: + string: A string representing the path + """ + + return self.__path + + def set_path(self, path): + """ + The method to set the value to path + + Parameters: + path (string) : A string representing the path + """ + + if path is not None and not isinstance(path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: path EXPECTED TYPE: str', None, None) + + self.__path = path + self.__key_modified['path'] = 1 + + def get_operation_types(self): + """ + The method to get the operation_types + + Returns: + list: An instance of list + """ + + return self.__operation_types + + def set_operation_types(self, operation_types): + """ + The method to set the value to operation_types + + Parameters: + operation_types (list) : An instance of list + """ + + if operation_types is not None and not isinstance(operation_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_types EXPECTED TYPE: list', None, None) + + self.__operation_types = operation_types + self.__key_modified['operation_types'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/__init__.py new file mode 100644 index 0000000..19cf011 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/__init__.py @@ -0,0 +1,14 @@ +from .deal_record_configuration import DealRecordConfiguration +from .action_wrapper import ActionWrapper +from .body_wrapper import BodyWrapper +from .field_mappings import FieldMappings +from .layout import Layout +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .field import Field +from .success_response import SuccessResponse +from .appointment_preference_operations import AppointmentPreferenceOperations, GetAppointmentPreferenceParam +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .appointment_preference import AppointmentPreference diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_wrapper.py new file mode 100644 index 0000000..edd45eb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__appointment_preferences = None + self.__key_modified = dict() + + def get_appointment_preferences(self): + """ + The method to get the appointment_preferences + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__appointment_preferences + + def set_appointment_preferences(self, appointment_preferences): + """ + The method to set the value to appointment_preferences + + Parameters: + appointment_preferences (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if appointment_preferences is not None and not isinstance(appointment_preferences, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: ActionResponse', None, None) + + self.__appointment_preferences = appointment_preferences + self.__key_modified['appointment_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/api_exception.py new file mode 100644 index 0000000..441f282 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference.py new file mode 100644 index 0000000..387b645 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class AppointmentPreference(object): + def __init__(self): + """Creates an instance of AppointmentPreference""" + + self.__show_job_sheet = None + self.__when_duration_exceeds = None + self.__when_appointment_completed = None + self.__allow_booking_outside_service_availability = None + self.__allow_booking_outside_businesshours = None + self.__deal_record_configuration = None + self.__key_modified = dict() + + def get_show_job_sheet(self): + """ + The method to get the show_job_sheet + + Returns: + bool: A bool representing the show_job_sheet + """ + + return self.__show_job_sheet + + def set_show_job_sheet(self, show_job_sheet): + """ + The method to set the value to show_job_sheet + + Parameters: + show_job_sheet (bool) : A bool representing the show_job_sheet + """ + + if show_job_sheet is not None and not isinstance(show_job_sheet, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_job_sheet EXPECTED TYPE: bool', None, None) + + self.__show_job_sheet = show_job_sheet + self.__key_modified['show_job_sheet'] = 1 + + def get_when_duration_exceeds(self): + """ + The method to get the when_duration_exceeds + + Returns: + string: A string representing the when_duration_exceeds + """ + + return self.__when_duration_exceeds + + def set_when_duration_exceeds(self, when_duration_exceeds): + """ + The method to set the value to when_duration_exceeds + + Parameters: + when_duration_exceeds (string) : A string representing the when_duration_exceeds + """ + + if when_duration_exceeds is not None and not isinstance(when_duration_exceeds, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: when_duration_exceeds EXPECTED TYPE: str', None, None) + + self.__when_duration_exceeds = when_duration_exceeds + self.__key_modified['when_duration_exceeds'] = 1 + + def get_when_appointment_completed(self): + """ + The method to get the when_appointment_completed + + Returns: + Choice: An instance of Choice + """ + + return self.__when_appointment_completed + + def set_when_appointment_completed(self, when_appointment_completed): + """ + The method to set the value to when_appointment_completed + + Parameters: + when_appointment_completed (Choice) : An instance of Choice + """ + + if when_appointment_completed is not None and not isinstance(when_appointment_completed, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: when_appointment_completed EXPECTED TYPE: Choice', None, None) + + self.__when_appointment_completed = when_appointment_completed + self.__key_modified['when_appointment_completed'] = 1 + + def get_allow_booking_outside_service_availability(self): + """ + The method to get the allow_booking_outside_service_availability + + Returns: + bool: A bool representing the allow_booking_outside_service_availability + """ + + return self.__allow_booking_outside_service_availability + + def set_allow_booking_outside_service_availability(self, allow_booking_outside_service_availability): + """ + The method to set the value to allow_booking_outside_service_availability + + Parameters: + allow_booking_outside_service_availability (bool) : A bool representing the allow_booking_outside_service_availability + """ + + if allow_booking_outside_service_availability is not None and not isinstance(allow_booking_outside_service_availability, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allow_booking_outside_service_availability EXPECTED TYPE: bool', None, None) + + self.__allow_booking_outside_service_availability = allow_booking_outside_service_availability + self.__key_modified['allow_booking_outside_service_availability'] = 1 + + def get_allow_booking_outside_businesshours(self): + """ + The method to get the allow_booking_outside_businesshours + + Returns: + bool: A bool representing the allow_booking_outside_businesshours + """ + + return self.__allow_booking_outside_businesshours + + def set_allow_booking_outside_businesshours(self, allow_booking_outside_businesshours): + """ + The method to set the value to allow_booking_outside_businesshours + + Parameters: + allow_booking_outside_businesshours (bool) : A bool representing the allow_booking_outside_businesshours + """ + + if allow_booking_outside_businesshours is not None and not isinstance(allow_booking_outside_businesshours, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allow_booking_outside_businesshours EXPECTED TYPE: bool', None, None) + + self.__allow_booking_outside_businesshours = allow_booking_outside_businesshours + self.__key_modified['allow_booking_outside_businesshours'] = 1 + + def get_deal_record_configuration(self): + """ + The method to get the deal_record_configuration + + Returns: + DealRecordConfiguration: An instance of DealRecordConfiguration + """ + + return self.__deal_record_configuration + + def set_deal_record_configuration(self, deal_record_configuration): + """ + The method to set the value to deal_record_configuration + + Parameters: + deal_record_configuration (DealRecordConfiguration) : An instance of DealRecordConfiguration + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.deal_record_configuration import DealRecordConfiguration + except Exception: + from .deal_record_configuration import DealRecordConfiguration + + if deal_record_configuration is not None and not isinstance(deal_record_configuration, DealRecordConfiguration): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal_record_configuration EXPECTED TYPE: DealRecordConfiguration', None, None) + + self.__deal_record_configuration = deal_record_configuration + self.__key_modified['deal_record_configuration'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference_operations.py new file mode 100644 index 0000000..e64470a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference_operations.py @@ -0,0 +1,90 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class AppointmentPreferenceOperations(object): + def __init__(self): + """Creates an instance of AppointmentPreferenceOperations""" + pass + + def get_appointment_preference(self, param_instance=None): + """ + The method to get appointment preference + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/appointment_preferences' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_appointment_preference(self, request): + """ + The method to update appointment preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/appointment_preferences' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAppointmentPreferenceParam(object): + include = Param('include', 'com.zoho.crm.api.AppointmentPreference.GetAppointmentPreferenceParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/body_wrapper.py new file mode 100644 index 0000000..f5e9216 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__appointment_preferences = None + self.__key_modified = dict() + + def get_appointment_preferences(self): + """ + The method to get the appointment_preferences + + Returns: + AppointmentPreference: An instance of AppointmentPreference + """ + + return self.__appointment_preferences + + def set_appointment_preferences(self, appointment_preferences): + """ + The method to set the value to appointment_preferences + + Parameters: + appointment_preferences (AppointmentPreference) : An instance of AppointmentPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.appointment_preference import AppointmentPreference + except Exception: + from .appointment_preference import AppointmentPreference + + if appointment_preferences is not None and not isinstance(appointment_preferences, AppointmentPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: AppointmentPreference', None, None) + + self.__appointment_preferences = appointment_preferences + self.__key_modified['appointment_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/deal_record_configuration.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/deal_record_configuration.py new file mode 100644 index 0000000..c9de7dc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/deal_record_configuration.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DealRecordConfiguration(object): + def __init__(self): + """Creates an instance of DealRecordConfiguration""" + + self.__layout = None + self.__field_mappings = None + self.__id = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_field_mappings(self): + """ + The method to get the field_mappings + + Returns: + list: An instance of list + """ + + return self.__field_mappings + + def set_field_mappings(self, field_mappings): + """ + The method to set the value to field_mappings + + Parameters: + field_mappings (list) : An instance of list + """ + + if field_mappings is not None and not isinstance(field_mappings, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_mappings EXPECTED TYPE: list', None, None) + + self.__field_mappings = field_mappings + self.__key_modified['field_mappings'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field_mappings.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field_mappings.py new file mode 100644 index 0000000..40d9847 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field_mappings.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class FieldMappings(object): + def __init__(self): + """Creates an instance of FieldMappings""" + + self.__type = None + self.__value = None + self.__field = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/layout.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/layout.py new file mode 100644 index 0000000..8d89a2a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_wrapper.py new file mode 100644 index 0000000..5d352e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__appointment_preferences = None + self.__key_modified = dict() + + def get_appointment_preferences(self): + """ + The method to get the appointment_preferences + + Returns: + AppointmentPreference: An instance of AppointmentPreference + """ + + return self.__appointment_preferences + + def set_appointment_preferences(self, appointment_preferences): + """ + The method to set the value to appointment_preferences + + Parameters: + appointment_preferences (AppointmentPreference) : An instance of AppointmentPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.appointment_preference import AppointmentPreference + except Exception: + from .appointment_preference import AppointmentPreference + + if appointment_preferences is not None and not isinstance(appointment_preferences, AppointmentPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: AppointmentPreference', None, None) + + self.__appointment_preferences = appointment_preferences + self.__key_modified['appointment_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/success_response.py new file mode 100644 index 0000000..c97b00f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/__init__.py new file mode 100644 index 0000000..59cb385 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .assignment_rules_operations import AssignmentRulesOperations, GetAssignmentRulesParam, GetAssignmentRuleParam +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .assignment_rules import AssignmentRules +from .default_assignee import DefaultAssignee +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .user import User diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_wrapper.py new file mode 100644 index 0000000..6af9265 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__assignment_rules = None + self.__key_modified = dict() + + def get_assignment_rules(self): + """ + The method to get the assignment_rules + + Returns: + list: An instance of list + """ + + return self.__assignment_rules + + def set_assignment_rules(self, assignment_rules): + """ + The method to set the value to assignment_rules + + Parameters: + assignment_rules (list) : An instance of list + """ + + if assignment_rules is not None and not isinstance(assignment_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment_rules EXPECTED TYPE: list', None, None) + + self.__assignment_rules = assignment_rules + self.__key_modified['assignment_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/api_exception.py new file mode 100644 index 0000000..74c5967 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + + +class APIException(ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules.py new file mode 100644 index 0000000..96c527d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules.py @@ -0,0 +1,323 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignmentRules(object): + def __init__(self): + """Creates an instance of AssignmentRules""" + + self.__created_time = None + self.__modified_time = None + self.__default_assignee = None + self.__api_name = None + self.__modified_by = None + self.__created_by = None + self.__id = None + self.__name = None + self.__module = None + self.__description = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_default_assignee(self): + """ + The method to get the default_assignee + + Returns: + DefaultAssignee: An instance of DefaultAssignee + """ + + return self.__default_assignee + + def set_default_assignee(self, default_assignee): + """ + The method to set the value to default_assignee + + Parameters: + default_assignee (DefaultAssignee) : An instance of DefaultAssignee + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.default_assignee import DefaultAssignee + except Exception: + from .default_assignee import DefaultAssignee + + if default_assignee is not None and not isinstance(default_assignee, DefaultAssignee): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_assignee EXPECTED TYPE: DefaultAssignee', None, None) + + self.__default_assignee = default_assignee + self.__key_modified['default_assignee'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.py new file mode 100644 index 0000000..074a673 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.py @@ -0,0 +1,97 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class AssignmentRulesOperations(object): + def __init__(self): + """Creates an instance of AssignmentRulesOperations""" + pass + + def get_assignment_rules(self, param_instance=None): + """ + The method to get assignment rules + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/automation/assignment_rules' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_assignment_rule(self, id, param_instance=None): + """ + The method to get assignment rule + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/automation/assignment_rules/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetAssignmentRulesParam(object): + module = Param('module', 'com.zoho.crm.api.AssignmentRules.GetAssignmentRulesParam') + + +class GetAssignmentRuleParam(object): + module = Param('module', 'com.zoho.crm.api.AssignmentRules.GetAssignmentRuleParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/default_assignee.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/default_assignee.py new file mode 100644 index 0000000..352625d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/default_assignee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultAssignee(object): + def __init__(self): + """Creates an instance of DefaultAssignee""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_wrapper.py new file mode 100644 index 0000000..9c01b48 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__assignment_rules = None + self.__key_modified = dict() + + def get_assignment_rules(self): + """ + The method to get the assignment_rules + + Returns: + list: An instance of list + """ + + return self.__assignment_rules + + def set_assignment_rules(self, assignment_rules): + """ + The method to set the value to assignment_rules + + Parameters: + assignment_rules (list) : An instance of list + """ + + if assignment_rules is not None and not isinstance(assignment_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment_rules EXPECTED TYPE: list', None, None) + + self.__assignment_rules = assignment_rules + self.__key_modified['assignment_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/success_response.py new file mode 100644 index 0000000..dd37766 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/user.py new file mode 100644 index 0000000..7a43185 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/user.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..users import MinifiedUser + + +class User(MinifiedUser): + def __init__(self): + """Creates an instance of User""" + super().__init__() + + self.__zuid = None + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + int: An int representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (int) : An int representing the zuid + """ + + if zuid is not None and not isinstance(zuid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: int', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/__init__.py new file mode 100644 index 0000000..5d95c89 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/__init__.py @@ -0,0 +1,15 @@ +from .action_wrapper import ActionWrapper +from .attachments import Attachments +from .available import Available +from .body_wrapper import BodyWrapper +from .module_map import ModuleMap +from .api_exception import APIException +from .associate_email_operations import AssociateEmailOperations +from .linked_record import LinkedRecord +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .record import Record +from .associate_email import AssociateEmail +from .action_handler import ActionHandler +from .from1 import From +from .to import To diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_wrapper.py new file mode 100644 index 0000000..6a20921 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__emails = None + self.__key_modified = dict() + + def get_emails(self): + """ + The method to get the emails + + Returns: + list: An instance of list + """ + + return self.__emails + + def set_emails(self, emails): + """ + The method to set the value to emails + + Parameters: + emails (list) : An instance of list + """ + + if emails is not None and not isinstance(emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emails EXPECTED TYPE: list', None, None) + + self.__emails = emails + self.__key_modified['Emails'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/api_exception.py new file mode 100644 index 0000000..4a880de --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email.py new file mode 100644 index 0000000..72bd267 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email.py @@ -0,0 +1,361 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class AssociateEmail(object): + def __init__(self): + """Creates an instance of AssociateEmail""" + + self.__from_1 = None + self.__to = None + self.__cc = None + self.__bcc = None + self.__attachments = None + self.__content = None + self.__mail_format = None + self.__subject = None + self.__original_message_id = None + self.__sent = None + self.__date_time = None + self.__linked_record = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + From: An instance of From + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (From) : An instance of From + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.from1 import From + except Exception: + from .from1 import From + + if from_1 is not None and not isinstance(from_1, From): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: From', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_bcc(self): + """ + The method to get the bcc + + Returns: + list: An instance of list + """ + + return self.__bcc + + def set_bcc(self, bcc): + """ + The method to set the value to bcc + + Parameters: + bcc (list) : An instance of list + """ + + if bcc is not None and not isinstance(bcc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc EXPECTED TYPE: list', None, None) + + self.__bcc = bcc + self.__key_modified['bcc'] = 1 + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_mail_format(self): + """ + The method to get the mail_format + + Returns: + Choice: An instance of Choice + """ + + return self.__mail_format + + def set_mail_format(self, mail_format): + """ + The method to set the value to mail_format + + Parameters: + mail_format (Choice) : An instance of Choice + """ + + if mail_format is not None and not isinstance(mail_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_format EXPECTED TYPE: Choice', None, None) + + self.__mail_format = mail_format + self.__key_modified['mail_format'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_original_message_id(self): + """ + The method to get the original_message_id + + Returns: + string: A string representing the original_message_id + """ + + return self.__original_message_id + + def set_original_message_id(self, original_message_id): + """ + The method to set the value to original_message_id + + Parameters: + original_message_id (string) : A string representing the original_message_id + """ + + if original_message_id is not None and not isinstance(original_message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: original_message_id EXPECTED TYPE: str', None, None) + + self.__original_message_id = original_message_id + self.__key_modified['original_message_id'] = 1 + + def get_sent(self): + """ + The method to get the sent + + Returns: + bool: A bool representing the sent + """ + + return self.__sent + + def set_sent(self, sent): + """ + The method to set the value to sent + + Parameters: + sent (bool) : A bool representing the sent + """ + + if sent is not None and not isinstance(sent, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent EXPECTED TYPE: bool', None, None) + + self.__sent = sent + self.__key_modified['sent'] = 1 + + def get_date_time(self): + """ + The method to get the date_time + + Returns: + datetime: An instance of datetime + """ + + return self.__date_time + + def set_date_time(self, date_time): + """ + The method to set the value to date_time + + Parameters: + date_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if date_time is not None and not isinstance(date_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date_time EXPECTED TYPE: datetime', None, None) + + self.__date_time = date_time + self.__key_modified['date_time'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email_operations.py new file mode 100644 index 0000000..2601bfb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email_operations.py @@ -0,0 +1,61 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class AssociateEmailOperations(object): + def __init__(self): + """Creates an instance of AssociateEmailOperations""" + pass + + def associate(self, recordid, module, request): + """ + The method to associate + + Parameters: + recordid (int) : An int representing the recordid + module (string) : A string representing the module + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(recordid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recordid EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(recordid) + api_path = api_path + '/actions/associate_email' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/attachments.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/attachments.py new file mode 100644 index 0000000..ef5d1a9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/attachments.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachments(object): + def __init__(self): + """Creates an instance of Attachments""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/available.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/available.py new file mode 100644 index 0000000..8084bad --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/available.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Available(object): + def __init__(self): + """Creates an instance of Available""" + + self.__available = None + self.__record = None + self.__linked_record = None + self.__key_modified = dict() + + def get_available(self): + """ + The method to get the available + + Returns: + bool: A bool representing the available + """ + + return self.__available + + def set_available(self, available): + """ + The method to set the value to available + + Parameters: + available (bool) : A bool representing the available + """ + + if available is not None and not isinstance(available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available EXPECTED TYPE: bool', None, None) + + self.__available = available + self.__key_modified['available'] = 1 + + def get_record(self): + """ + The method to get the record + + Returns: + Record: An instance of Record + """ + + return self.__record + + def set_record(self, record): + """ + The method to set the value to record + + Parameters: + record (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.record import Record + except Exception: + from .record import Record + + if record is not None and not isinstance(record, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: Record', None, None) + + self.__record = record + self.__key_modified['record'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/body_wrapper.py new file mode 100644 index 0000000..99f093d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__emails = None + self.__key_modified = dict() + + def get_emails(self): + """ + The method to get the emails + + Returns: + list: An instance of list + """ + + return self.__emails + + def set_emails(self, emails): + """ + The method to set the value to emails + + Parameters: + emails (list) : An instance of list + """ + + if emails is not None and not isinstance(emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emails EXPECTED TYPE: list', None, None) + + self.__emails = emails + self.__key_modified['Emails'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/from1.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/from1.py new file mode 100644 index 0000000..9999b7b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/from1.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class From(object): + def __init__(self): + """Creates an instance of From""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/linked_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/linked_record.py new file mode 100644 index 0000000..1896540 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/linked_record.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedRecord(object): + def __init__(self): + """Creates an instance of LinkedRecord""" + + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/module_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/module_map.py new file mode 100644 index 0000000..cec4563 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/module_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleMap(object): + def __init__(self): + """Creates an instance of ModuleMap""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/record.py new file mode 100644 index 0000000..a0c8ca2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/record.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__module = None + self.__id = None + self.__linked_record = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/success_response.py new file mode 100644 index 0000000..f0960c0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/to.py new file mode 100644 index 0000000..dbe309e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/associate_email/to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class To(object): + def __init__(self): + """Creates an instance of To""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/__init__.py new file mode 100644 index 0000000..70487ee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/__init__.py @@ -0,0 +1,13 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .attachments_operations import AttachmentsOperations, GetAttachmentsParam, UploadUrlAttachmentsParam, DeleteAttachmentsParam +from .attachment import Attachment +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .parent_id import ParentId +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_wrapper.py new file mode 100644 index 0000000..c20da36 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/api_exception.py new file mode 100644 index 0000000..f677437 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/attachment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/attachment.py new file mode 100644 index 0000000..3cd9cae --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/attachment.py @@ -0,0 +1,498 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachment(object): + def __init__(self): + """Creates an instance of Attachment""" + + self.__owner = None + self.__modified_by = None + self.__created_by = None + self.__parent_id = None + self.__sharing_permission = None + self.__attachment_type = None + self.__id = None + self.__modified_time = None + self.__created_time = None + self.__file_name = None + self.__size = None + self.__editable = None + self.__file_id = None + self.__type = None + self.__se_module = None + self.__state = None + self.__link_url = None + self.__key_modified = dict() + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['Owner'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['Modified_By'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['Created_By'] = 1 + + def get_parent_id(self): + """ + The method to get the parent_id + + Returns: + ParentId: An instance of ParentId + """ + + return self.__parent_id + + def set_parent_id(self, parent_id): + """ + The method to set the value to parent_id + + Parameters: + parent_id (ParentId) : An instance of ParentId + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.parent_id import ParentId + except Exception: + from .parent_id import ParentId + + if parent_id is not None and not isinstance(parent_id, ParentId): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: ParentId', None, None) + + self.__parent_id = parent_id + self.__key_modified['Parent_Id'] = 1 + + def get_sharing_permission(self): + """ + The method to get the sharing_permission + + Returns: + string: A string representing the sharing_permission + """ + + return self.__sharing_permission + + def set_sharing_permission(self, sharing_permission): + """ + The method to set the value to sharing_permission + + Parameters: + sharing_permission (string) : A string representing the sharing_permission + """ + + if sharing_permission is not None and not isinstance(sharing_permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: str', None, None) + + self.__sharing_permission = sharing_permission + self.__key_modified['$sharing_permission'] = 1 + + def get_attachment_type(self): + """ + The method to get the attachment_type + + Returns: + int: An int representing the attachment_type + """ + + return self.__attachment_type + + def set_attachment_type(self, attachment_type): + """ + The method to set the value to attachment_type + + Parameters: + attachment_type (int) : An int representing the attachment_type + """ + + if attachment_type is not None and not isinstance(attachment_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_type EXPECTED TYPE: int', None, None) + + self.__attachment_type = attachment_type + self.__key_modified['$attachment_type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['Created_Time'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['File_Name'] = 1 + + def get_size(self): + """ + The method to get the size + + Returns: + string: A string representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (string) : A string representing the size + """ + + if size is not None and not isinstance(size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: str', None, None) + + self.__size = size + self.__key_modified['Size'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['$editable'] = 1 + + def get_file_id(self): + """ + The method to get the file_id + + Returns: + string: A string representing the file_id + """ + + return self.__file_id + + def set_file_id(self, file_id): + """ + The method to set the value to file_id + + Parameters: + file_id (string) : A string representing the file_id + """ + + if file_id is not None and not isinstance(file_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: str', None, None) + + self.__file_id = file_id + self.__key_modified['$file_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['$type'] = 1 + + def get_se_module(self): + """ + The method to get the se_module + + Returns: + string: A string representing the se_module + """ + + return self.__se_module + + def set_se_module(self, se_module): + """ + The method to set the value to se_module + + Parameters: + se_module (string) : A string representing the se_module + """ + + if se_module is not None and not isinstance(se_module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: se_module EXPECTED TYPE: str', None, None) + + self.__se_module = se_module + self.__key_modified['$se_module'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['$state'] = 1 + + def get_link_url(self): + """ + The method to get the link_url + + Returns: + string: A string representing the link_url + """ + + return self.__link_url + + def set_link_url(self, link_url): + """ + The method to set the value to link_url + + Parameters: + link_url (string) : A string representing the link_url + """ + + if link_url is not None and not isinstance(link_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: link_url EXPECTED TYPE: str', None, None) + + self.__link_url = link_url + self.__key_modified['$link_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/attachments_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/attachments_operations.py new file mode 100644 index 0000000..0380ca3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/attachments_operations.py @@ -0,0 +1,304 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class AttachmentsOperations(object): + def __init__(self): + """Creates an instance of AttachmentsOperations""" + pass + + def upload_attachments(self, record_id, module, request): + """ + The method to upload attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + request (FileBodyWrapper) : An instance of FileBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_attachments(self, record_id, module, param_instance=None): + """ + The method to get attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def upload_url_attachments(self, record_id, module, param_instance=None): + """ + The method to upload url attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_attachments(self, record_id, module, param_instance=None): + """ + The method to delete attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_attachment(self, id, record_id, module): + """ + The method to get attachment + + Parameters: + id (int) : An int representing the id + record_id (int) : An int representing the record_id + module (string) : A string representing the module + + 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) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'image/png') + + def delete_attachment(self, id, record_id, module): + """ + The method to delete attachment + + Parameters: + id (int) : An int representing the id + record_id (int) : An int representing the record_id + module (string) : A string representing the module + + 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) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAttachmentsParam(object): + fields = Param('fields', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + ids = Param('ids', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + page = Param('page', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + per_page = Param('per_page', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + + +class UploadUrlAttachmentsParam(object): + attachmenturl = Param('attachmentUrl', 'com.zoho.crm.api.Attachments.UploadUrlAttachmentsParam') + title = Param('title', 'com.zoho.crm.api.Attachments.UploadUrlAttachmentsParam') + + +class DeleteAttachmentsParam(object): + ids = Param('ids', 'com.zoho.crm.api.Attachments.DeleteAttachmentsParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/file_body_wrapper.py new file mode 100644 index 0000000..04e7acb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/owner.py new file mode 100644 index 0000000..7c91803 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/owner.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__name = None + self.__email = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/parent_id.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/parent_id.py new file mode 100644 index 0000000..37fb995 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/parent_id.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ParentId(object): + def __init__(self): + """Creates an instance of ParentId""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/response_wrapper.py new file mode 100644 index 0000000..5f260d2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/success_response.py new file mode 100644 index 0000000..b461632 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/attachments/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/__init__.py new file mode 100644 index 0000000..3e42284 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .criteria import Criteria +from .module import Module +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .audit_log_export_operations import AuditLogExportOperations +from .field import Field +from .success_response import SuccessResponse +from .audit_log_export import AuditLogExport +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .user import User diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_wrapper.py new file mode 100644 index 0000000..2f30e4a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__audit_log_export = None + self.__key_modified = dict() + + def get_audit_log_export(self): + """ + The method to get the audit_log_export + + Returns: + list: An instance of list + """ + + return self.__audit_log_export + + def set_audit_log_export(self, audit_log_export): + """ + The method to set the value to audit_log_export + + Parameters: + audit_log_export (list) : An instance of list + """ + + if audit_log_export is not None and not isinstance(audit_log_export, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audit_log_export EXPECTED TYPE: list', None, None) + + self.__audit_log_export = audit_log_export + self.__key_modified['audit_log_export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/api_exception.py new file mode 100644 index 0000000..08d2ff2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export.py new file mode 100644 index 0000000..bbfa26b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export.py @@ -0,0 +1,265 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AuditLogExport(object): + def __init__(self): + """Creates an instance of AuditLogExport""" + + self.__criteria = None + self.__id = None + self.__status = None + self.__created_by = None + self.__download_links = None + self.__job_start_time = None + self.__job_end_time = None + self.__expiry_date = None + self.__key_modified = dict() + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_download_links(self): + """ + The method to get the download_links + + Returns: + list: An instance of list + """ + + return self.__download_links + + def set_download_links(self, download_links): + """ + The method to set the value to download_links + + Parameters: + download_links (list) : An instance of list + """ + + if download_links is not None and not isinstance(download_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_links EXPECTED TYPE: list', None, None) + + self.__download_links = download_links + self.__key_modified['download_links'] = 1 + + def get_job_start_time(self): + """ + The method to get the job_start_time + + Returns: + datetime: An instance of datetime + """ + + return self.__job_start_time + + def set_job_start_time(self, job_start_time): + """ + The method to set the value to job_start_time + + Parameters: + job_start_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if job_start_time is not None and not isinstance(job_start_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_start_time EXPECTED TYPE: datetime', None, None) + + self.__job_start_time = job_start_time + self.__key_modified['job_start_time'] = 1 + + def get_job_end_time(self): + """ + The method to get the job_end_time + + Returns: + datetime: An instance of datetime + """ + + return self.__job_end_time + + def set_job_end_time(self, job_end_time): + """ + The method to set the value to job_end_time + + Parameters: + job_end_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if job_end_time is not None and not isinstance(job_end_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_end_time EXPECTED TYPE: datetime', None, None) + + self.__job_end_time = job_end_time + self.__key_modified['job_end_time'] = 1 + + def get_expiry_date(self): + """ + The method to get the expiry_date + + Returns: + datetime: An instance of datetime + """ + + return self.__expiry_date + + def set_expiry_date(self, expiry_date): + """ + The method to set the value to expiry_date + + Parameters: + expiry_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if expiry_date is not None and not isinstance(expiry_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expiry_date EXPECTED TYPE: datetime', None, None) + + self.__expiry_date = expiry_date + self.__key_modified['expiry_date'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export_operations.py new file mode 100644 index 0000000..af6838b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export_operations.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class AuditLogExportOperations(object): + def __init__(self): + """Creates an instance of AuditLogExportOperations""" + pass + + def create_auditlog_export(self, request): + """ + The method to create auditlog export + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/audit_log_export' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_exported_auditlogs(self): + """ + The method to get exported auditlogs + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/audit_log_export' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_exported_auditlog(self, id): + """ + The method to get exported auditlog + + 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/v7/settings/audit_log_export/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/body_wrapper.py new file mode 100644 index 0000000..cd82ffa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__audit_log_export = None + self.__key_modified = dict() + + def get_audit_log_export(self): + """ + The method to get the audit_log_export + + Returns: + list: An instance of list + """ + + return self.__audit_log_export + + def set_audit_log_export(self, audit_log_export): + """ + The method to set the value to audit_log_export + + Parameters: + audit_log_export (list) : An instance of list + """ + + if audit_log_export is not None and not isinstance(audit_log_export, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audit_log_export EXPECTED TYPE: list', None, None) + + self.__audit_log_export = audit_log_export + self.__key_modified['audit_log_export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/criteria.py new file mode 100644 index 0000000..dedc9b0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__field = None + self.__comparator = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/field.py new file mode 100644 index 0000000..0ad50d5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/field.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/module.py new file mode 100644 index 0000000..93604c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_wrapper.py new file mode 100644 index 0000000..042cacf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__audit_log_export = None + self.__key_modified = dict() + + def get_audit_log_export(self): + """ + The method to get the audit_log_export + + Returns: + list: An instance of list + """ + + return self.__audit_log_export + + def set_audit_log_export(self, audit_log_export): + """ + The method to set the value to audit_log_export + + Parameters: + audit_log_export (list) : An instance of list + """ + + if audit_log_export is not None and not isinstance(audit_log_export, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audit_log_export EXPECTED TYPE: list', None, None) + + self.__audit_log_export = audit_log_export + self.__key_modified['audit_log_export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/success_response.py new file mode 100644 index 0000000..4e782f0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/__init__.py new file mode 100644 index 0000000..d05bd41 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/__init__.py @@ -0,0 +1,5 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .available_currencies_operations import AvailableCurrenciesOperations +from .response_wrapper import ResponseWrapper +from .currency import Currency diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/api_exception.py new file mode 100644 index 0000000..858c618 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.available_currencies.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/available_currencies_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/available_currencies_operations.py new file mode 100644 index 0000000..10c6175 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/available_currencies_operations.py @@ -0,0 +1,35 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class AvailableCurrenciesOperations(object): + def __init__(self): + """Creates an instance of AvailableCurrenciesOperations""" + pass + + def get_available_currencies(self): + """ + The method to get available currencies + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies/actions/available_currencies' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.available_currencies.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/currency.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/currency.py new file mode 100644 index 0000000..a23a795 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/currency.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__display_value = None + self.__decimal_separator = None + self.__symbol = None + self.__thousand_separator = None + self.__display_name = None + self.__iso_code = None + self.__decimal_places = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_decimal_separator(self): + """ + The method to get the decimal_separator + + Returns: + string: A string representing the decimal_separator + """ + + return self.__decimal_separator + + 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.__decimal_separator = decimal_separator + self.__key_modified['decimal_separator'] = 1 + + def get_symbol(self): + """ + The method to get the symbol + + Returns: + string: A string representing the symbol + """ + + return self.__symbol + + def set_symbol(self, symbol): + """ + The method to set the value to symbol + + Parameters: + symbol (string) : A string representing the symbol + """ + + if symbol is not None and not isinstance(symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: str', None, None) + + self.__symbol = symbol + self.__key_modified['symbol'] = 1 + + def get_thousand_separator(self): + """ + The method to get the thousand_separator + + Returns: + string: A string representing the thousand_separator + """ + + return self.__thousand_separator + + def set_thousand_separator(self, thousand_separator): + """ + The method to set the value to thousand_separator + + Parameters: + thousand_separator (string) : A string representing the thousand_separator + """ + + if thousand_separator is not None and not isinstance(thousand_separator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: thousand_separator EXPECTED TYPE: str', None, None) + + self.__thousand_separator = thousand_separator + self.__key_modified['thousand_separator'] = 1 + + def get_display_name(self): + """ + The method to get the display_name + + Returns: + string: A string representing the display_name + """ + + return self.__display_name + + def set_display_name(self, display_name): + """ + The method to set the value to display_name + + Parameters: + display_name (string) : A string representing the display_name + """ + + if display_name is not None and not isinstance(display_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_name EXPECTED TYPE: str', None, None) + + self.__display_name = display_name + self.__key_modified['display_name'] = 1 + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_decimal_places(self): + """ + The method to get the decimal_places + + Returns: + string: A string representing the decimal_places + """ + + return self.__decimal_places + + def set_decimal_places(self, decimal_places): + """ + The method to set the value to decimal_places + + Parameters: + decimal_places (string) : A string representing the decimal_places + """ + + if decimal_places is not None and not isinstance(decimal_places, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_places EXPECTED TYPE: str', None, None) + + self.__decimal_places = decimal_places + self.__key_modified['decimal_places'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_wrapper.py new file mode 100644 index 0000000..3407f48 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.available_currencies.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__available_currencies = None + self.__key_modified = dict() + + def get_available_currencies(self): + """ + The method to get the available_currencies + + Returns: + list: An instance of list + """ + + return self.__available_currencies + + def set_available_currencies(self, available_currencies): + """ + The method to set the value to available_currencies + + Parameters: + available_currencies (list) : An instance of list + """ + + if available_currencies is not None and not isinstance(available_currencies, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_currencies EXPECTED TYPE: list', None, None) + + self.__available_currencies = available_currencies + self.__key_modified['available_currencies'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/__init__.py new file mode 100644 index 0000000..1b07848 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/__init__.py @@ -0,0 +1,17 @@ +from .action_wrapper import ActionWrapper +from .requester import Requester +from .backup import Backup +from .body_wrapper import BodyWrapper +from .history import History +from .api_exception import APIException +from .response_handler import ResponseHandler +from .urls_wrapper import UrlsWrapper +from .action_response import ActionResponse +from .urls import Urls +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .backup_operations import BackupOperations, HISTORYParam +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .history_wrapper import HistoryWrapper +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_wrapper.py new file mode 100644 index 0000000..0250ae9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__backup = None + self.__key_modified = dict() + + def get_backup(self): + """ + The method to get the backup + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__backup + + def set_backup(self, backup): + """ + The method to set the value to backup + + Parameters: + backup (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if backup is not None and not isinstance(backup, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: backup EXPECTED TYPE: ActionResponse', None, None) + + self.__backup = backup + self.__key_modified['backup'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/api_exception.py new file mode 100644 index 0000000..b86df08 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/backup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/backup.py new file mode 100644 index 0000000..eca6bae --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/backup.py @@ -0,0 +1,208 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Backup(object): + def __init__(self): + """Creates an instance of Backup""" + + self.__rrule = None + self.__id = None + self.__start_date = None + self.__scheduled_date = None + self.__status = None + self.__requester = None + self.__key_modified = dict() + + def get_rrule(self): + """ + The method to get the rrule + + Returns: + string: A string representing the rrule + """ + + return self.__rrule + + def set_rrule(self, rrule): + """ + The method to set the value to rrule + + Parameters: + rrule (string) : A string representing the rrule + """ + + if rrule is not None and not isinstance(rrule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rrule EXPECTED TYPE: str', None, None) + + self.__rrule = rrule + self.__key_modified['rrule'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_start_date(self): + """ + The method to get the start_date + + Returns: + datetime: An instance of datetime + """ + + return self.__start_date + + def set_start_date(self, start_date): + """ + The method to set the value to start_date + + Parameters: + start_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if start_date is not None and not isinstance(start_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_date EXPECTED TYPE: datetime', None, None) + + self.__start_date = start_date + self.__key_modified['start_date'] = 1 + + def get_scheduled_date(self): + """ + The method to get the scheduled_date + + Returns: + datetime: An instance of datetime + """ + + return self.__scheduled_date + + def set_scheduled_date(self, scheduled_date): + """ + The method to set the value to scheduled_date + + Parameters: + scheduled_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if scheduled_date is not None and not isinstance(scheduled_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduled_date EXPECTED TYPE: datetime', None, None) + + self.__scheduled_date = scheduled_date + self.__key_modified['scheduled_date'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_requester(self): + """ + The method to get the requester + + Returns: + Requester: An instance of Requester + """ + + return self.__requester + + def set_requester(self, requester): + """ + The method to set the value to requester + + Parameters: + requester (Requester) : An instance of Requester + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.requester import Requester + except Exception: + from .requester import Requester + + if requester is not None and not isinstance(requester, Requester): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: requester EXPECTED TYPE: Requester', None, None) + + self.__requester = requester + self.__key_modified['requester'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/backup_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/backup_operations.py new file mode 100644 index 0000000..1bcbf31 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/backup_operations.py @@ -0,0 +1,198 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class BackupOperations(object): + def __init__(self): + """Creates an instance of BackupOperations""" + pass + + def schedule(self, request): + """ + The method to schedule + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/bulk/v7/backup' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_details(self): + """ + The method to get details + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/backup' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_urls(self): + """ + The method to get urls + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/backup/urls' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def history(self, param_instance=None): + """ + The method to history + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/bulk/v7/backup/history' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def cancel(self, id): + """ + The method to cancel + + 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/bulk/v7/backup/' + api_path = api_path + str(id) + api_path = api_path + '/actions/cancel' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def download_backed_up_data(self, download_url): + """ + The method to download backed up data + + Parameters: + download_url (string) : A string representing the download_url + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(download_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_url EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/' + api_path = api_path + str(download_url) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/octet-stream') + + +class HISTORYParam(object): + page = Param('page', 'com.zoho.crm.api.Backup.HISTORYParam') + per_page = Param('per_page', 'com.zoho.crm.api.Backup.HISTORYParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/body_wrapper.py new file mode 100644 index 0000000..d0a494d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__backup = None + self.__key_modified = dict() + + def get_backup(self): + """ + The method to get the backup + + Returns: + Backup: An instance of Backup + """ + + return self.__backup + + def set_backup(self, backup): + """ + The method to set the value to backup + + Parameters: + backup (Backup) : An instance of Backup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.backup import Backup + except Exception: + from .backup import Backup + + if backup is not None and not isinstance(backup, Backup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: backup EXPECTED TYPE: Backup', None, None) + + self.__backup = backup + self.__key_modified['backup'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/file_body_wrapper.py new file mode 100644 index 0000000..3f1f589 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/history.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/history.py new file mode 100644 index 0000000..a14fe2c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/history.py @@ -0,0 +1,256 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class History(object): + def __init__(self): + """Creates an instance of History""" + + self.__id = None + self.__log_time = None + self.__action = None + self.__repeat_type = None + self.__count = None + self.__file_name = None + self.__state = None + self.__done_by = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_log_time(self): + """ + The method to get the log_time + + Returns: + datetime: An instance of datetime + """ + + return self.__log_time + + def set_log_time(self, log_time): + """ + The method to set the value to log_time + + Parameters: + log_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if log_time is not None and not isinstance(log_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: log_time EXPECTED TYPE: datetime', None, None) + + self.__log_time = log_time + self.__key_modified['log_time'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + string: A string representing the action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (string) : A string representing the action + """ + + if action is not None and not isinstance(action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: str', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_repeat_type(self): + """ + The method to get the repeat_type + + Returns: + string: A string representing the repeat_type + """ + + return self.__repeat_type + + def set_repeat_type(self, repeat_type): + """ + The method to set the value to repeat_type + + Parameters: + repeat_type (string) : A string representing the repeat_type + """ + + if repeat_type is not None and not isinstance(repeat_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: repeat_type EXPECTED TYPE: str', None, None) + + self.__repeat_type = repeat_type + self.__key_modified['repeat_type'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_done_by(self): + """ + The method to get the done_by + + Returns: + Requester: An instance of Requester + """ + + return self.__done_by + + def set_done_by(self, done_by): + """ + The method to set the value to done_by + + Parameters: + done_by (Requester) : An instance of Requester + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.requester import Requester + except Exception: + from .requester import Requester + + if done_by is not None and not isinstance(done_by, Requester): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: done_by EXPECTED TYPE: Requester', None, None) + + self.__done_by = done_by + self.__key_modified['done_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/history_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/history_wrapper.py new file mode 100644 index 0000000..b727eda --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/history_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class HistoryWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of HistoryWrapper""" + super().__init__() + + self.__history = None + self.__info = None + self.__key_modified = dict() + + def get_history(self): + """ + The method to get the history + + Returns: + list: An instance of list + """ + + return self.__history + + def set_history(self, history): + """ + The method to set the value to history + + Parameters: + history (list) : An instance of list + """ + + if history is not None and not isinstance(history, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history EXPECTED TYPE: list', None, None) + + self.__history = history + self.__key_modified['history'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/requester.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/requester.py new file mode 100644 index 0000000..0e2d9a7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/requester.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Requester(object): + def __init__(self): + """Creates an instance of Requester""" + + self.__id = None + self.__name = None + self.__zuid = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/response_wrapper.py new file mode 100644 index 0000000..97ed619 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__backup = None + self.__key_modified = dict() + + def get_backup(self): + """ + The method to get the backup + + Returns: + Backup: An instance of Backup + """ + + return self.__backup + + def set_backup(self, backup): + """ + The method to set the value to backup + + Parameters: + backup (Backup) : An instance of Backup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.backup import Backup + except Exception: + from .backup import Backup + + if backup is not None and not isinstance(backup, Backup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: backup EXPECTED TYPE: Backup', None, None) + + self.__backup = backup + self.__key_modified['backup'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/success_response.py new file mode 100644 index 0000000..5405fcb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/urls.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/urls.py new file mode 100644 index 0000000..510c7fa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/urls.py @@ -0,0 +1,126 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Urls(object): + def __init__(self): + """Creates an instance of Urls""" + + self.__data_links = None + self.__attachment_links = None + self.__expiry_date = None + self.__key_modified = dict() + + def get_data_links(self): + """ + The method to get the data_links + + Returns: + list: An instance of list + """ + + return self.__data_links + + def set_data_links(self, data_links): + """ + The method to set the value to data_links + + Parameters: + data_links (list) : An instance of list + """ + + if data_links is not None and not isinstance(data_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_links EXPECTED TYPE: list', None, None) + + self.__data_links = data_links + self.__key_modified['data_links'] = 1 + + def get_attachment_links(self): + """ + The method to get the attachment_links + + Returns: + list: An instance of list + """ + + return self.__attachment_links + + def set_attachment_links(self, attachment_links): + """ + The method to set the value to attachment_links + + Parameters: + attachment_links (list) : An instance of list + """ + + if attachment_links is not None and not isinstance(attachment_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_links EXPECTED TYPE: list', None, None) + + self.__attachment_links = attachment_links + self.__key_modified['attachment_links'] = 1 + + def get_expiry_date(self): + """ + The method to get the expiry_date + + Returns: + datetime: An instance of datetime + """ + + return self.__expiry_date + + def set_expiry_date(self, expiry_date): + """ + The method to set the value to expiry_date + + Parameters: + expiry_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if expiry_date is not None and not isinstance(expiry_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expiry_date EXPECTED TYPE: datetime', None, None) + + self.__expiry_date = expiry_date + self.__key_modified['expiry_date'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/urls_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/urls_wrapper.py new file mode 100644 index 0000000..3199348 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/backup/urls_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class UrlsWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of UrlsWrapper""" + super().__init__() + + self.__urls = None + self.__key_modified = dict() + + def get_urls(self): + """ + The method to get the urls + + Returns: + Urls: An instance of Urls + """ + + return self.__urls + + def set_urls(self, urls): + """ + The method to set the value to urls + + Parameters: + urls (Urls) : An instance of Urls + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.urls import Urls + except Exception: + from .urls import Urls + + if urls is not None and not isinstance(urls, Urls): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: urls EXPECTED TYPE: Urls', None, None) + + self.__urls = urls + self.__key_modified['urls'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/__init__.py new file mode 100644 index 0000000..cbd3da9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/__init__.py @@ -0,0 +1,26 @@ +from .crypt import Crypt +from .current_picklist import CurrentPicklist +from .tool_tip import ToolTip +from .api_exception import APIException +from .response_handler import ResponseHandler +from .association_details import AssociationDetails +from .success_response import SuccessResponse +from .currency import Currency +from .action_handler import ActionHandler +from .profile import Profile +from .module import Module +from .view_type import ViewType +from .lookup_field import LookupField +from .body_wrapper import BodyWrapper +from .next_transition import NextTransition +from .transition import Transition +from .multi_select_lookup import MultiSelectLookup +from .layout import Layout +from .field import Field +from .process_info import ProcessInfo +from .escalation import Escalation +from .blueprint_operations import BlueprintOperations +from .response_wrapper import ResponseWrapper +from .formula import Formula +from .auto_number import AutoNumber +from .blue_print import BluePrint diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/api_exception.py new file mode 100644 index 0000000..d972cb8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.blueprint.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.blueprint.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/association_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/association_details.py new file mode 100644 index 0000000..ce0f0d5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/association_details.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationDetails(object): + def __init__(self): + """Creates an instance of AssociationDetails""" + + self.__lookup_field = None + self.__related_field = None + self.__key_modified = dict() + + def get_lookup_field(self): + """ + The method to get the lookup_field + + Returns: + LookupField: An instance of LookupField + """ + + return self.__lookup_field + + def set_lookup_field(self, lookup_field): + """ + The method to set the value to lookup_field + + Parameters: + lookup_field (LookupField) : An instance of LookupField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.lookup_field import LookupField + except Exception: + from .lookup_field import LookupField + + if lookup_field is not None and not isinstance(lookup_field, LookupField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_field EXPECTED TYPE: LookupField', None, None) + + self.__lookup_field = lookup_field + self.__key_modified['lookup_field'] = 1 + + def get_related_field(self): + """ + The method to get the related_field + + Returns: + LookupField: An instance of LookupField + """ + + return self.__related_field + + def set_related_field(self, related_field): + """ + The method to set the value to related_field + + Parameters: + related_field (LookupField) : An instance of LookupField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.lookup_field import LookupField + except Exception: + from .lookup_field import LookupField + + if related_field is not None and not isinstance(related_field, LookupField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_field EXPECTED TYPE: LookupField', None, None) + + self.__related_field = related_field + self.__key_modified['related_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/auto_number.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/auto_number.py new file mode 100644 index 0000000..1738d1d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/auto_number.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutoNumber(object): + def __init__(self): + """Creates an instance of AutoNumber""" + + self.__prefix = None + self.__suffix = None + self.__start_number = None + self.__key_modified = dict() + + def get_prefix(self): + """ + The method to get the prefix + + Returns: + string: A string representing the prefix + """ + + return self.__prefix + + def set_prefix(self, prefix): + """ + The method to set the value to prefix + + Parameters: + prefix (string) : A string representing the prefix + """ + + if prefix is not None and not isinstance(prefix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix EXPECTED TYPE: str', None, None) + + self.__prefix = prefix + self.__key_modified['prefix'] = 1 + + def get_suffix(self): + """ + The method to get the suffix + + Returns: + string: A string representing the suffix + """ + + return self.__suffix + + def set_suffix(self, suffix): + """ + The method to set the value to suffix + + Parameters: + suffix (string) : A string representing the suffix + """ + + if suffix is not None and not isinstance(suffix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suffix EXPECTED TYPE: str', None, None) + + self.__suffix = suffix + self.__key_modified['suffix'] = 1 + + def get_start_number(self): + """ + The method to get the start_number + + Returns: + int: An int representing the start_number + """ + + return self.__start_number + + def set_start_number(self, start_number): + """ + The method to set the value to start_number + + Parameters: + start_number (int) : An int representing the start_number + """ + + if start_number is not None and not isinstance(start_number, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_number EXPECTED TYPE: int', None, None) + + self.__start_number = start_number + self.__key_modified['start_number'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/blue_print.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/blue_print.py new file mode 100644 index 0000000..e6b614d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/blue_print.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BluePrint(object): + def __init__(self): + """Creates an instance of BluePrint""" + + self.__transition_id = None + self.__data = None + self.__process_info = None + self.__transitions = None + self.__key_modified = dict() + + def get_transition_id(self): + """ + The method to get the transition_id + + Returns: + string: A string representing the transition_id + """ + + return self.__transition_id + + def set_transition_id(self, transition_id): + """ + The method to set the value to transition_id + + Parameters: + transition_id (string) : A string representing the transition_id + """ + + if transition_id is not None and not isinstance(transition_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transition_id EXPECTED TYPE: str', None, None) + + self.__transition_id = transition_id + self.__key_modified['transition_id'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + Record: An instance of Record + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if data is not None and not isinstance(data, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Record', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_process_info(self): + """ + The method to get the process_info + + Returns: + ProcessInfo: An instance of ProcessInfo + """ + + return self.__process_info + + def set_process_info(self, process_info): + """ + The method to set the value to process_info + + Parameters: + process_info (ProcessInfo) : An instance of ProcessInfo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.process_info import ProcessInfo + except Exception: + from .process_info import ProcessInfo + + if process_info is not None and not isinstance(process_info, ProcessInfo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_info EXPECTED TYPE: ProcessInfo', None, None) + + self.__process_info = process_info + self.__key_modified['process_info'] = 1 + + def get_transitions(self): + """ + The method to get the transitions + + Returns: + list: An instance of list + """ + + return self.__transitions + + def set_transitions(self, transitions): + """ + The method to set the value to transitions + + Parameters: + transitions (list) : An instance of list + """ + + if transitions is not None and not isinstance(transitions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transitions EXPECTED TYPE: list', None, None) + + self.__transitions = transitions + self.__key_modified['transitions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/blueprint_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/blueprint_operations.py new file mode 100644 index 0000000..b2c75f0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/blueprint_operations.py @@ -0,0 +1,95 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class BlueprintOperations(object): + def __init__(self, record_id, module_api_name): + """ + Creates an instance of BlueprintOperations with the given parameters + + Parameters: + record_id (string) : A string representing the record_id + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(record_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: str', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module_api_name = module_api_name + + + def get_blueprint(self): + """ + The method to get blueprint + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + 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/blueprint' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_blueprint(self, request): + """ + The method to update blueprint + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + 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/blueprint' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/body_wrapper.py new file mode 100644 index 0000000..45b0c96 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__blueprint = None + self.__key_modified = dict() + + def get_blueprint(self): + """ + The method to get the blueprint + + Returns: + list: An instance of list + """ + + return self.__blueprint + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/crypt.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/crypt.py new file mode 100644 index 0000000..c4a477b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/crypt.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Crypt(object): + def __init__(self): + """Creates an instance of Crypt""" + + self.__mode = None + self.__column = None + self.__table = None + self.__status = None + self.__key_modified = dict() + + def get_mode(self): + """ + The method to get the mode + + Returns: + string: A string representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (string) : A string representing the mode + """ + + if mode is not None and not isinstance(mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: str', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_column(self): + """ + The method to get the column + + Returns: + string: A string representing the column + """ + + return self.__column + + def set_column(self, column): + """ + The method to set the value to column + + Parameters: + column (string) : A string representing the column + """ + + if column is not None and not isinstance(column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: str', None, None) + + self.__column = column + self.__key_modified['column'] = 1 + + def get_table(self): + """ + The method to get the table + + Returns: + string: A string representing the table + """ + + return self.__table + + def set_table(self, table): + """ + The method to set the value to table + + Parameters: + table (string) : A string representing the table + """ + + if table is not None and not isinstance(table, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: table EXPECTED TYPE: str', None, None) + + self.__table = table + self.__key_modified['table'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + int: An int representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (int) : An int representing the status + """ + + if status is not None and not isinstance(status, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: int', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/currency.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/currency.py new file mode 100644 index 0000000..9dae60b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/currency.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__rounding_option = None + self.__precision = None + self.__key_modified = dict() + + def get_rounding_option(self): + """ + The method to get the rounding_option + + Returns: + string: A string representing the rounding_option + """ + + return self.__rounding_option + + def set_rounding_option(self, rounding_option): + """ + The method to set the value to rounding_option + + Parameters: + rounding_option (string) : A string representing the rounding_option + """ + + if rounding_option is not None and not isinstance(rounding_option, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rounding_option EXPECTED TYPE: str', None, None) + + self.__rounding_option = rounding_option + self.__key_modified['rounding_option'] = 1 + + def get_precision(self): + """ + The method to get the precision + + Returns: + int: An int representing the precision + """ + + return self.__precision + + def set_precision(self, precision): + """ + The method to set the value to precision + + Parameters: + precision (int) : An int representing the precision + """ + + if precision is not None and not isinstance(precision, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: precision EXPECTED TYPE: int', None, None) + + self.__precision = precision + self.__key_modified['precision'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/current_picklist.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/current_picklist.py new file mode 100644 index 0000000..59fa325 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/current_picklist.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CurrentPicklist(object): + def __init__(self): + """Creates an instance of CurrentPicklist""" + + self.__colour_code = None + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/escalation.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/escalation.py new file mode 100644 index 0000000..13c4847 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/escalation.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Escalation(object): + def __init__(self): + """Creates an instance of Escalation""" + + self.__days = None + self.__status = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + int: An int representing the days + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (int) : An int representing the days + """ + + if days is not None and not isinstance(days, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: int', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/field.py new file mode 100644 index 0000000..3e924b0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/field.py @@ -0,0 +1,1269 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__external = None + self.__display_type = None + self.__filterable = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__ui_type = None + self.__private = None + self.__system_mandatory = None + self.__webhook = None + self.__json_type = None + self.__crypt = None + self.__field_label = None + self.__tooltip = None + self.__created_source = None + self.__layouts = None + self.__field_read_only = None + self.__content = None + self.__display_label = None + self.__validation_rule = None + self.__read_only = None + self.__association_details = None + self.__multi_module_lookup = None + self.__currency = None + self.__id = None + self.__custom_field = None + self.__lookup = None + self.__convert_mapping = None + self.__visible = None + self.__length = None + self.__column_name = None + self.__type = None + self.__view_type = None + self.__transition_sequence = None + self.__api_name = None + self.__unique = None + self.__history_tracking = None + self.__data_type = None + self.__formula = None + self.__decimal_place = None + self.__multiselectlookup = None + self.__pick_list_values = None + self.__auto_number = None + self.__personality_name = None + self.__mandatory = None + self.__quick_sequence_number = None + self.__profiles = None + self.__key_modified = dict() + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import External + except Exception: + from ..fields import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + Choice: An instance of Choice + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (Choice) : An instance of Choice + """ + + if display_type is not None and not isinstance(display_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: Choice', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Private + except Exception: + from ..fields import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.crypt import Crypt + except Exception: + from .crypt import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + ToolTip: An instance of ToolTip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (ToolTip) : An instance of ToolTip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.tool_tip import ToolTip + except Exception: + from .tool_tip import ToolTip + + if tooltip is not None and not isinstance(tooltip, ToolTip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + Layout: An instance of Layout + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.layout import Layout + except Exception: + from .layout import Layout + + if layouts is not None and not isinstance(layouts, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Layout', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_validation_rule(self): + """ + The method to get the validation_rule + + Returns: + string: A string representing the validation_rule + """ + + return self.__validation_rule + + def set_validation_rule(self, validation_rule): + """ + The method to set the value to validation_rule + + Parameters: + validation_rule (string) : A string representing the validation_rule + """ + + if validation_rule is not None and not isinstance(validation_rule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: str', None, None) + + self.__validation_rule = validation_rule + self.__key_modified['validation_rule'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.association_details import AssociationDetails + except Exception: + from .association_details import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MultiModuleLookup + except Exception: + from ..fields import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.currency import Currency + except Exception: + from .currency import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Module: An instance of Module + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.module import Module + except Exception: + from .module import Module + + if lookup is not None and not isinstance(lookup, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Module', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + dict: An instance of dict + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (dict) : An instance of dict + """ + + if convert_mapping is not None and not isinstance(convert_mapping, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: dict', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['_type'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.view_type import ViewType + except Exception: + from .view_type import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_transition_sequence(self): + """ + The method to get the transition_sequence + + Returns: + int: An int representing the transition_sequence + """ + + return self.__transition_sequence + + def set_transition_sequence(self, transition_sequence): + """ + The method to set the value to transition_sequence + + Parameters: + transition_sequence (int) : An int representing the transition_sequence + """ + + if transition_sequence is not None and not isinstance(transition_sequence, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transition_sequence EXPECTED TYPE: int', None, None) + + self.__transition_sequence = transition_sequence + self.__key_modified['transition_sequence'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Unique + except Exception: + from ..fields import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + bool: A bool representing the history_tracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (bool) : A bool representing the history_tracking + """ + + if history_tracking is not None and not isinstance(history_tracking, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: bool', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.formula import Formula + except Exception: + from .formula import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + string: A string representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (string) : A string representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: str', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + MultiSelectLookup: An instance of MultiSelectLookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (MultiSelectLookup) : An instance of MultiSelectLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.multi_select_lookup import MultiSelectLookup + except Exception: + from .multi_select_lookup import MultiSelectLookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, MultiSelectLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: MultiSelectLookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_auto_number(self): + """ + The method to get the auto_number + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number + + def set_auto_number(self, auto_number): + """ + The method to set the value to auto_number + + Parameters: + auto_number (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.auto_number import AutoNumber + except Exception: + from .auto_number import AutoNumber + + if auto_number is not None and not isinstance(auto_number, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number = auto_number + self.__key_modified['auto_number'] = 1 + + def get_personality_name(self): + """ + The method to get the personality_name + + Returns: + string: A string representing the personality_name + """ + + return self.__personality_name + + def set_personality_name(self, personality_name): + """ + The method to set the value to personality_name + + Parameters: + personality_name (string) : A string representing the personality_name + """ + + if personality_name is not None and not isinstance(personality_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: personality_name EXPECTED TYPE: str', None, None) + + self.__personality_name = personality_name + self.__key_modified['personality_name'] = 1 + + def get_mandatory(self): + """ + The method to get the mandatory + + Returns: + bool: A bool representing the mandatory + """ + + return self.__mandatory + + def set_mandatory(self, mandatory): + """ + The method to set the value to mandatory + + Parameters: + mandatory (bool) : A bool representing the mandatory + """ + + if mandatory is not None and not isinstance(mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mandatory EXPECTED TYPE: bool', None, None) + + self.__mandatory = mandatory + self.__key_modified['mandatory'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + int: An int representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (int) : An int representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: int', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/formula.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/formula.py new file mode 100644 index 0000000..37fbe8f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/formula.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Formula(object): + def __init__(self): + """Creates an instance of Formula""" + + self.__return_type = None + self.__expression = None + self.__key_modified = dict() + + def get_return_type(self): + """ + The method to get the return_type + + Returns: + string: A string representing the return_type + """ + + return self.__return_type + + def set_return_type(self, return_type): + """ + The method to set the value to return_type + + Parameters: + return_type (string) : A string representing the return_type + """ + + if return_type is not None and not isinstance(return_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: str', None, None) + + self.__return_type = return_type + self.__key_modified['return_type'] = 1 + + def get_expression(self): + """ + The method to get the expression + + Returns: + int: An int representing the expression + """ + + return self.__expression + + def set_expression(self, expression): + """ + The method to set the value to expression + + Parameters: + expression (int) : An int representing the expression + """ + + if expression is not None and not isinstance(expression, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: int', None, None) + + self.__expression = expression + self.__key_modified['expression'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/layout.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/layout.py new file mode 100644 index 0000000..a7330c3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/lookup_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/lookup_field.py new file mode 100644 index 0000000..20f16d4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/lookup_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LookupField(object): + def __init__(self): + """Creates an instance of LookupField""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/module.py new file mode 100644 index 0000000..e8b84ed --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/module.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__display_label = None + self.__api_name = None + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/multi_select_lookup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/multi_select_lookup.py new file mode 100644 index 0000000..4436532 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/multi_select_lookup.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiSelectLookup(object): + def __init__(self): + """Creates an instance of MultiSelectLookup""" + + self.__display_label = None + self.__linking_module = None + self.__lookup_apiname = None + self.__api_name = None + self.__connectedlookup_apiname = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_linking_module(self): + """ + The method to get the linking_module + + Returns: + string: A string representing the linking_module + """ + + return self.__linking_module + + def set_linking_module(self, linking_module): + """ + The method to set the value to linking_module + + Parameters: + linking_module (string) : A string representing the linking_module + """ + + if linking_module is not None and not isinstance(linking_module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linking_module EXPECTED TYPE: str', None, None) + + self.__linking_module = linking_module + self.__key_modified['linking_module'] = 1 + + def get_lookup_apiname(self): + """ + The method to get the lookup_apiname + + Returns: + string: A string representing the lookup_apiname + """ + + return self.__lookup_apiname + + def set_lookup_apiname(self, lookup_apiname): + """ + The method to set the value to lookup_apiname + + Parameters: + lookup_apiname (string) : A string representing the lookup_apiname + """ + + if lookup_apiname is not None and not isinstance(lookup_apiname, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_apiname EXPECTED TYPE: str', None, None) + + self.__lookup_apiname = lookup_apiname + self.__key_modified['lookup_apiname'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_connectedlookup_apiname(self): + """ + The method to get the connectedlookup_apiname + + Returns: + string: A string representing the connectedlookup_apiname + """ + + return self.__connectedlookup_apiname + + 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 get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/next_transition.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/next_transition.py new file mode 100644 index 0000000..6a31758 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/next_transition.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NextTransition(object): + def __init__(self): + """Creates an instance of NextTransition""" + + self.__id = None + self.__name = None + self.__criteria_matched = None + self.__type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_criteria_matched(self): + """ + The method to get the criteria_matched + + Returns: + bool: A bool representing the criteria_matched + """ + + return self.__criteria_matched + + def set_criteria_matched(self, criteria_matched): + """ + The method to set the value to criteria_matched + + Parameters: + criteria_matched (bool) : A bool representing the criteria_matched + """ + + if criteria_matched is not None and not isinstance(criteria_matched, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria_matched EXPECTED TYPE: bool', None, None) + + self.__criteria_matched = criteria_matched + self.__key_modified['criteria_matched'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/process_info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/process_info.py new file mode 100644 index 0000000..7bed267 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/process_info.py @@ -0,0 +1,359 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ProcessInfo(object): + def __init__(self): + """Creates an instance of ProcessInfo""" + + self.__field_id = None + self.__is_continuous = None + self.__api_name = None + self.__continuous = None + self.__field_label = None + self.__name = None + self.__column_name = None + self.__field_value = None + self.__id = None + self.__field_name = None + self.__escalation = None + self.__current_picklist = None + self.__key_modified = dict() + + def get_field_id(self): + """ + The method to get the field_id + + Returns: + int: An int representing the field_id + """ + + return self.__field_id + + def set_field_id(self, field_id): + """ + The method to set the value to field_id + + Parameters: + field_id (int) : An int representing the field_id + """ + + if field_id is not None and not isinstance(field_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_id EXPECTED TYPE: int', None, None) + + self.__field_id = field_id + self.__key_modified['field_id'] = 1 + + def get_is_continuous(self): + """ + The method to get the is_continuous + + Returns: + bool: A bool representing the is_continuous + """ + + return self.__is_continuous + + def set_is_continuous(self, is_continuous): + """ + The method to set the value to is_continuous + + Parameters: + is_continuous (bool) : A bool representing the is_continuous + """ + + if is_continuous is not None and not isinstance(is_continuous, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_continuous EXPECTED TYPE: bool', None, None) + + self.__is_continuous = is_continuous + self.__key_modified['is_continuous'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_continuous(self): + """ + The method to get the continuous + + Returns: + bool: A bool representing the continuous + """ + + return self.__continuous + + def set_continuous(self, continuous): + """ + The method to set the value to continuous + + Parameters: + continuous (bool) : A bool representing the continuous + """ + + if continuous is not None and not isinstance(continuous, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: continuous EXPECTED TYPE: bool', None, None) + + self.__continuous = continuous + self.__key_modified['continuous'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_field_value(self): + """ + The method to get the field_value + + Returns: + string: A string representing the field_value + """ + + return self.__field_value + + def set_field_value(self, field_value): + """ + The method to set the value to field_value + + Parameters: + field_value (string) : A string representing the field_value + """ + + if field_value is not None and not isinstance(field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_value EXPECTED TYPE: str', None, None) + + self.__field_value = field_value + self.__key_modified['field_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_field_name(self): + """ + The method to get the field_name + + Returns: + string: A string representing the field_name + """ + + return self.__field_name + + def set_field_name(self, field_name): + """ + The method to set the value to field_name + + Parameters: + field_name (string) : A string representing the field_name + """ + + if field_name is not None and not isinstance(field_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_name EXPECTED TYPE: str', None, None) + + self.__field_name = field_name + self.__key_modified['field_name'] = 1 + + def get_escalation(self): + """ + The method to get the escalation + + Returns: + Escalation: An instance of Escalation + """ + + return self.__escalation + + def set_escalation(self, escalation): + """ + The method to set the value to escalation + + Parameters: + escalation (Escalation) : An instance of Escalation + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.escalation import Escalation + except Exception: + from .escalation import Escalation + + if escalation is not None and not isinstance(escalation, Escalation): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: escalation EXPECTED TYPE: Escalation', None, None) + + self.__escalation = escalation + self.__key_modified['escalation'] = 1 + + def get_current_picklist(self): + """ + The method to get the current_picklist + + Returns: + CurrentPicklist: An instance of CurrentPicklist + """ + + return self.__current_picklist + + def set_current_picklist(self, current_picklist): + """ + The method to set the value to current_picklist + + Parameters: + current_picklist (CurrentPicklist) : An instance of CurrentPicklist + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.current_picklist import CurrentPicklist + except Exception: + from .current_picklist import CurrentPicklist + + if current_picklist is not None and not isinstance(current_picklist, CurrentPicklist): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: current_picklist EXPECTED TYPE: CurrentPicklist', None, None) + + self.__current_picklist = current_picklist + self.__key_modified['current_picklist'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/profile.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/profile.py new file mode 100644 index 0000000..f1dfbfe --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/profile.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__id = None + self.__name = None + self.__permission_type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + string: A string representing the permission_type + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (string) : A string representing the permission_type + """ + + if permission_type is not None and not isinstance(permission_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: str', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_wrapper.py new file mode 100644 index 0000000..02461ee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.blueprint.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__blueprint = None + self.__key_modified = dict() + + def get_blueprint(self): + """ + The method to get the blueprint + + Returns: + BluePrint: An instance of BluePrint + """ + + return self.__blueprint + + def set_blueprint(self, blueprint): + """ + The method to set the value to blueprint + + Parameters: + blueprint (BluePrint) : An instance of BluePrint + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.blue_print import BluePrint + except Exception: + from .blue_print import BluePrint + + if blueprint is not None and not isinstance(blueprint, BluePrint): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint EXPECTED TYPE: BluePrint', None, None) + + self.__blueprint = blueprint + self.__key_modified['blueprint'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/success_response.py new file mode 100644 index 0000000..5f74baf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.blueprint.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class SuccessResponse(ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/tool_tip.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/tool_tip.py new file mode 100644 index 0000000..5031570 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/tool_tip.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ToolTip(object): + def __init__(self): + """Creates an instance of ToolTip""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/transition.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/transition.py new file mode 100644 index 0000000..4d8ef98 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/transition.py @@ -0,0 +1,436 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Transition(object): + def __init__(self): + """Creates an instance of Transition""" + + self.__type = None + self.__execution_time = None + self.__sequence = None + self.__next_transitions = None + self.__parent_transition = None + self.__percent_partial_save = None + self.__data = None + self.__next_field_value = None + self.__text_color_code = None + self.__name = None + self.__criteria_matched = None + self.__id = None + self.__fields = None + self.__color_code = None + self.__criteria_message = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_execution_time(self): + """ + The method to get the execution_time + + Returns: + datetime: An instance of datetime + """ + + return self.__execution_time + + def set_execution_time(self, execution_time): + """ + The method to set the value to execution_time + + Parameters: + execution_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if execution_time is not None and not isinstance(execution_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execution_time EXPECTED TYPE: datetime', None, None) + + self.__execution_time = execution_time + self.__key_modified['execution_time'] = 1 + + def get_sequence(self): + """ + The method to get the sequence + + Returns: + int: An int representing the sequence + """ + + return self.__sequence + + def set_sequence(self, sequence): + """ + The method to set the value to sequence + + Parameters: + sequence (int) : An int representing the sequence + """ + + if sequence is not None and not isinstance(sequence, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sequence EXPECTED TYPE: int', None, None) + + self.__sequence = sequence + self.__key_modified['sequence'] = 1 + + def get_next_transitions(self): + """ + The method to get the next_transitions + + Returns: + list: An instance of list + """ + + return self.__next_transitions + + def set_next_transitions(self, next_transitions): + """ + The method to set the value to next_transitions + + Parameters: + next_transitions (list) : An instance of list + """ + + if next_transitions is not None and not isinstance(next_transitions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_transitions EXPECTED TYPE: list', None, None) + + self.__next_transitions = next_transitions + self.__key_modified['next_transitions'] = 1 + + def get_parent_transition(self): + """ + The method to get the parent_transition + + Returns: + Transition: An instance of Transition + """ + + return self.__parent_transition + + def set_parent_transition(self, parent_transition): + """ + The method to set the value to parent_transition + + Parameters: + parent_transition (Transition) : An instance of Transition + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.transition import Transition + except Exception: + from .transition import Transition + + if parent_transition is not None and not isinstance(parent_transition, Transition): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_transition EXPECTED TYPE: Transition', None, None) + + self.__parent_transition = parent_transition + self.__key_modified['parent_transition'] = 1 + + def get_percent_partial_save(self): + """ + The method to get the percent_partial_save + + Returns: + float: A float representing the percent_partial_save + """ + + return self.__percent_partial_save + + def set_percent_partial_save(self, percent_partial_save): + """ + The method to set the value to percent_partial_save + + Parameters: + percent_partial_save (float) : A float representing the percent_partial_save + """ + + if percent_partial_save is not None and not isinstance(percent_partial_save, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: percent_partial_save EXPECTED TYPE: float', None, None) + + self.__percent_partial_save = percent_partial_save + self.__key_modified['percent_partial_save'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + Record: An instance of Record + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if data is not None and not isinstance(data, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Record', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_next_field_value(self): + """ + The method to get the next_field_value + + Returns: + string: A string representing the next_field_value + """ + + return self.__next_field_value + + def set_next_field_value(self, next_field_value): + """ + The method to set the value to next_field_value + + Parameters: + next_field_value (string) : A string representing the next_field_value + """ + + if next_field_value is not None and not isinstance(next_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_field_value EXPECTED TYPE: str', None, None) + + self.__next_field_value = next_field_value + self.__key_modified['next_field_value'] = 1 + + def get_text_color_code(self): + """ + The method to get the text_color_code + + Returns: + string: A string representing the text_color_code + """ + + return self.__text_color_code + + def set_text_color_code(self, text_color_code): + """ + The method to set the value to text_color_code + + Parameters: + text_color_code (string) : A string representing the text_color_code + """ + + if text_color_code is not None and not isinstance(text_color_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: text_color_code EXPECTED TYPE: str', None, None) + + self.__text_color_code = text_color_code + self.__key_modified['text_color_code'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_criteria_matched(self): + """ + The method to get the criteria_matched + + Returns: + bool: A bool representing the criteria_matched + """ + + return self.__criteria_matched + + def set_criteria_matched(self, criteria_matched): + """ + The method to set the value to criteria_matched + + Parameters: + criteria_matched (bool) : A bool representing the criteria_matched + """ + + if criteria_matched is not None and not isinstance(criteria_matched, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria_matched EXPECTED TYPE: bool', None, None) + + self.__criteria_matched = criteria_matched + self.__key_modified['criteria_matched'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_color_code(self): + """ + The method to get the color_code + + Returns: + string: A string representing the color_code + """ + + return self.__color_code + + def set_color_code(self, color_code): + """ + The method to set the value to color_code + + Parameters: + color_code (string) : A string representing the color_code + """ + + if color_code is not None and not isinstance(color_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: str', None, None) + + self.__color_code = color_code + self.__key_modified['color_code'] = 1 + + def get_criteria_message(self): + """ + The method to get the criteria_message + + Returns: + string: A string representing the criteria_message + """ + + return self.__criteria_message + + def set_criteria_message(self, criteria_message): + """ + The method to set the value to criteria_message + + Parameters: + criteria_message (string) : A string representing the criteria_message + """ + + if criteria_message is not None and not isinstance(criteria_message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria_message EXPECTED TYPE: str', None, None) + + self.__criteria_message = criteria_message + self.__key_modified['criteria_message'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/view_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/view_type.py new file mode 100644 index 0000000..52a24e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/blueprint/view_type.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ViewType(object): + def __init__(self): + """Creates an instance of ViewType""" + + self.__view = None + self.__edit = None + self.__create = None + self.__quick_create = None + self.__key_modified = dict() + + def get_view(self): + """ + The method to get the view + + Returns: + bool: A bool representing the view + """ + + return self.__view + + def set_view(self, view): + """ + The method to set the value to view + + Parameters: + view (bool) : A bool representing the view + """ + + if view is not None and not isinstance(view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view EXPECTED TYPE: bool', None, None) + + self.__view = view + self.__key_modified['view'] = 1 + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_create(self): + """ + The method to get the create + + Returns: + bool: A bool representing the create + """ + + return self.__create + + def set_create(self, create): + """ + The method to set the value to create + + Parameters: + create (bool) : A bool representing the create + """ + + if create is not None and not isinstance(create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create EXPECTED TYPE: bool', None, None) + + self.__create = create + self.__key_modified['create'] = 1 + + def get_quick_create(self): + """ + The method to get the quick_create + + Returns: + bool: A bool representing the quick_create + """ + + return self.__quick_create + + def set_quick_create(self, quick_create): + """ + The method to set the value to quick_create + + Parameters: + quick_create (bool) : A bool representing the quick_create + """ + + if quick_create is not None and not isinstance(quick_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_create EXPECTED TYPE: bool', None, None) + + self.__quick_create = quick_create + self.__key_modified['quick_create'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/__init__.py new file mode 100644 index 0000000..e29fdca --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .module_details import ModuleDetails +from .criteria import Criteria +from .query import Query +from .body_wrapper import BodyWrapper +from .result import Result +from .job_detail import JobDetail +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .bulk_read_operations import BulkReadOperations +from .file_body_wrapper import FileBodyWrapper +from .success_response import SuccessResponse +from .call_back import CallBack +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_wrapper.py new file mode 100644 index 0000000..6e9559f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + dict: An instance of dict + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (dict) : An instance of dict + """ + + if info is not None and not isinstance(info, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: dict', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/api_exception.py new file mode 100644 index 0000000..39aa4e4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/body_wrapper.py new file mode 100644 index 0000000..ab103ae --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/body_wrapper.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__callback = None + self.__query = None + self.__file_type = None + self.__key_modified = dict() + + def get_callback(self): + """ + The method to get the callback + + Returns: + CallBack: An instance of CallBack + """ + + return self.__callback + + def set_callback(self, callback): + """ + The method to set the value to callback + + Parameters: + callback (CallBack) : An instance of CallBack + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.call_back import CallBack + except Exception: + from .call_back import CallBack + + if callback is not None and not isinstance(callback, CallBack): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', None, None) + + self.__callback = callback + self.__key_modified['callback'] = 1 + + def get_query(self): + """ + The method to get the query + + Returns: + Query: An instance of Query + """ + + return self.__query + + def set_query(self, query): + """ + The method to set the value to query + + Parameters: + query (Query) : An instance of Query + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.query import Query + except Exception: + from .query import Query + + if query is not None and not isinstance(query, Query): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query EXPECTED TYPE: Query', None, None) + + self.__query = query + self.__key_modified['query'] = 1 + + def get_file_type(self): + """ + The method to get the file_type + + Returns: + Choice: An instance of Choice + """ + + return self.__file_type + + def set_file_type(self, file_type): + """ + The method to set the value to file_type + + Parameters: + file_type (Choice) : An instance of Choice + """ + + if file_type is not None and not isinstance(file_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Choice', None, None) + + self.__file_type = file_type + self.__key_modified['file_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/bulk_read_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/bulk_read_operations.py new file mode 100644 index 0000000..5c5047b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/bulk_read_operations.py @@ -0,0 +1,110 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class BulkReadOperations(object): + def __init__(self): + """Creates an instance of BulkReadOperations""" + pass + + def create_bulk_read_job(self, request): + """ + The method to create bulk read job + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/bulk/v7/read' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_bulk_read_job_details(self, job_id): + """ + The method to get bulk read job details + + Parameters: + job_id (int) : An int representing the job_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/read/' + api_path = api_path + str(job_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def download_result(self, job_id): + """ + The method to download result + + Parameters: + job_id (int) : An int representing the job_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/read/' + api_path = api_path + str(job_id) + api_path = api_path + '/result' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/x-download') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/call_back.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/call_back.py new file mode 100644 index 0000000..57aa396 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/call_back.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class CallBack(object): + def __init__(self): + """Creates an instance of CallBack""" + + self.__url = None + self.__method = None + self.__key_modified = dict() + + def get_url(self): + """ + The method to get the url + + Returns: + string: A string representing the url + """ + + return self.__url + + def set_url(self, url): + """ + The method to set the value to url + + Parameters: + url (string) : A string representing the url + """ + + if url is not None and not isinstance(url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: url EXPECTED TYPE: str', None, None) + + self.__url = url + self.__key_modified['url'] = 1 + + def get_method(self): + """ + The method to get the method + + Returns: + Choice: An instance of Choice + """ + + return self.__method + + def set_method(self, method): + """ + The method to set the value to method + + Parameters: + method (Choice) : An instance of Choice + """ + + if method is not None and not isinstance(method, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: method EXPECTED TYPE: Choice', None, None) + + self.__method = method + self.__key_modified['method'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/criteria.py new file mode 100644 index 0000000..14e9ea7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/criteria.py @@ -0,0 +1,226 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__type = None + self.__api_name = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__field = None + self.__comparator = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + Choice: An instance of Choice + """ + + return self.__group_operator + + 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 get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MinifiedField + except Exception: + from ..fields import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + Choice: An instance of Choice + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (Choice) : An instance of Choice + """ + + if comparator is not None and not isinstance(comparator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Choice', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/file_body_wrapper.py new file mode 100644 index 0000000..c2032d2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/job_detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/job_detail.py new file mode 100644 index 0000000..f16dc00 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/job_detail.py @@ -0,0 +1,266 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class JobDetail(object): + def __init__(self): + """Creates an instance of JobDetail""" + + self.__id = None + self.__operation = None + self.__state = None + self.__query = None + self.__created_by = None + self.__created_time = None + self.__result = None + self.__file_type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_operation(self): + """ + The method to get the operation + + Returns: + string: A string representing the operation + """ + + return self.__operation + + def set_operation(self, operation): + """ + The method to set the value to operation + + Parameters: + operation (string) : A string representing the operation + """ + + if operation is not None and not isinstance(operation, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: str', None, None) + + self.__operation = operation + self.__key_modified['operation'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + Choice: An instance of Choice + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (Choice) : An instance of Choice + """ + + if state is not None and not isinstance(state, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: Choice', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_query(self): + """ + The method to get the query + + Returns: + Query: An instance of Query + """ + + return self.__query + + def set_query(self, query): + """ + The method to set the value to query + + Parameters: + query (Query) : An instance of Query + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.query import Query + except Exception: + from .query import Query + + if query is not None and not isinstance(query, Query): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query EXPECTED TYPE: Query', None, None) + + self.__query = query + self.__key_modified['query'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_result(self): + """ + The method to get the result + + Returns: + Result: An instance of Result + """ + + return self.__result + + def set_result(self, result): + """ + The method to set the value to result + + Parameters: + result (Result) : An instance of Result + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.result import Result + except Exception: + from .result import Result + + if result is not None and not isinstance(result, Result): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: result EXPECTED TYPE: Result', None, None) + + self.__result = result + self.__key_modified['result'] = 1 + + def get_file_type(self): + """ + The method to get the file_type + + Returns: + Choice: An instance of Choice + """ + + return self.__file_type + + def set_file_type(self, file_type): + """ + The method to set the value to file_type + + Parameters: + file_type (Choice) : An instance of Choice + """ + + if file_type is not None and not isinstance(file_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Choice', None, None) + + self.__file_type = file_type + self.__key_modified['file_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/module_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/module_details.py new file mode 100644 index 0000000..4804564 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/module_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleDetails(object): + def __init__(self): + """Creates an instance of ModuleDetails""" + + self.__api_name = None + self.__module = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/query.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/query.py new file mode 100644 index 0000000..c7bf58a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/query.py @@ -0,0 +1,234 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Query(object): + def __init__(self): + """Creates an instance of Query""" + + self.__module = None + self.__cvid = None + self.__fields = None + self.__page = None + self.__criteria = None + self.__file_type = None + self.__page_token = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + int: An int representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (int) : An int representing the cvid + """ + + if cvid is not None and not isinstance(cvid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: int', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_file_type(self): + """ + The method to get the file_type + + Returns: + Choice: An instance of Choice + """ + + return self.__file_type + + def set_file_type(self, file_type): + """ + The method to set the value to file_type + + Parameters: + file_type (Choice) : An instance of Choice + """ + + if file_type is not None and not isinstance(file_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Choice', None, None) + + self.__file_type = file_type + self.__key_modified['file_type'] = 1 + + def get_page_token(self): + """ + The method to get the page_token + + Returns: + string: A string representing the page_token + """ + + return self.__page_token + + def set_page_token(self, page_token): + """ + The method to set the value to page_token + + Parameters: + page_token (string) : A string representing the page_token + """ + + if page_token is not None and not isinstance(page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token EXPECTED TYPE: str', None, None) + + self.__page_token = page_token + self.__key_modified['page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_wrapper.py new file mode 100644 index 0000000..0b45ffa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/result.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/result.py new file mode 100644 index 0000000..6c05187 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/result.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Result(object): + def __init__(self): + """Creates an instance of Result""" + + self.__page = None + self.__count = None + self.__download_url = None + self.__per_page = None + self.__more_records = None + self.__next_page_token = None + self.__key_modified = dict() + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_download_url(self): + """ + The method to get the download_url + + Returns: + string: A string representing the download_url + """ + + return self.__download_url + + 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 get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/success_response.py new file mode 100644 index 0000000..77c177a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_read/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/__init__.py new file mode 100644 index 0000000..4a7218a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/__init__.py @@ -0,0 +1,15 @@ +from .request_wrapper import RequestWrapper +from .resource import Resource +from .default_value import DefaultValue +from .bulk_write_operations import BulkWriteOperations, UploadFileHeader +from .result import Result +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .file import File +from .success_response import SuccessResponse +from .bulk_write_response import BulkWriteResponse +from .call_back import CallBack +from .file_body_wrapper import FileBodyWrapper +from .field_mapping import FieldMapping +from .response_wrapper import ResponseWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/api_exception.py new file mode 100644 index 0000000..38b591b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/api_exception.py @@ -0,0 +1,306 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .response_wrapper import ResponseWrapper + + +class APIException(ActionResponse, ResponseWrapper, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__error_message = None + self.__error_code = None + self.__x_error = None + self.__info = None + self.__x_info = None + self.__http_status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_error_message(self): + """ + The method to get the error_message + + Returns: + Choice: An instance of Choice + """ + + return self.__error_message + + def set_error_message(self, error_message): + """ + The method to set the value to error_message + + Parameters: + error_message (Choice) : An instance of Choice + """ + + if error_message is not None and not isinstance(error_message, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: error_message EXPECTED TYPE: Choice', None, None) + + self.__error_message = error_message + self.__key_modified['ERROR_MESSAGE'] = 1 + + def get_error_code(self): + """ + The method to get the error_code + + Returns: + int: An int representing the error_code + """ + + return self.__error_code + + def set_error_code(self, error_code): + """ + The method to set the value to error_code + + Parameters: + error_code (int) : An int representing the error_code + """ + + if error_code is not None and not isinstance(error_code, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: error_code EXPECTED TYPE: int', None, None) + + self.__error_code = error_code + self.__key_modified['ERROR_CODE'] = 1 + + def get_x_error(self): + """ + The method to get the x_error + + Returns: + Choice: An instance of Choice + """ + + return self.__x_error + + def set_x_error(self, x_error): + """ + The method to set the value to x_error + + Parameters: + x_error (Choice) : An instance of Choice + """ + + if x_error is not None and not isinstance(x_error, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_error EXPECTED TYPE: Choice', None, None) + + self.__x_error = x_error + self.__key_modified['x-error'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Choice: An instance of Choice + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Choice) : An instance of Choice + """ + + if info is not None and not isinstance(info, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Choice', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def get_x_info(self): + """ + The method to get the x_info + + Returns: + Choice: An instance of Choice + """ + + return self.__x_info + + def set_x_info(self, x_info): + """ + The method to set the value to x_info + + Parameters: + x_info (Choice) : An instance of Choice + """ + + if x_info is not None and not isinstance(x_info, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_info EXPECTED TYPE: Choice', None, None) + + self.__x_info = x_info + self.__key_modified['x-info'] = 1 + + def get_http_status(self): + """ + The method to get the http_status + + Returns: + string: A string representing the http_status + """ + + return self.__http_status + + def set_http_status(self, http_status): + """ + The method to set the value to http_status + + Parameters: + http_status (string) : A string representing the http_status + """ + + if http_status is not None and not isinstance(http_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: http_status EXPECTED TYPE: str', None, None) + + self.__http_status = http_status + self.__key_modified['http_status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_operations.py new file mode 100644 index 0000000..a37faf0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_operations.py @@ -0,0 +1,163 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class BulkWriteOperations(object): + def __init__(self): + """Creates an instance of BulkWriteOperations""" + pass + + def upload_file(self, request, header_instance=None): + """ + The method to upload file + + Parameters: + request (FileBodyWrapper) : An instance of FileBodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + 'https://content.zohoapis.com/crm/v7/upload' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def create_bulk_write_job(self, request): + """ + The method to create bulk write job + + Parameters: + request (RequestWrapper) : An instance of RequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.request_wrapper import RequestWrapper + except Exception: + from .request_wrapper import RequestWrapper + + if request is not None and not isinstance(request, RequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/write' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def get_bulk_write_job_details(self, job_id): + """ + The method to get bulk write job details + + Parameters: + job_id (string) : A string representing the job_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(job_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/write/' + api_path = api_path + str(job_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + def download_bulk_write_result(self, download_url): + """ + The method to download bulk write result + + Parameters: + download_url (string) : A string representing the download_url + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(download_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_url EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/' + api_path = api_path + str(download_url) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/octet-stream') + + +class UploadFileHeader(object): + feature = Header('feature', 'com.zoho.crm.api.BulkWrite.UploadFileHeader') + x_crm_org = Header('X-CRM-ORG', 'com.zoho.crm.api.BulkWrite.UploadFileHeader') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_response.py new file mode 100644 index 0000000..243ab3a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_response.py @@ -0,0 +1,294 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_wrapper import ResponseWrapper + + +class BulkWriteResponse(ResponseWrapper): + def __init__(self): + """Creates an instance of BulkWriteResponse""" + super().__init__() + + self.__status = None + self.__character_encoding = None + self.__resource = None + self.__id = None + self.__result = None + self.__created_by = None + self.__operation = None + self.__created_time = None + self.__callback = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_character_encoding(self): + """ + The method to get the character_encoding + + Returns: + string: A string representing the character_encoding + """ + + return self.__character_encoding + + def set_character_encoding(self, character_encoding): + """ + The method to set the value to character_encoding + + Parameters: + character_encoding (string) : A string representing the character_encoding + """ + + if character_encoding is not None and not isinstance(character_encoding, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: character_encoding EXPECTED TYPE: str', None, None) + + self.__character_encoding = character_encoding + self.__key_modified['character_encoding'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + list: An instance of list + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (list) : An instance of list + """ + + if resource is not None and not isinstance(resource, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: list', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_result(self): + """ + The method to get the result + + Returns: + Result: An instance of Result + """ + + return self.__result + + def set_result(self, result): + """ + The method to set the value to result + + Parameters: + result (Result) : An instance of Result + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.result import Result + except Exception: + from .result import Result + + if result is not None and not isinstance(result, Result): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: result EXPECTED TYPE: Result', None, None) + + self.__result = result + self.__key_modified['result'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_operation(self): + """ + The method to get the operation + + Returns: + string: A string representing the operation + """ + + return self.__operation + + def set_operation(self, operation): + """ + The method to set the value to operation + + Parameters: + operation (string) : A string representing the operation + """ + + if operation is not None and not isinstance(operation, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: str', None, None) + + self.__operation = operation + self.__key_modified['operation'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_callback(self): + """ + The method to get the callback + + Returns: + CallBack: An instance of CallBack + """ + + return self.__callback + + def set_callback(self, callback): + """ + The method to set the value to callback + + Parameters: + callback (CallBack) : An instance of CallBack + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.call_back import CallBack + except Exception: + from .call_back import CallBack + + if callback is not None and not isinstance(callback, CallBack): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', None, None) + + self.__callback = callback + self.__key_modified['callback'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/call_back.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/call_back.py new file mode 100644 index 0000000..57aa396 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/call_back.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class CallBack(object): + def __init__(self): + """Creates an instance of CallBack""" + + self.__url = None + self.__method = None + self.__key_modified = dict() + + def get_url(self): + """ + The method to get the url + + Returns: + string: A string representing the url + """ + + return self.__url + + def set_url(self, url): + """ + The method to set the value to url + + Parameters: + url (string) : A string representing the url + """ + + if url is not None and not isinstance(url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: url EXPECTED TYPE: str', None, None) + + self.__url = url + self.__key_modified['url'] = 1 + + def get_method(self): + """ + The method to get the method + + Returns: + Choice: An instance of Choice + """ + + return self.__method + + def set_method(self, method): + """ + The method to set the value to method + + Parameters: + method (Choice) : An instance of Choice + """ + + if method is not None and not isinstance(method, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: method EXPECTED TYPE: Choice', None, None) + + self.__method = method + self.__key_modified['method'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/default_value.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/default_value.py new file mode 100644 index 0000000..0a4f50a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/default_value.py @@ -0,0 +1,121 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultValue(object): + def __init__(self): + """Creates an instance of DefaultValue""" + + self.__name = None + self.__module = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/field_mapping.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/field_mapping.py new file mode 100644 index 0000000..bfba0e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/field_mapping.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldMapping(object): + def __init__(self): + """Creates an instance of FieldMapping""" + + self.__api_name = None + self.__index = None + self.__format = None + self.__find_by = None + self.__default_value = None + self.__module = None + self.__parent_column_index = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_index(self): + """ + The method to get the index + + Returns: + int: An int representing the index + """ + + return self.__index + + def set_index(self, index): + """ + The method to set the value to index + + Parameters: + index (int) : An int representing the index + """ + + if index is not None and not isinstance(index, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: index EXPECTED TYPE: int', None, None) + + self.__index = index + self.__key_modified['index'] = 1 + + def get_format(self): + """ + The method to get the format + + Returns: + string: A string representing the format + """ + + return self.__format + + def set_format(self, format): + """ + The method to set the value to format + + Parameters: + format (string) : A string representing the format + """ + + if format is not None and not isinstance(format, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: str', None, None) + + self.__format = format + self.__key_modified['format'] = 1 + + def get_find_by(self): + """ + The method to get the find_by + + Returns: + string: A string representing the find_by + """ + + return self.__find_by + + def set_find_by(self, find_by): + """ + The method to set the value to find_by + + Parameters: + find_by (string) : A string representing the find_by + """ + + if find_by is not None and not isinstance(find_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: find_by EXPECTED TYPE: str', None, None) + + self.__find_by = find_by + self.__key_modified['find_by'] = 1 + + def get_default_value(self): + """ + The method to get the default_value + + Returns: + DefaultValue: An instance of DefaultValue + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (DefaultValue) : An instance of DefaultValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.default_value import DefaultValue + except Exception: + from .default_value import DefaultValue + + if default_value is not None and not isinstance(default_value, DefaultValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: DefaultValue', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_parent_column_index(self): + """ + The method to get the parent_column_index + + Returns: + int: An int representing the parent_column_index + """ + + return self.__parent_column_index + + def set_parent_column_index(self, parent_column_index): + """ + The method to set the value to parent_column_index + + Parameters: + parent_column_index (int) : An int representing the parent_column_index + """ + + if parent_column_index is not None and not isinstance(parent_column_index, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_column_index EXPECTED TYPE: int', None, None) + + self.__parent_column_index = parent_column_index + self.__key_modified['parent_column_index'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file.py new file mode 100644 index 0000000..154743d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class File(object): + def __init__(self): + """Creates an instance of File""" + + self.__status = None + self.__name = None + self.__added_count = None + self.__skipped_count = None + self.__updated_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_added_count(self): + """ + The method to get the added_count + + Returns: + int: An int representing the added_count + """ + + return self.__added_count + + def set_added_count(self, added_count): + """ + The method to set the value to added_count + + Parameters: + added_count (int) : An int representing the added_count + """ + + if added_count is not None and not isinstance(added_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: added_count EXPECTED TYPE: int', None, None) + + self.__added_count = added_count + self.__key_modified['added_count'] = 1 + + def get_skipped_count(self): + """ + The method to get the skipped_count + + Returns: + int: An int representing the skipped_count + """ + + return self.__skipped_count + + def set_skipped_count(self, skipped_count): + """ + The method to set the value to skipped_count + + Parameters: + skipped_count (int) : An int representing the skipped_count + """ + + if skipped_count is not None and not isinstance(skipped_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: skipped_count EXPECTED TYPE: int', None, None) + + self.__skipped_count = skipped_count + self.__key_modified['skipped_count'] = 1 + + def get_updated_count(self): + """ + The method to get the updated_count + + Returns: + int: An int representing the updated_count + """ + + return self.__updated_count + + def set_updated_count(self, updated_count): + """ + The method to set the value to updated_count + + Parameters: + updated_count (int) : An int representing the updated_count + """ + + if updated_count is not None and not isinstance(updated_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updated_count EXPECTED TYPE: int', None, None) + + self.__updated_count = updated_count + self.__key_modified['updated_count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['total_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file_body_wrapper.py new file mode 100644 index 0000000..90c5f3c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/request_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/request_wrapper.py new file mode 100644 index 0000000..22ca0a8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/request_wrapper.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class RequestWrapper(object): + def __init__(self): + """Creates an instance of RequestWrapper""" + + self.__character_encoding = None + self.__operation = None + self.__callback = None + self.__resource = None + self.__ignore_empty = None + self.__key_modified = dict() + + def get_character_encoding(self): + """ + The method to get the character_encoding + + Returns: + string: A string representing the character_encoding + """ + + return self.__character_encoding + + def set_character_encoding(self, character_encoding): + """ + The method to set the value to character_encoding + + Parameters: + character_encoding (string) : A string representing the character_encoding + """ + + if character_encoding is not None and not isinstance(character_encoding, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: character_encoding EXPECTED TYPE: str', None, None) + + self.__character_encoding = character_encoding + self.__key_modified['character_encoding'] = 1 + + def get_operation(self): + """ + The method to get the operation + + Returns: + Choice: An instance of Choice + """ + + return self.__operation + + def set_operation(self, operation): + """ + The method to set the value to operation + + Parameters: + operation (Choice) : An instance of Choice + """ + + if operation is not None and not isinstance(operation, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: Choice', None, None) + + self.__operation = operation + self.__key_modified['operation'] = 1 + + def get_callback(self): + """ + The method to get the callback + + Returns: + CallBack: An instance of CallBack + """ + + return self.__callback + + def set_callback(self, callback): + """ + The method to set the value to callback + + Parameters: + callback (CallBack) : An instance of CallBack + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.call_back import CallBack + except Exception: + from .call_back import CallBack + + if callback is not None and not isinstance(callback, CallBack): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', None, None) + + self.__callback = callback + self.__key_modified['callback'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + list: An instance of list + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (list) : An instance of list + """ + + if resource is not None and not isinstance(resource, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: list', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_ignore_empty(self): + """ + The method to get the ignore_empty + + Returns: + bool: A bool representing the ignore_empty + """ + + return self.__ignore_empty + + def set_ignore_empty(self, ignore_empty): + """ + The method to set the value to ignore_empty + + Parameters: + ignore_empty (bool) : A bool representing the ignore_empty + """ + + if ignore_empty is not None and not isinstance(ignore_empty, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ignore_empty EXPECTED TYPE: bool', None, None) + + self.__ignore_empty = ignore_empty + self.__key_modified['ignore_empty'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/resource.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/resource.py new file mode 100644 index 0000000..a646a78 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/resource.py @@ -0,0 +1,309 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__status = None + self.__type = None + self.__module = None + self.__code = None + self.__file_id = None + self.__file_names = None + self.__ignore_empty = None + self.__find_by = None + self.__field_mappings = None + self.__file = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + string: A string representing the code + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (string) : A string representing the code + """ + + if code is not None and not isinstance(code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: str', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_file_id(self): + """ + The method to get the file_id + + Returns: + string: A string representing the file_id + """ + + return self.__file_id + + def set_file_id(self, file_id): + """ + The method to set the value to file_id + + Parameters: + file_id (string) : A string representing the file_id + """ + + if file_id is not None and not isinstance(file_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: str', None, None) + + self.__file_id = file_id + self.__key_modified['file_id'] = 1 + + def get_file_names(self): + """ + The method to get the file_names + + Returns: + list: An instance of list + """ + + return self.__file_names + + def set_file_names(self, file_names): + """ + The method to set the value to file_names + + Parameters: + file_names (list) : An instance of list + """ + + if file_names is not None and not isinstance(file_names, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_names EXPECTED TYPE: list', None, None) + + self.__file_names = file_names + self.__key_modified['file_names'] = 1 + + def get_ignore_empty(self): + """ + The method to get the ignore_empty + + Returns: + bool: A bool representing the ignore_empty + """ + + return self.__ignore_empty + + def set_ignore_empty(self, ignore_empty): + """ + The method to set the value to ignore_empty + + Parameters: + ignore_empty (bool) : A bool representing the ignore_empty + """ + + if ignore_empty is not None and not isinstance(ignore_empty, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ignore_empty EXPECTED TYPE: bool', None, None) + + self.__ignore_empty = ignore_empty + self.__key_modified['ignore_empty'] = 1 + + def get_find_by(self): + """ + The method to get the find_by + + Returns: + string: A string representing the find_by + """ + + return self.__find_by + + def set_find_by(self, find_by): + """ + The method to set the value to find_by + + Parameters: + find_by (string) : A string representing the find_by + """ + + if find_by is not None and not isinstance(find_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: find_by EXPECTED TYPE: str', None, None) + + self.__find_by = find_by + self.__key_modified['find_by'] = 1 + + def get_field_mappings(self): + """ + The method to get the field_mappings + + Returns: + list: An instance of list + """ + + return self.__field_mappings + + def set_field_mappings(self, field_mappings): + """ + The method to set the value to field_mappings + + Parameters: + field_mappings (list) : An instance of list + """ + + if field_mappings is not None and not isinstance(field_mappings, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_mappings EXPECTED TYPE: list', None, None) + + self.__field_mappings = field_mappings + self.__key_modified['field_mappings'] = 1 + + def get_file(self): + """ + The method to get the file + + Returns: + File: An instance of File + """ + + return self.__file + + def set_file(self, file): + """ + The method to set the value to file + + Parameters: + file (File) : An instance of File + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.file import File + except Exception: + from .file import File + + if file is not None and not isinstance(file, File): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: File', None, None) + + self.__file = file + self.__key_modified['file'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_wrapper.py new file mode 100644 index 0000000..1c2d2c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseWrapper(ABC): + def __init__(self): + """Creates an instance of ResponseWrapper""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/result.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/result.py new file mode 100644 index 0000000..d276229 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/result.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Result(object): + def __init__(self): + """Creates an instance of Result""" + + self.__download_url = None + self.__key_modified = dict() + + def get_download_url(self): + """ + The method to get the download_url + + Returns: + string: A string representing the download_url + """ + + return self.__download_url + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/success_response.py new file mode 100644 index 0000000..73f1b32 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/bulk_write/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/__init__.py new file mode 100644 index 0000000..d3bad25 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/__init__.py @@ -0,0 +1,13 @@ +from .business_hours import BusinessHours +from .action_wrapper import ActionWrapper +from .break_hours_custom_timing import BreakHoursCustomTiming +from .resources import Resources +from .body_wrapper import BodyWrapper +from .business_hours_operations import BusinessHoursOperations, CreateBusinessHoursHeader, UpdateBusinessHoursHeader, GetBusinessHoursHeader +from .features import Features +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_wrapper.py new file mode 100644 index 0000000..3d0a3bc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__business_hours = None + self.__key_modified = dict() + + def get_business_hours(self): + """ + The method to get the business_hours + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__business_hours + + def set_business_hours(self, business_hours): + """ + The method to set the value to business_hours + + Parameters: + business_hours (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if business_hours is not None and not isinstance(business_hours, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_hours EXPECTED TYPE: ActionResponse', None, None) + + self.__business_hours = business_hours + self.__key_modified['business_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/api_exception.py new file mode 100644 index 0000000..788e097 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.business_hours.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/body_wrapper.py new file mode 100644 index 0000000..3d6b156 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__business_hours = None + self.__key_modified = dict() + + def get_business_hours(self): + """ + The method to get the business_hours + + Returns: + BusinessHours: An instance of BusinessHours + """ + + return self.__business_hours + + def set_business_hours(self, business_hours): + """ + The method to set the value to business_hours + + Parameters: + business_hours (BusinessHours) : An instance of BusinessHours + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.business_hours import BusinessHours + except Exception: + from .business_hours import BusinessHours + + if business_hours is not None and not isinstance(business_hours, BusinessHours): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_hours EXPECTED TYPE: BusinessHours', None, None) + + self.__business_hours = business_hours + self.__key_modified['business_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/break_hours_custom_timing.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/break_hours_custom_timing.py new file mode 100644 index 0000000..a582f23 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/break_hours_custom_timing.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class BreakHoursCustomTiming(object): + def __init__(self): + """Creates an instance of BreakHoursCustomTiming""" + + self.__days = None + self.__business_timing = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + Choice: An instance of Choice + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (Choice) : An instance of Choice + """ + + if days is not None and not isinstance(days, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: Choice', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_business_timing(self): + """ + The method to get the business_timing + + Returns: + list: An instance of list + """ + + return self.__business_timing + + def set_business_timing(self, business_timing): + """ + The method to set the value to business_timing + + Parameters: + business_timing (list) : An instance of list + """ + + if business_timing is not None and not isinstance(business_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_timing EXPECTED TYPE: list', None, None) + + self.__business_timing = business_timing + self.__key_modified['business_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours.py new file mode 100644 index 0000000..e20a61d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class BusinessHours(object): + def __init__(self): + """Creates an instance of BusinessHours""" + + self.__week_starts_on = None + self.__type = None + self.__id = None + self.__business_days = None + self.__same_as_everyday = None + self.__daily_timing = None + self.__custom_timing = None + self.__key_modified = dict() + + def get_week_starts_on(self): + """ + The method to get the week_starts_on + + Returns: + Choice: An instance of Choice + """ + + return self.__week_starts_on + + def set_week_starts_on(self, week_starts_on): + """ + The method to set the value to week_starts_on + + Parameters: + week_starts_on (Choice) : An instance of Choice + """ + + if week_starts_on is not None and not isinstance(week_starts_on, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: week_starts_on EXPECTED TYPE: Choice', None, None) + + self.__week_starts_on = week_starts_on + self.__key_modified['week_starts_on'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_business_days(self): + """ + The method to get the business_days + + Returns: + list: An instance of list + """ + + return self.__business_days + + def set_business_days(self, business_days): + """ + The method to set the value to business_days + + Parameters: + business_days (list) : An instance of list + """ + + if business_days is not None and not isinstance(business_days, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_days EXPECTED TYPE: list', None, None) + + self.__business_days = business_days + self.__key_modified['business_days'] = 1 + + def get_same_as_everyday(self): + """ + The method to get the same_as_everyday + + Returns: + bool: A bool representing the same_as_everyday + """ + + return self.__same_as_everyday + + def set_same_as_everyday(self, same_as_everyday): + """ + The method to set the value to same_as_everyday + + Parameters: + same_as_everyday (bool) : A bool representing the same_as_everyday + """ + + if same_as_everyday is not None and not isinstance(same_as_everyday, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: same_as_everyday EXPECTED TYPE: bool', None, None) + + self.__same_as_everyday = same_as_everyday + self.__key_modified['same_as_everyday'] = 1 + + def get_daily_timing(self): + """ + The method to get the daily_timing + + Returns: + list: An instance of list + """ + + return self.__daily_timing + + def set_daily_timing(self, daily_timing): + """ + The method to set the value to daily_timing + + Parameters: + daily_timing (list) : An instance of list + """ + + if daily_timing is not None and not isinstance(daily_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: daily_timing EXPECTED TYPE: list', None, None) + + self.__daily_timing = daily_timing + self.__key_modified['daily_timing'] = 1 + + def get_custom_timing(self): + """ + The method to get the custom_timing + + Returns: + list: An instance of list + """ + + return self.__custom_timing + + def set_custom_timing(self, custom_timing): + """ + The method to set the value to custom_timing + + Parameters: + custom_timing (list) : An instance of list + """ + + if custom_timing is not None and not isinstance(custom_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_timing EXPECTED TYPE: list', None, None) + + self.__custom_timing = custom_timing + self.__key_modified['custom_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours_operations.py new file mode 100644 index 0000000..60b65dd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours_operations.py @@ -0,0 +1,136 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class BusinessHoursOperations(object): + def __init__(self, x_crm_org=None): + """ + Creates an instance of BusinessHoursOperations with the given parameters + + Parameters: + x_crm_org (string) : A string representing the x_crm_org + """ + + if x_crm_org is not None and not isinstance(x_crm_org, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_crm_org EXPECTED TYPE: str', None, None) + + self.__x_crm_org = x_crm_org + + + def create_business_hours(self, request): + """ + The method to create business hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.BusinessHours.CreateBusinessHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_business_hours(self, request): + """ + The method to update business hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours' + 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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.BusinessHours.UpdateBusinessHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_business_hours(self): + """ + The method to get business hours + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.BusinessHours.GetBusinessHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class CreateBusinessHoursHeader(object): + pass + + +class UpdateBusinessHoursHeader(object): + pass + + +class GetBusinessHoursHeader(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/features.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/features.py new file mode 100644 index 0000000..8a67822 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/features.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Features(object): + def __init__(self): + """Creates an instance of Features""" + + self.__name = None + self.__resources = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/resources.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/resources.py new file mode 100644 index 0000000..7f5586c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/resources.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resources(object): + def __init__(self): + """Creates an instance of Resources""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_wrapper.py new file mode 100644 index 0000000..d3adda7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__business_hours = None + self.__key_modified = dict() + + def get_business_hours(self): + """ + The method to get the business_hours + + Returns: + BusinessHours: An instance of BusinessHours + """ + + return self.__business_hours + + def set_business_hours(self, business_hours): + """ + The method to set the value to business_hours + + Parameters: + business_hours (BusinessHours) : An instance of BusinessHours + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.business_hours import BusinessHours + except Exception: + from .business_hours import BusinessHours + + if business_hours is not None and not isinstance(business_hours, BusinessHours): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_hours EXPECTED TYPE: BusinessHours', None, None) + + self.__business_hours = business_hours + self.__key_modified['business_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/success_response.py new file mode 100644 index 0000000..3bcdee5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/business_hours/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/__init__.py new file mode 100644 index 0000000..3e9e266 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/__init__.py @@ -0,0 +1,10 @@ +from .summary import Summary +from .api_exception import APIException +from .execution_detail import ExecutionDetail +from .unenroll_property import UnenrollProperty +from .module import Module +from .cadences import Cadences +from .user import User +from .execute_every import ExecuteEvery +from .custom_view import CustomView +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/api_exception.py new file mode 100644 index 0000000..bf32b2d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__details = None + self.__code = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/cadences.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/cadences.py new file mode 100644 index 0000000..d445b6c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/cadences.py @@ -0,0 +1,429 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Cadences(object): + def __init__(self): + """Creates an instance of Cadences""" + + self.__summary = None + self.__created_time = None + self.__module = None + self.__active = None + self.__execution_details = None + self.__published = None + self.__type = None + self.__created_by = None + self.__modified_time = None + self.__name = None + self.__modified_by = None + self.__id = None + self.__custom_view = None + self.__status = None + self.__key_modified = dict() + + def get_summary(self): + """ + The method to get the summary + + Returns: + Summary: An instance of Summary + """ + + return self.__summary + + def set_summary(self, summary): + """ + The method to set the value to summary + + Parameters: + summary (Summary) : An instance of Summary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.summary import Summary + except Exception: + from .summary import Summary + + if summary is not None and not isinstance(summary, Summary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: summary EXPECTED TYPE: Summary', None, None) + + self.__summary = summary + self.__key_modified['summary'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_execution_details(self): + """ + The method to get the execution_details + + Returns: + ExecutionDetail: An instance of ExecutionDetail + """ + + return self.__execution_details + + def set_execution_details(self, execution_details): + """ + The method to set the value to execution_details + + Parameters: + execution_details (ExecutionDetail) : An instance of ExecutionDetail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.execution_detail import ExecutionDetail + except Exception: + from .execution_detail import ExecutionDetail + + if execution_details is not None and not isinstance(execution_details, ExecutionDetail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execution_details EXPECTED TYPE: ExecutionDetail', None, None) + + self.__execution_details = execution_details + self.__key_modified['execution_details'] = 1 + + def get_published(self): + """ + The method to get the published + + Returns: + bool: A bool representing the published + """ + + return self.__published + + def set_published(self, published): + """ + The method to set the value to published + + Parameters: + published (bool) : A bool representing the published + """ + + if published is not None and not isinstance(published, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: published EXPECTED TYPE: bool', None, None) + + self.__published = published + self.__key_modified['published'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + string: A string representing the modified_time + """ + + return self.__modified_time + + def set_modified_time(self, modified_time): + """ + The method to set the value to modified_time + + Parameters: + modified_time (string) : A string representing the modified_time + """ + + if modified_time is not None and not isinstance(modified_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: str', None, None) + + self.__modified_time = modified_time + self.__key_modified['modified_time'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_custom_view(self): + """ + The method to get the custom_view + + Returns: + CustomView: An instance of CustomView + """ + + return self.__custom_view + + def set_custom_view(self, custom_view): + """ + The method to set the value to custom_view + + Parameters: + custom_view (CustomView) : An instance of CustomView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.custom_view import CustomView + except Exception: + from .custom_view import CustomView + + if custom_view is not None and not isinstance(custom_view, CustomView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_view EXPECTED TYPE: CustomView', None, None) + + self.__custom_view = custom_view + self.__key_modified['custom_view'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/custom_view.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/custom_view.py new file mode 100644 index 0000000..42b74d8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/custom_view.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CustomView(object): + def __init__(self): + """Creates an instance of CustomView""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/execute_every.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/execute_every.py new file mode 100644 index 0000000..934e499 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/execute_every.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExecuteEvery(object): + def __init__(self): + """Creates an instance of ExecuteEvery""" + + self.__unit = None + self.__period = None + self.__key_modified = dict() + + def get_unit(self): + """ + The method to get the unit + + Returns: + int: An int representing the unit + """ + + return self.__unit + + def set_unit(self, unit): + """ + The method to set the value to unit + + Parameters: + unit (int) : An int representing the unit + """ + + if unit is not None and not isinstance(unit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unit EXPECTED TYPE: int', None, None) + + self.__unit = unit + self.__key_modified['unit'] = 1 + + def get_period(self): + """ + The method to get the period + + Returns: + string: A string representing the period + """ + + return self.__period + + def set_period(self, period): + """ + The method to set the value to period + + Parameters: + period (string) : A string representing the period + """ + + if period is not None and not isinstance(period, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: period EXPECTED TYPE: str', None, None) + + self.__period = period + self.__key_modified['period'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/execution_detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/execution_detail.py new file mode 100644 index 0000000..af635d8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/execution_detail.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExecutionDetail(object): + def __init__(self): + """Creates an instance of ExecutionDetail""" + + self.__unenroll_properties = None + self.__end_date = None + self.__automatic_unenroll = None + self.__type = None + self.__execute_every = None + self.__key_modified = dict() + + def get_unenroll_properties(self): + """ + The method to get the unenroll_properties + + Returns: + UnenrollProperty: An instance of UnenrollProperty + """ + + return self.__unenroll_properties + + def set_unenroll_properties(self, unenroll_properties): + """ + The method to set the value to unenroll_properties + + Parameters: + unenroll_properties (UnenrollProperty) : An instance of UnenrollProperty + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.unenroll_property import UnenrollProperty + except Exception: + from .unenroll_property import UnenrollProperty + + if unenroll_properties is not None and not isinstance(unenroll_properties, UnenrollProperty): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unenroll_properties EXPECTED TYPE: UnenrollProperty', None, None) + + self.__unenroll_properties = unenroll_properties + self.__key_modified['unenroll_properties'] = 1 + + def get_end_date(self): + """ + The method to get the end_date + + Returns: + string: A string representing the end_date + """ + + return self.__end_date + + def set_end_date(self, end_date): + """ + The method to set the value to end_date + + Parameters: + end_date (string) : A string representing the end_date + """ + + if end_date is not None and not isinstance(end_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: end_date EXPECTED TYPE: str', None, None) + + self.__end_date = end_date + self.__key_modified['end_date'] = 1 + + def get_automatic_unenroll(self): + """ + The method to get the automatic_unenroll + + Returns: + bool: A bool representing the automatic_unenroll + """ + + return self.__automatic_unenroll + + def set_automatic_unenroll(self, automatic_unenroll): + """ + The method to set the value to automatic_unenroll + + Parameters: + automatic_unenroll (bool) : A bool representing the automatic_unenroll + """ + + if automatic_unenroll is not None and not isinstance(automatic_unenroll, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: automatic_unenroll EXPECTED TYPE: bool', None, None) + + self.__automatic_unenroll = automatic_unenroll + self.__key_modified['automatic_unenroll'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_execute_every(self): + """ + The method to get the execute_every + + Returns: + ExecuteEvery: An instance of ExecuteEvery + """ + + return self.__execute_every + + def set_execute_every(self, execute_every): + """ + The method to set the value to execute_every + + Parameters: + execute_every (ExecuteEvery) : An instance of ExecuteEvery + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.execute_every import ExecuteEvery + except Exception: + from .execute_every import ExecuteEvery + + if execute_every is not None and not isinstance(execute_every, ExecuteEvery): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execute_every EXPECTED TYPE: ExecuteEvery', None, None) + + self.__execute_every = execute_every + self.__key_modified['execute_every'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/summary.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/summary.py new file mode 100644 index 0000000..d5b7b8d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/summary.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Summary(object): + def __init__(self): + """Creates an instance of Summary""" + + self.__task_follow_up_count = None + self.__call_follow_up_count = None + self.__email_follow_up_count = None + self.__key_modified = dict() + + def get_task_follow_up_count(self): + """ + The method to get the task_follow_up_count + + Returns: + int: An int representing the task_follow_up_count + """ + + return self.__task_follow_up_count + + def set_task_follow_up_count(self, task_follow_up_count): + """ + The method to set the value to task_follow_up_count + + Parameters: + task_follow_up_count (int) : An int representing the task_follow_up_count + """ + + if task_follow_up_count is not None and not isinstance(task_follow_up_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: task_follow_up_count EXPECTED TYPE: int', None, None) + + self.__task_follow_up_count = task_follow_up_count + self.__key_modified['task_follow_up_count'] = 1 + + def get_call_follow_up_count(self): + """ + The method to get the call_follow_up_count + + Returns: + int: An int representing the call_follow_up_count + """ + + return self.__call_follow_up_count + + def set_call_follow_up_count(self, call_follow_up_count): + """ + The method to set the value to call_follow_up_count + + Parameters: + call_follow_up_count (int) : An int representing the call_follow_up_count + """ + + if call_follow_up_count is not None and not isinstance(call_follow_up_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call_follow_up_count EXPECTED TYPE: int', None, None) + + self.__call_follow_up_count = call_follow_up_count + self.__key_modified['call_follow_up_count'] = 1 + + def get_email_follow_up_count(self): + """ + The method to get the email_follow_up_count + + Returns: + int: An int representing the email_follow_up_count + """ + + return self.__email_follow_up_count + + def set_email_follow_up_count(self, email_follow_up_count): + """ + The method to set the value to email_follow_up_count + + Parameters: + email_follow_up_count (int) : An int representing the email_follow_up_count + """ + + if email_follow_up_count is not None and not isinstance(email_follow_up_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_follow_up_count EXPECTED TYPE: int', None, None) + + self.__email_follow_up_count = email_follow_up_count + self.__key_modified['email_follow_up_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/unenroll_property.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/unenroll_property.py new file mode 100644 index 0000000..91b96df --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/unenroll_property.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UnenrollProperty(object): + def __init__(self): + """Creates an instance of UnenrollProperty""" + + self.__end_date = None + self.__type = None + self.__key_modified = dict() + + def get_end_date(self): + """ + The method to get the end_date + + Returns: + string: A string representing the end_date + """ + + return self.__end_date + + def set_end_date(self, end_date): + """ + The method to set the value to end_date + + Parameters: + end_date (string) : A string representing the end_date + """ + + if end_date is not None and not isinstance(end_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: end_date EXPECTED TYPE: str', None, None) + + self.__end_date = end_date + self.__key_modified['end_date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/__init__.py new file mode 100644 index 0000000..34894c3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/__init__.py @@ -0,0 +1,19 @@ +from .template import Template +from .action_wrapper import ActionWrapper +from .cadences_analytics_get import CadencesAnalyticsGet +from .module import Module +from .body_wrapper import BodyWrapper +from .cadence import Cadence +from .analytics import Analytics +from .api_exception import APIException +from .analytics_task import AnalyticsTask +from .action_response import ActionResponse +from .parent_follow_up import ParentFollowUp +from .analytics_call import AnalyticsCall +from .success_response import SuccessResponse +from .action import Action +from .action_handler import ActionHandler +from .details import Details +from .cadences_execution_operations import CadencesExecutionOperations +from .analytics_alert import AnalyticsAlert +from .user import User diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action.py new file mode 100644 index 0000000..ffa6c11 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Action(object): + def __init__(self): + """Creates an instance of Action""" + + self.__details = None + self.__type = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + Details: An instance of Details + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Details) : An instance of Details + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.details import Details + except Exception: + from .details import Details + + if details is not None and not isinstance(details, Details): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Details', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_wrapper.py new file mode 100644 index 0000000..6309c25 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics.py new file mode 100644 index 0000000..ccedfa6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Analytics(object): + def __init__(self): + """Creates an instance of Analytics""" + + self.__analytics = None + self.__parent_follow_up = None + self.__action = None + self.__id = None + self.__key_modified = dict() + + def get_analytics(self): + """ + The method to get the analytics + + Returns: + dict: An instance of dict + """ + + return self.__analytics + + def set_analytics(self, analytics): + """ + The method to set the value to analytics + + Parameters: + analytics (dict) : An instance of dict + """ + + if analytics is not None and not isinstance(analytics, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics EXPECTED TYPE: dict', None, None) + + self.__analytics = analytics + self.__key_modified['analytics'] = 1 + + def get_parent_follow_up(self): + """ + The method to get the parent_follow_up + + Returns: + ParentFollowUp: An instance of ParentFollowUp + """ + + return self.__parent_follow_up + + def set_parent_follow_up(self, parent_follow_up): + """ + The method to set the value to parent_follow_up + + Parameters: + parent_follow_up (ParentFollowUp) : An instance of ParentFollowUp + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.parent_follow_up import ParentFollowUp + except Exception: + from .parent_follow_up import ParentFollowUp + + if parent_follow_up is not None and not isinstance(parent_follow_up, ParentFollowUp): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_follow_up EXPECTED TYPE: ParentFollowUp', None, None) + + self.__parent_follow_up = parent_follow_up + self.__key_modified['parent_follow_up'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + Action: An instance of Action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (Action) : An instance of Action + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action import Action + except Exception: + from .action import Action + + if action is not None and not isinstance(action, Action): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: Action', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_alert.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_alert.py new file mode 100644 index 0000000..0c96e31 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_alert.py @@ -0,0 +1,274 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsAlert(object): + def __init__(self): + """Creates an instance of AnalyticsAlert""" + + self.__email_count = None + self.__cliked_email_count = None + self.__bounced_email_count = None + self.__replied_email_count = None + self.__email_spam_count = None + self.__sent_email_count = None + self.__unsent_email_count = None + self.__opened_email_count = None + self.__unsubscribed_email_count = None + self.__key_modified = dict() + + def get_email_count(self): + """ + The method to get the email_count + + Returns: + int: An int representing the email_count + """ + + return self.__email_count + + def set_email_count(self, email_count): + """ + The method to set the value to email_count + + Parameters: + email_count (int) : An int representing the email_count + """ + + if email_count is not None and not isinstance(email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_count EXPECTED TYPE: int', None, None) + + self.__email_count = email_count + self.__key_modified['email_count'] = 1 + + def get_cliked_email_count(self): + """ + The method to get the cliked_email_count + + Returns: + int: An int representing the cliked_email_count + """ + + return self.__cliked_email_count + + def set_cliked_email_count(self, cliked_email_count): + """ + The method to set the value to cliked_email_count + + Parameters: + cliked_email_count (int) : An int representing the cliked_email_count + """ + + if cliked_email_count is not None and not isinstance(cliked_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cliked_email_count EXPECTED TYPE: int', None, None) + + self.__cliked_email_count = cliked_email_count + self.__key_modified['cliked_email_count'] = 1 + + def get_bounced_email_count(self): + """ + The method to get the bounced_email_count + + Returns: + int: An int representing the bounced_email_count + """ + + return self.__bounced_email_count + + def set_bounced_email_count(self, bounced_email_count): + """ + The method to set the value to bounced_email_count + + Parameters: + bounced_email_count (int) : An int representing the bounced_email_count + """ + + if bounced_email_count is not None and not isinstance(bounced_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced_email_count EXPECTED TYPE: int', None, None) + + self.__bounced_email_count = bounced_email_count + self.__key_modified['bounced_email_count'] = 1 + + def get_replied_email_count(self): + """ + The method to get the replied_email_count + + Returns: + int: An int representing the replied_email_count + """ + + return self.__replied_email_count + + def set_replied_email_count(self, replied_email_count): + """ + The method to set the value to replied_email_count + + Parameters: + replied_email_count (int) : An int representing the replied_email_count + """ + + if replied_email_count is not None and not isinstance(replied_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replied_email_count EXPECTED TYPE: int', None, None) + + self.__replied_email_count = replied_email_count + self.__key_modified['replied_email_count'] = 1 + + def get_email_spam_count(self): + """ + The method to get the email_spam_count + + Returns: + int: An int representing the email_spam_count + """ + + return self.__email_spam_count + + def set_email_spam_count(self, email_spam_count): + """ + The method to set the value to email_spam_count + + Parameters: + email_spam_count (int) : An int representing the email_spam_count + """ + + if email_spam_count is not None and not isinstance(email_spam_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_spam_count EXPECTED TYPE: int', None, None) + + self.__email_spam_count = email_spam_count + self.__key_modified['email_spam_count'] = 1 + + def get_sent_email_count(self): + """ + The method to get the sent_email_count + + Returns: + int: An int representing the sent_email_count + """ + + return self.__sent_email_count + + def set_sent_email_count(self, sent_email_count): + """ + The method to set the value to sent_email_count + + Parameters: + sent_email_count (int) : An int representing the sent_email_count + """ + + if sent_email_count is not None and not isinstance(sent_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent_email_count EXPECTED TYPE: int', None, None) + + self.__sent_email_count = sent_email_count + self.__key_modified['sent_email_count'] = 1 + + def get_unsent_email_count(self): + """ + The method to get the unsent_email_count + + Returns: + int: An int representing the unsent_email_count + """ + + return self.__unsent_email_count + + def set_unsent_email_count(self, unsent_email_count): + """ + The method to set the value to unsent_email_count + + Parameters: + unsent_email_count (int) : An int representing the unsent_email_count + """ + + if unsent_email_count is not None and not isinstance(unsent_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsent_email_count EXPECTED TYPE: int', None, None) + + self.__unsent_email_count = unsent_email_count + self.__key_modified['unsent_email_count'] = 1 + + def get_opened_email_count(self): + """ + The method to get the opened_email_count + + Returns: + int: An int representing the opened_email_count + """ + + return self.__opened_email_count + + def set_opened_email_count(self, opened_email_count): + """ + The method to set the value to opened_email_count + + Parameters: + opened_email_count (int) : An int representing the opened_email_count + """ + + if opened_email_count is not None and not isinstance(opened_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: opened_email_count EXPECTED TYPE: int', None, None) + + self.__opened_email_count = opened_email_count + self.__key_modified['opened_email_count'] = 1 + + def get_unsubscribed_email_count(self): + """ + The method to get the unsubscribed_email_count + + Returns: + int: An int representing the unsubscribed_email_count + """ + + return self.__unsubscribed_email_count + + def set_unsubscribed_email_count(self, unsubscribed_email_count): + """ + The method to set the value to unsubscribed_email_count + + Parameters: + unsubscribed_email_count (int) : An int representing the unsubscribed_email_count + """ + + if unsubscribed_email_count is not None and not isinstance(unsubscribed_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribed_email_count EXPECTED TYPE: int', None, None) + + self.__unsubscribed_email_count = unsubscribed_email_count + self.__key_modified['unsubscribed_email_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_call.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_call.py new file mode 100644 index 0000000..a313ddc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_call.py @@ -0,0 +1,249 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsCall(object): + def __init__(self): + """Creates an instance of AnalyticsCall""" + + self.__created_calls_count = None + self.__cancelled_calls_count = None + self.__failed_calls_count = None + self.__completed_calls_count = None + self.__scheduled_calls_count = None + self.__calls_count = None + self.__overdue_calls_count = None + self.__missed_calls_count = None + self.__key_modified = dict() + + def get_created_calls_count(self): + """ + The method to get the created_calls_count + + Returns: + int: An int representing the created_calls_count + """ + + return self.__created_calls_count + + def set_created_calls_count(self, created_calls_count): + """ + The method to set the value to created_calls_count + + Parameters: + created_calls_count (int) : An int representing the created_calls_count + """ + + if created_calls_count is not None and not isinstance(created_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_calls_count EXPECTED TYPE: int', None, None) + + self.__created_calls_count = created_calls_count + self.__key_modified['created_calls_count'] = 1 + + def get_cancelled_calls_count(self): + """ + The method to get the cancelled_calls_count + + Returns: + int: An int representing the cancelled_calls_count + """ + + return self.__cancelled_calls_count + + def set_cancelled_calls_count(self, cancelled_calls_count): + """ + The method to set the value to cancelled_calls_count + + Parameters: + cancelled_calls_count (int) : An int representing the cancelled_calls_count + """ + + if cancelled_calls_count is not None and not isinstance(cancelled_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cancelled_calls_count EXPECTED TYPE: int', None, None) + + self.__cancelled_calls_count = cancelled_calls_count + self.__key_modified['cancelled_calls_count'] = 1 + + def get_failed_calls_count(self): + """ + The method to get the failed_calls_count + + Returns: + int: An int representing the failed_calls_count + """ + + return self.__failed_calls_count + + def set_failed_calls_count(self, failed_calls_count): + """ + The method to set the value to failed_calls_count + + Parameters: + failed_calls_count (int) : An int representing the failed_calls_count + """ + + if failed_calls_count is not None and not isinstance(failed_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_calls_count EXPECTED TYPE: int', None, None) + + self.__failed_calls_count = failed_calls_count + self.__key_modified['failed_calls_count'] = 1 + + def get_completed_calls_count(self): + """ + The method to get the completed_calls_count + + Returns: + int: An int representing the completed_calls_count + """ + + return self.__completed_calls_count + + def set_completed_calls_count(self, completed_calls_count): + """ + The method to set the value to completed_calls_count + + Parameters: + completed_calls_count (int) : An int representing the completed_calls_count + """ + + if completed_calls_count is not None and not isinstance(completed_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: completed_calls_count EXPECTED TYPE: int', None, None) + + self.__completed_calls_count = completed_calls_count + self.__key_modified['completed_calls_count'] = 1 + + def get_scheduled_calls_count(self): + """ + The method to get the scheduled_calls_count + + Returns: + int: An int representing the scheduled_calls_count + """ + + return self.__scheduled_calls_count + + def set_scheduled_calls_count(self, scheduled_calls_count): + """ + The method to set the value to scheduled_calls_count + + Parameters: + scheduled_calls_count (int) : An int representing the scheduled_calls_count + """ + + if scheduled_calls_count is not None and not isinstance(scheduled_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduled_calls_count EXPECTED TYPE: int', None, None) + + self.__scheduled_calls_count = scheduled_calls_count + self.__key_modified['scheduled_calls_count'] = 1 + + def get_calls_count(self): + """ + The method to get the calls_count + + Returns: + int: An int representing the calls_count + """ + + return self.__calls_count + + def set_calls_count(self, calls_count): + """ + The method to set the value to calls_count + + Parameters: + calls_count (int) : An int representing the calls_count + """ + + if calls_count is not None and not isinstance(calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: calls_count EXPECTED TYPE: int', None, None) + + self.__calls_count = calls_count + self.__key_modified['calls_count'] = 1 + + def get_overdue_calls_count(self): + """ + The method to get the overdue_calls_count + + Returns: + int: An int representing the overdue_calls_count + """ + + return self.__overdue_calls_count + + def set_overdue_calls_count(self, overdue_calls_count): + """ + The method to set the value to overdue_calls_count + + Parameters: + overdue_calls_count (int) : An int representing the overdue_calls_count + """ + + if overdue_calls_count is not None and not isinstance(overdue_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: overdue_calls_count EXPECTED TYPE: int', None, None) + + self.__overdue_calls_count = overdue_calls_count + self.__key_modified['overdue_calls_count'] = 1 + + def get_missed_calls_count(self): + """ + The method to get the missed_calls_count + + Returns: + int: An int representing the missed_calls_count + """ + + return self.__missed_calls_count + + def set_missed_calls_count(self, missed_calls_count): + """ + The method to set the value to missed_calls_count + + Parameters: + missed_calls_count (int) : An int representing the missed_calls_count + """ + + if missed_calls_count is not None and not isinstance(missed_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: missed_calls_count EXPECTED TYPE: int', None, None) + + self.__missed_calls_count = missed_calls_count + self.__key_modified['missed_calls_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_task.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_task.py new file mode 100644 index 0000000..5580b94 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_task.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsTask(object): + def __init__(self): + """Creates an instance of AnalyticsTask""" + + self.__open_tasks_count = None + self.__failed_tasks_count = None + self.__subject = None + self.__completed_tasks_count = None + self.__created_tasks_count = None + self.__tasks_count = None + self.__key_modified = dict() + + def get_open_tasks_count(self): + """ + The method to get the open_tasks_count + + Returns: + int: An int representing the open_tasks_count + """ + + return self.__open_tasks_count + + def set_open_tasks_count(self, open_tasks_count): + """ + The method to set the value to open_tasks_count + + Parameters: + open_tasks_count (int) : An int representing the open_tasks_count + """ + + if open_tasks_count is not None and not isinstance(open_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: open_tasks_count EXPECTED TYPE: int', None, None) + + self.__open_tasks_count = open_tasks_count + self.__key_modified['open_tasks_count'] = 1 + + def get_failed_tasks_count(self): + """ + The method to get the failed_tasks_count + + Returns: + int: An int representing the failed_tasks_count + """ + + return self.__failed_tasks_count + + def set_failed_tasks_count(self, failed_tasks_count): + """ + The method to set the value to failed_tasks_count + + Parameters: + failed_tasks_count (int) : An int representing the failed_tasks_count + """ + + if failed_tasks_count is not None and not isinstance(failed_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_tasks_count EXPECTED TYPE: int', None, None) + + self.__failed_tasks_count = failed_tasks_count + self.__key_modified['failed_tasks_count'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_completed_tasks_count(self): + """ + The method to get the completed_tasks_count + + Returns: + int: An int representing the completed_tasks_count + """ + + return self.__completed_tasks_count + + def set_completed_tasks_count(self, completed_tasks_count): + """ + The method to set the value to completed_tasks_count + + Parameters: + completed_tasks_count (int) : An int representing the completed_tasks_count + """ + + if completed_tasks_count is not None and not isinstance(completed_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: completed_tasks_count EXPECTED TYPE: int', None, None) + + self.__completed_tasks_count = completed_tasks_count + self.__key_modified['completed_tasks_count'] = 1 + + def get_created_tasks_count(self): + """ + The method to get the created_tasks_count + + Returns: + int: An int representing the created_tasks_count + """ + + return self.__created_tasks_count + + def set_created_tasks_count(self, created_tasks_count): + """ + The method to set the value to created_tasks_count + + Parameters: + created_tasks_count (int) : An int representing the created_tasks_count + """ + + if created_tasks_count is not None and not isinstance(created_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_tasks_count EXPECTED TYPE: int', None, None) + + self.__created_tasks_count = created_tasks_count + self.__key_modified['created_tasks_count'] = 1 + + def get_tasks_count(self): + """ + The method to get the tasks_count + + Returns: + int: An int representing the tasks_count + """ + + return self.__tasks_count + + def set_tasks_count(self, tasks_count): + """ + The method to set the value to tasks_count + + Parameters: + tasks_count (int) : An int representing the tasks_count + """ + + if tasks_count is not None and not isinstance(tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tasks_count EXPECTED TYPE: int', None, None) + + self.__tasks_count = tasks_count + self.__key_modified['tasks_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/api_exception.py new file mode 100644 index 0000000..5b00143 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__details = None + self.__code = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/body_wrapper.py new file mode 100644 index 0000000..2c91d7c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/body_wrapper.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__cadences_ids = None + self.__ids = None + self.__key_modified = dict() + + def get_cadences_ids(self): + """ + The method to get the cadences_ids + + Returns: + list: An instance of list + """ + + return self.__cadences_ids + + def set_cadences_ids(self, cadences_ids): + """ + The method to set the value to cadences_ids + + Parameters: + cadences_ids (list) : An instance of list + """ + + if cadences_ids is not None and not isinstance(cadences_ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cadences_ids EXPECTED TYPE: list', None, None) + + self.__cadences_ids = cadences_ids + self.__key_modified['cadences_ids'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadence.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadence.py new file mode 100644 index 0000000..98734b5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadence.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Cadence(object): + def __init__(self): + """Creates an instance of Cadence""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_analytics_get.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_analytics_get.py new file mode 100644 index 0000000..7e59bba --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_analytics_get.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CadencesAnalyticsGet(object): + def __init__(self): + """Creates an instance of CadencesAnalyticsGet""" + + self.__module = None + self.__name = None + self.__follow_ups = None + self.__id = None + self.__created_by = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_follow_ups(self): + """ + The method to get the follow_ups + + Returns: + list: An instance of list + """ + + return self.__follow_ups + + def set_follow_ups(self, follow_ups): + """ + The method to set the value to follow_ups + + Parameters: + follow_ups (list) : An instance of list + """ + + if follow_ups is not None and not isinstance(follow_ups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: follow_ups EXPECTED TYPE: list', None, None) + + self.__follow_ups = follow_ups + self.__key_modified['follow_ups'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_execution_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_execution_operations.py new file mode 100644 index 0000000..a4d93e1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_execution_operations.py @@ -0,0 +1,96 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CadencesExecutionOperations(object): + def __init__(self): + """Creates an instance of CadencesExecutionOperations""" + pass + + def enrol_cadences(self, module, request): + """ + The method to enrol cadences + + Parameters: + module (string) : A string representing the module + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/enrol_in_cadences' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def unenrol_cadences(self, module, request): + """ + The method to unenrol cadences + + Parameters: + module (string) : A string representing the module + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/unenrol_from_cadences' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/details.py new file mode 100644 index 0000000..1098293 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/details.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Details(object): + def __init__(self): + """Creates an instance of Details""" + + self.__name = None + self.__template = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_template(self): + """ + The method to get the template + + Returns: + Template: An instance of Template + """ + + return self.__template + + def set_template(self, template): + """ + The method to set the value to template + + Parameters: + template (Template) : An instance of Template + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.template import Template + except Exception: + from .template import Template + + if template is not None and not isinstance(template, Template): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: Template', None, None) + + self.__template = template + self.__key_modified['template'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/parent_follow_up.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/parent_follow_up.py new file mode 100644 index 0000000..bf47cc4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/parent_follow_up.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ParentFollowUp(object): + def __init__(self): + """Creates an instance of ParentFollowUp""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/success_response.py new file mode 100644 index 0000000..e961867 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/template.py new file mode 100644 index 0000000..5310677 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Template(object): + def __init__(self): + """Creates an instance of Template""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/__init__.py new file mode 100644 index 0000000..5fdcd31 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/__init__.py @@ -0,0 +1,8 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .cancel_meetings_operations import CancelMeetingsOperations +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .notify import Notify diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_wrapper.py new file mode 100644 index 0000000..4414c02 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/api_exception.py new file mode 100644 index 0000000..938098f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/cancel_meetings_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/cancel_meetings_operations.py new file mode 100644 index 0000000..3f43c62 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/cancel_meetings_operations.py @@ -0,0 +1,60 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CancelMeetingsOperations(object): + def __init__(self, event): + """ + Creates an instance of CancelMeetingsOperations with the given parameters + + Parameters: + event (int) : An int representing the event + """ + + if not isinstance(event, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: event EXPECTED TYPE: int', None, None) + + self.__event = event + + + def cancel_meetings(self, request): + """ + The method to cancel meetings + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Events/' + api_path = api_path + str(self.__event) + api_path = api_path + '/actions/cancel' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/notify.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/notify.py new file mode 100644 index 0000000..b8d53be --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/notify.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Notify(object): + def __init__(self): + """Creates an instance of Notify""" + + self.__send_cancelling_mail = None + self.__key_modified = dict() + + def get_send_cancelling_mail(self): + """ + The method to get the send_cancelling_mail + + Returns: + bool: A bool representing the send_cancelling_mail + """ + + return self.__send_cancelling_mail + + def set_send_cancelling_mail(self, send_cancelling_mail): + """ + The method to set the value to send_cancelling_mail + + Parameters: + send_cancelling_mail (bool) : A bool representing the send_cancelling_mail + """ + + if send_cancelling_mail is not None and not isinstance(send_cancelling_mail, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: send_cancelling_mail EXPECTED TYPE: bool', None, None) + + self.__send_cancelling_mail = send_cancelling_mail + self.__key_modified['send_cancelling_mail'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/success_response.py new file mode 100644 index 0000000..9401e98 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/__init__.py new file mode 100644 index 0000000..55b6d7c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/__init__.py @@ -0,0 +1,11 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .mass_wrapper import MassWrapper +from .related_modules import RelatedModules +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .change_owner_operations import ChangeOwnerOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_wrapper.py new file mode 100644 index 0000000..f140f8e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/api_exception.py new file mode 100644 index 0000000..292749a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/body_wrapper.py new file mode 100644 index 0000000..a59913a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/body_wrapper.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__owner = None + self.__notify = None + self.__related_modules = None + self.__key_modified = dict() + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/change_owner_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/change_owner_operations.py new file mode 100644 index 0000000..e188e76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/change_owner_operations.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class ChangeOwnerOperations(object): + def __init__(self, module): + """ + Creates an instance of ChangeOwnerOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def single_update(self, id, request): + """ + The method to single update + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def mass_update(self, request): + """ + The method to mass update + + Parameters: + request (MassWrapper) : An instance of MassWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.mass_wrapper import MassWrapper + except Exception: + from .mass_wrapper import MassWrapper + + if request is not None and not isinstance(request, MassWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MassWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/error_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/mass_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/mass_wrapper.py new file mode 100644 index 0000000..306153b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/mass_wrapper.py @@ -0,0 +1,157 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.body_wrapper import BodyWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .body_wrapper import BodyWrapper + + +class MassWrapper(BodyWrapper): + def __init__(self): + """Creates an instance of MassWrapper""" + super().__init__() + + self.__ids = None + self.__owner = None + self.__notify = None + self.__related_modules = None + self.__key_modified = dict() + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/owner.py new file mode 100644 index 0000000..ce08ac7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/owner.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/related_modules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/related_modules.py new file mode 100644 index 0000000..bfec35e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/related_modules.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedModules(object): + def __init__(self): + """Creates an instance of RelatedModules""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/success_response.py new file mode 100644 index 0000000..f51a807 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/change_owner/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/__init__.py new file mode 100644 index 0000000..21063f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .contact_roles_operations import ContactRolesOperations, DeleteContactRolesParam +from .contact_role import ContactRole diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_wrapper.py new file mode 100644 index 0000000..190af05 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__contact_roles = None + self.__key_modified = dict() + + def get_contact_roles(self): + """ + The method to get the contact_roles + + Returns: + list: An instance of list + """ + + return self.__contact_roles + + def set_contact_roles(self, contact_roles): + """ + The method to set the value to contact_roles + + Parameters: + contact_roles (list) : An instance of list + """ + + if contact_roles is not None and not isinstance(contact_roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_roles EXPECTED TYPE: list', None, None) + + self.__contact_roles = contact_roles + self.__key_modified['contact_roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/api_exception.py new file mode 100644 index 0000000..64e5910 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/body_wrapper.py new file mode 100644 index 0000000..528e254 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__contact_roles = None + self.__key_modified = dict() + + def get_contact_roles(self): + """ + The method to get the contact_roles + + Returns: + list: An instance of list + """ + + return self.__contact_roles + + def set_contact_roles(self, contact_roles): + """ + The method to set the value to contact_roles + + Parameters: + contact_roles (list) : An instance of list + """ + + if contact_roles is not None and not isinstance(contact_roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_roles EXPECTED TYPE: list', None, None) + + self.__contact_roles = contact_roles + self.__key_modified['contact_roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_role.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_role.py new file mode 100644 index 0000000..35994d1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_role.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ContactRole(object): + def __init__(self): + """Creates an instance of ContactRole""" + + self.__id = None + self.__name = None + self.__sequence_number = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_roles_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_roles_operations.py new file mode 100644 index 0000000..b05120f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_roles_operations.py @@ -0,0 +1,251 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class ContactRolesOperations(object): + def __init__(self): + """Creates an instance of ContactRolesOperations""" + pass + + def get_roles(self): + """ + The method to get roles + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Contacts/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_roles(self, request): + """ + The method to create roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Contacts/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_roles(self, request): + """ + The method to update roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Contacts/roles' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_contact_roles(self, param_instance=None): + """ + The method to delete contact roles + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Contacts/roles' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_role(self, id): + """ + The method to get role + + 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/v7/Contacts/roles/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_contact_role(self, id, request): + """ + The method to update contact role + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/Contacts/roles/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_contact_role(self, id): + """ + The method to delete contact role + + 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/v7/Contacts/roles/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class DeleteContactRolesParam(object): + ids = Param('ids', 'com.zoho.crm.api.ContactRoles.DeleteContactRolesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_wrapper.py new file mode 100644 index 0000000..4938416 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__contact_roles = None + self.__key_modified = dict() + + def get_contact_roles(self): + """ + The method to get the contact_roles + + Returns: + list: An instance of list + """ + + return self.__contact_roles + + def set_contact_roles(self, contact_roles): + """ + The method to set the value to contact_roles + + Parameters: + contact_roles (list) : An instance of list + """ + + if contact_roles is not None and not isinstance(contact_roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_roles EXPECTED TYPE: list', None, None) + + self.__contact_roles = contact_roles + self.__key_modified['contact_roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/success_response.py new file mode 100644 index 0000000..ba84af0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/contact_roles/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/__init__.py new file mode 100644 index 0000000..f4f47db --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/__init__.py @@ -0,0 +1,8 @@ +from .preference_field_match import PreferenceFieldMatch +from .api_exception import APIException +from .response_handler import ResponseHandler +from .field import Field +from .conversion_option_operations import ConversionOptionOperations +from .response_wrapper import ResponseWrapper +from .preference_field_matched_value import PreferenceFieldMatchedValue +from .conversion_options import ConversionOptions diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/api_exception.py new file mode 100644 index 0000000..9866456 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_option_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_option_operations.py new file mode 100644 index 0000000..6a6b2a8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_option_operations.py @@ -0,0 +1,49 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + + +class ConversionOptionOperations(object): + def __init__(self, lead_id): + """ + Creates an instance of ConversionOptionOperations with the given parameters + + Parameters: + lead_id (int) : An int representing the lead_id + """ + + if not isinstance(lead_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lead_id EXPECTED TYPE: int', None, None) + + self.__lead_id = lead_id + + + def lead_conversion_options(self): + """ + The method to lead conversion options + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Leads/' + api_path = api_path + str(self.__lead_id) + api_path = api_path + '/__conversion_options' + 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.set_module_api_name("Leads") + Utility.get_fields("Leads,Contacts,Deals,Accounts", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_options.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_options.py new file mode 100644 index 0000000..505ff9d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_options.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConversionOptions(object): + def __init__(self): + """Creates an instance of ConversionOptions""" + + self.__module_preference = None + self.__contacts = None + self.__deals = None + self.__accounts = None + self.__preference_field_matched_value = None + self.__modules_with_multiple_layouts = None + self.__key_modified = dict() + + def get_module_preference(self): + """ + The method to get the module_preference + + Returns: + Modules: An instance of Modules + """ + + return self.__module_preference + + def set_module_preference(self, module_preference): + """ + The method to set the value to module_preference + + Parameters: + module_preference (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import Modules + except Exception: + from ..modules import Modules + + if module_preference is not None and not isinstance(module_preference, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_preference EXPECTED TYPE: Modules', None, None) + + self.__module_preference = module_preference + self.__key_modified['module_preference'] = 1 + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + list: An instance of list + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (list) : An instance of list + """ + + if contacts is not None and not isinstance(contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: list', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + list: An instance of list + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (list) : An instance of list + """ + + if deals is not None and not isinstance(deals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: list', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + list: An instance of list + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (list) : An instance of list + """ + + if accounts is not None and not isinstance(accounts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: list', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_preference_field_matched_value(self): + """ + The method to get the preference_field_matched_value + + Returns: + PreferenceFieldMatchedValue: An instance of PreferenceFieldMatchedValue + """ + + return self.__preference_field_matched_value + + def set_preference_field_matched_value(self, preference_field_matched_value): + """ + The method to set the value to preference_field_matched_value + + Parameters: + preference_field_matched_value (PreferenceFieldMatchedValue) : An instance of PreferenceFieldMatchedValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.preference_field_matched_value import PreferenceFieldMatchedValue + except Exception: + from .preference_field_matched_value import PreferenceFieldMatchedValue + + if preference_field_matched_value is not None and not isinstance(preference_field_matched_value, PreferenceFieldMatchedValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preference_field_matched_value EXPECTED TYPE: PreferenceFieldMatchedValue', None, None) + + self.__preference_field_matched_value = preference_field_matched_value + self.__key_modified['preference_field_matched_value'] = 1 + + def get_modules_with_multiple_layouts(self): + """ + The method to get the modules_with_multiple_layouts + + Returns: + list: An instance of list + """ + + return self.__modules_with_multiple_layouts + + def set_modules_with_multiple_layouts(self, modules_with_multiple_layouts): + """ + The method to set the value to modules_with_multiple_layouts + + Parameters: + modules_with_multiple_layouts (list) : An instance of list + """ + + if modules_with_multiple_layouts is not None and not isinstance(modules_with_multiple_layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules_with_multiple_layouts EXPECTED TYPE: list', None, None) + + self.__modules_with_multiple_layouts = modules_with_multiple_layouts + self.__key_modified['modules_with_multiple_layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_match.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_match.py new file mode 100644 index 0000000..10638e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_match.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PreferenceFieldMatch(object): + def __init__(self): + """Creates an instance of PreferenceFieldMatch""" + + self.__field = None + self.__matched_lead_value = None + self.__key_modified = dict() + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_matched_lead_value(self): + """ + The method to get the matched_lead_value + + Returns: + string: A string representing the matched_lead_value + """ + + return self.__matched_lead_value + + def set_matched_lead_value(self, matched_lead_value): + """ + The method to set the value to matched_lead_value + + Parameters: + matched_lead_value (string) : A string representing the matched_lead_value + """ + + if matched_lead_value is not None and not isinstance(matched_lead_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: matched_lead_value EXPECTED TYPE: str', None, None) + + self.__matched_lead_value = matched_lead_value + self.__key_modified['matched_lead_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_matched_value.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_matched_value.py new file mode 100644 index 0000000..593eed9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_matched_value.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PreferenceFieldMatchedValue(object): + def __init__(self): + """Creates an instance of PreferenceFieldMatchedValue""" + + self.__contacts = None + self.__accounts = None + self.__deals = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + list: An instance of list + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (list) : An instance of list + """ + + if contacts is not None and not isinstance(contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: list', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + list: An instance of list + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (list) : An instance of list + """ + + if accounts is not None and not isinstance(accounts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: list', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + list: An instance of list + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (list) : An instance of list + """ + + if deals is not None and not isinstance(deals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: list', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_wrapper.py new file mode 100644 index 0000000..ba127ce --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__conversionoptions = None + self.__key_modified = dict() + + def get_conversionoptions(self): + """ + The method to get the conversionoptions + + Returns: + ConversionOptions: An instance of ConversionOptions + """ + + return self.__conversionoptions + + def set_conversionoptions(self, conversionoptions): + """ + The method to set the value to conversionoptions + + Parameters: + conversionoptions (ConversionOptions) : An instance of ConversionOptions + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.conversion_options import ConversionOptions + except Exception: + from .conversion_options import ConversionOptions + + if conversionoptions is not None and not isinstance(conversionoptions, ConversionOptions): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: conversionoptions EXPECTED TYPE: ConversionOptions', None, None) + + self.__conversionoptions = conversionoptions + self.__key_modified['__conversion_options'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/__init__.py new file mode 100644 index 0000000..e2f0f29 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .carry_over_tags import CarryOverTags +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .convert_lead_operations import ConvertLeadOperations +from .lead_converter import LeadConverter +from .move_attachments_to import MoveAttachmentsTo diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_wrapper.py new file mode 100644 index 0000000..8c0be4f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/api_exception.py new file mode 100644 index 0000000..1406dcd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/carry_over_tags.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/carry_over_tags.py new file mode 100644 index 0000000..3835cdb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/carry_over_tags.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CarryOverTags(object): + def __init__(self): + """Creates an instance of CarryOverTags""" + + self.__contacts = None + self.__accounts = None + self.__deals = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + list: An instance of list + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (list) : An instance of list + """ + + if contacts is not None and not isinstance(contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: list', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + list: An instance of list + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (list) : An instance of list + """ + + if accounts is not None and not isinstance(accounts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: list', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + list: An instance of list + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (list) : An instance of list + """ + + if deals is not None and not isinstance(deals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: list', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/convert_lead_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/convert_lead_operations.py new file mode 100644 index 0000000..b85883d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/convert_lead_operations.py @@ -0,0 +1,63 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + + +class ConvertLeadOperations(object): + def __init__(self, lead_id): + """ + Creates an instance of ConvertLeadOperations with the given parameters + + Parameters: + lead_id (int) : An int representing the lead_id + """ + + if not isinstance(lead_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lead_id EXPECTED TYPE: int', None, None) + + self.__lead_id = lead_id + + + def convert_lead(self, request): + """ + The method to convert lead + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Leads/' + api_path = api_path + str(self.__lead_id) + api_path = api_path + '/actions/convert' + 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.set_module_api_name("Deals") + Utility.get_fields("Deals", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/lead_converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/lead_converter.py new file mode 100644 index 0000000..d51199f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/lead_converter.py @@ -0,0 +1,329 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class LeadConverter(object): + def __init__(self): + """Creates an instance of LeadConverter""" + + self.__overwrite = None + self.__notify_lead_owner = None + self.__notify_new_entity_owner = None + self.__move_attachments_to = None + self.__accounts = None + self.__contacts = None + self.__assign_to = None + self.__deals = None + self.__add_to_existing_record = None + self.__carry_over_tags = None + self.__key_modified = dict() + + def get_overwrite(self): + """ + The method to get the overwrite + + Returns: + bool: A bool representing the overwrite + """ + + return self.__overwrite + + def set_overwrite(self, overwrite): + """ + The method to set the value to overwrite + + Parameters: + overwrite (bool) : A bool representing the overwrite + """ + + if overwrite is not None and not isinstance(overwrite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: overwrite EXPECTED TYPE: bool', None, None) + + self.__overwrite = overwrite + self.__key_modified['overwrite'] = 1 + + def get_notify_lead_owner(self): + """ + The method to get the notify_lead_owner + + Returns: + bool: A bool representing the notify_lead_owner + """ + + return self.__notify_lead_owner + + def set_notify_lead_owner(self, notify_lead_owner): + """ + The method to set the value to notify_lead_owner + + Parameters: + notify_lead_owner (bool) : A bool representing the notify_lead_owner + """ + + if notify_lead_owner is not None and not isinstance(notify_lead_owner, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_lead_owner EXPECTED TYPE: bool', None, None) + + self.__notify_lead_owner = notify_lead_owner + self.__key_modified['notify_lead_owner'] = 1 + + def get_notify_new_entity_owner(self): + """ + The method to get the notify_new_entity_owner + + Returns: + bool: A bool representing the notify_new_entity_owner + """ + + return self.__notify_new_entity_owner + + def set_notify_new_entity_owner(self, notify_new_entity_owner): + """ + The method to set the value to notify_new_entity_owner + + Parameters: + notify_new_entity_owner (bool) : A bool representing the notify_new_entity_owner + """ + + if notify_new_entity_owner is not None and not isinstance(notify_new_entity_owner, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_new_entity_owner EXPECTED TYPE: bool', None, None) + + self.__notify_new_entity_owner = notify_new_entity_owner + self.__key_modified['notify_new_entity_owner'] = 1 + + def get_move_attachments_to(self): + """ + The method to get the move_attachments_to + + Returns: + MoveAttachmentsTo: An instance of MoveAttachmentsTo + """ + + return self.__move_attachments_to + + def set_move_attachments_to(self, move_attachments_to): + """ + The method to set the value to move_attachments_to + + Parameters: + move_attachments_to (MoveAttachmentsTo) : An instance of MoveAttachmentsTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.move_attachments_to import MoveAttachmentsTo + except Exception: + from .move_attachments_to import MoveAttachmentsTo + + if move_attachments_to is not None and not isinstance(move_attachments_to, MoveAttachmentsTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_attachments_to EXPECTED TYPE: MoveAttachmentsTo', None, None) + + self.__move_attachments_to = move_attachments_to + self.__key_modified['move_attachments_to'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + Record: An instance of Record + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if accounts is not None and not isinstance(accounts, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: Record', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + Record: An instance of Record + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if contacts is not None and not isinstance(contacts, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: Record', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_assign_to(self): + """ + The method to get the assign_to + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__assign_to + + def set_assign_to(self, assign_to): + """ + The method to set the value to assign_to + + Parameters: + assign_to (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if assign_to is not None and not isinstance(assign_to, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assign_to EXPECTED TYPE: MinifiedUser', None, None) + + self.__assign_to = assign_to + self.__key_modified['assign_to'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + Record: An instance of Record + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if deals is not None and not isinstance(deals, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: Record', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_add_to_existing_record(self): + """ + The method to get the add_to_existing_record + + Returns: + Choice: An instance of Choice + """ + + return self.__add_to_existing_record + + def set_add_to_existing_record(self, add_to_existing_record): + """ + The method to set the value to add_to_existing_record + + Parameters: + add_to_existing_record (Choice) : An instance of Choice + """ + + if add_to_existing_record is not None and not isinstance(add_to_existing_record, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: add_to_existing_record EXPECTED TYPE: Choice', None, None) + + self.__add_to_existing_record = add_to_existing_record + self.__key_modified['add_to_existing_record'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + CarryOverTags: An instance of CarryOverTags + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (CarryOverTags) : An instance of CarryOverTags + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.carry_over_tags import CarryOverTags + except Exception: + from .carry_over_tags import CarryOverTags + + if carry_over_tags is not None and not isinstance(carry_over_tags, CarryOverTags): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: CarryOverTags', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/move_attachments_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/move_attachments_to.py new file mode 100644 index 0000000..8bd9065 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/move_attachments_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MoveAttachmentsTo(object): + def __init__(self): + """Creates an instance of MoveAttachmentsTo""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/success_response.py new file mode 100644 index 0000000..40b6b37 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/convert_lead/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/__init__.py new file mode 100644 index 0000000..3b3a9e7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/__init__.py @@ -0,0 +1,8 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .details_wrapper import DetailsWrapper +from .clause_details import ClauseDetails +from .parse_error_details import ParseErrorDetails +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .coql_operations import CoqlOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/api_exception.py new file mode 100644 index 0000000..6fc6964 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/body_wrapper.py new file mode 100644 index 0000000..5fc1dcc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__select_query = None + self.__key_modified = dict() + + def get_select_query(self): + """ + The method to get the select_query + + Returns: + string: A string representing the select_query + """ + + return self.__select_query + + def set_select_query(self, select_query): + """ + The method to set the value to select_query + + Parameters: + select_query (string) : A string representing the select_query + """ + + if select_query is not None and not isinstance(select_query, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: select_query EXPECTED TYPE: str', None, None) + + self.__select_query = select_query + self.__key_modified['select_query'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/clause_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/clause_details.py new file mode 100644 index 0000000..b465f0d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/clause_details.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.details_wrapper import DetailsWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .details_wrapper import DetailsWrapper + + +class ClauseDetails(DetailsWrapper): + def __init__(self): + """Creates an instance of ClauseDetails""" + super().__init__() + + self.__clause = None + self.__key_modified = dict() + + def get_clause(self): + """ + The method to get the clause + + Returns: + string: A string representing the clause + """ + + return self.__clause + + def set_clause(self, clause): + """ + The method to set the value to clause + + Parameters: + clause (string) : A string representing the clause + """ + + if clause is not None and not isinstance(clause, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: clause EXPECTED TYPE: str', None, None) + + self.__clause = clause + self.__key_modified['clause'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/coql_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/coql_operations.py new file mode 100644 index 0000000..0f916bc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/coql_operations.py @@ -0,0 +1,48 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CoqlOperations(object): + def __init__(self): + """Creates an instance of CoqlOperations""" + pass + + def get_records(self, request): + """ + The method to get records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.coql.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/coql' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.coql.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/details_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/details_wrapper.py new file mode 100644 index 0000000..80f6b69 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/details_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DetailsWrapper(ABC): + def __init__(self): + """Creates an instance of DetailsWrapper""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/parse_error_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/parse_error_details.py new file mode 100644 index 0000000..115a08a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/parse_error_details.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.details_wrapper import DetailsWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .details_wrapper import DetailsWrapper + + +class ParseErrorDetails(DetailsWrapper): + def __init__(self): + """Creates an instance of ParseErrorDetails""" + super().__init__() + + self.__line = None + self.__column = None + self.__near = None + self.__key_modified = dict() + + def get_line(self): + """ + The method to get the line + + Returns: + int: An int representing the line + """ + + return self.__line + + def set_line(self, line): + """ + The method to set the value to line + + Parameters: + line (int) : An int representing the line + """ + + if line is not None and not isinstance(line, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: line EXPECTED TYPE: int', None, None) + + self.__line = line + self.__key_modified['line'] = 1 + + def get_column(self): + """ + The method to get the column + + Returns: + int: An int representing the column + """ + + return self.__column + + def set_column(self, column): + """ + The method to set the value to column + + Parameters: + column (int) : An int representing the column + """ + + if column is not None and not isinstance(column, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: int', None, None) + + self.__column = column + self.__key_modified['column'] = 1 + + def get_near(self): + """ + The method to get the near + + Returns: + string: A string representing the near + """ + + return self.__near + + def set_near(self, near): + """ + The method to set the value to near + + Parameters: + near (string) : A string representing the near + """ + + if near is not None and not isinstance(near, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: near EXPECTED TYPE: str', None, None) + + self.__near = near + self.__key_modified['near'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/response_wrapper.py new file mode 100644 index 0000000..39fc48c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/coql/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Info + except Exception: + from ..record import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/__init__.py new file mode 100644 index 0000000..5e1b01e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/__init__.py @@ -0,0 +1,16 @@ +from .base_currency import BaseCurrency +from .action_wrapper import ActionWrapper +from .base_currency_action_response import BaseCurrencyActionResponse +from .base_currency_wrapper import BaseCurrencyWrapper +from .currencies_operations import CurrenciesOperations +from .format import Format +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .base_currency_action_wrapper import BaseCurrencyActionWrapper +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .currency import Currency +from .action_handler import ActionHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_wrapper.py new file mode 100644 index 0000000..e3038a6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__currencies = None + self.__key_modified = dict() + + def get_currencies(self): + """ + The method to get the currencies + + Returns: + list: An instance of list + """ + + return self.__currencies + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/api_exception.py new file mode 100644 index 0000000..4680b76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_action_response import BaseCurrencyActionResponse + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .base_currency_action_response import BaseCurrencyActionResponse + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(BaseCurrencyActionResponse, ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency.py new file mode 100644 index 0000000..2b4dbac --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency.py @@ -0,0 +1,393 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BaseCurrency(object): + def __init__(self): + """Creates an instance of BaseCurrency""" + + self.__iso_code = None + self.__symbol = None + self.__created_time = None + self.__is_active = None + self.__exchange_rate = None + self.__format = None + self.__created_by = None + self.__prefix_symbol = None + self.__is_base = None + self.__modified_time = None + self.__name = None + self.__modified_by = None + self.__id = None + self.__key_modified = dict() + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_symbol(self): + """ + The method to get the symbol + + Returns: + string: A string representing the symbol + """ + + return self.__symbol + + def set_symbol(self, symbol): + """ + The method to set the value to symbol + + Parameters: + symbol (string) : A string representing the symbol + """ + + if symbol is not None and not isinstance(symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: str', None, None) + + self.__symbol = symbol + self.__key_modified['symbol'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_is_active(self): + """ + The method to get the is_active + + Returns: + bool: A bool representing the is_active + """ + + return self.__is_active + + def set_is_active(self, is_active): + """ + The method to set the value to is_active + + Parameters: + is_active (bool) : A bool representing the is_active + """ + + if is_active is not None and not isinstance(is_active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_active EXPECTED TYPE: bool', None, None) + + self.__is_active = is_active + self.__key_modified['is_active'] = 1 + + def get_exchange_rate(self): + """ + The method to get the exchange_rate + + Returns: + string: A string representing the exchange_rate + """ + + return self.__exchange_rate + + def set_exchange_rate(self, exchange_rate): + """ + The method to set the value to exchange_rate + + Parameters: + exchange_rate (string) : A string representing the exchange_rate + """ + + if exchange_rate is not None and not isinstance(exchange_rate, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exchange_rate EXPECTED TYPE: str', None, None) + + self.__exchange_rate = exchange_rate + self.__key_modified['exchange_rate'] = 1 + + def get_format(self): + """ + The method to get the format + + Returns: + Format: An instance of Format + """ + + return self.__format + + def set_format(self, format): + """ + The method to set the value to format + + Parameters: + format (Format) : An instance of Format + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.format import Format + except Exception: + from .format import Format + + if format is not None and not isinstance(format, Format): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: Format', None, None) + + self.__format = format + self.__key_modified['format'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_prefix_symbol(self): + """ + The method to get the prefix_symbol + + Returns: + bool: A bool representing the prefix_symbol + """ + + return self.__prefix_symbol + + def set_prefix_symbol(self, prefix_symbol): + """ + The method to set the value to prefix_symbol + + Parameters: + prefix_symbol (bool) : A bool representing the prefix_symbol + """ + + if prefix_symbol is not None and not isinstance(prefix_symbol, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix_symbol EXPECTED TYPE: bool', None, None) + + self.__prefix_symbol = prefix_symbol + self.__key_modified['prefix_symbol'] = 1 + + def get_is_base(self): + """ + The method to get the is_base + + Returns: + bool: A bool representing the is_base + """ + + return self.__is_base + + def set_is_base(self, is_base): + """ + The method to set the value to is_base + + Parameters: + is_base (bool) : A bool representing the is_base + """ + + if is_base is not None and not isinstance(is_base, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_base EXPECTED TYPE: bool', None, None) + + self.__is_base = is_base + self.__key_modified['is_base'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_response.py new file mode 100644 index 0000000..f29b04b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class BaseCurrencyActionResponse(ABC): + def __init__(self): + """Creates an instance of BaseCurrencyActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.py new file mode 100644 index 0000000..bbe934e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class BaseCurrencyActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of BaseCurrencyActionWrapper""" + super().__init__() + + self.__base_currency = None + self.__key_modified = dict() + + def get_base_currency(self): + """ + The method to get the base_currency + + Returns: + BaseCurrencyActionResponse: An instance of BaseCurrencyActionResponse + """ + + return self.__base_currency + + def set_base_currency(self, base_currency): + """ + The method to set the value to base_currency + + Parameters: + base_currency (BaseCurrencyActionResponse) : An instance of BaseCurrencyActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_action_response import BaseCurrencyActionResponse + except Exception: + from .base_currency_action_response import BaseCurrencyActionResponse + + if base_currency is not None and not isinstance(base_currency, BaseCurrencyActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: base_currency EXPECTED TYPE: BaseCurrencyActionResponse', None, None) + + self.__base_currency = base_currency + self.__key_modified['base_currency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_wrapper.py new file mode 100644 index 0000000..a48ddfc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BaseCurrencyWrapper(object): + def __init__(self): + """Creates an instance of BaseCurrencyWrapper""" + + self.__base_currency = None + self.__key_modified = dict() + + def get_base_currency(self): + """ + The method to get the base_currency + + Returns: + BaseCurrency: An instance of BaseCurrency + """ + + return self.__base_currency + + def set_base_currency(self, base_currency): + """ + The method to set the value to base_currency + + Parameters: + base_currency (BaseCurrency) : An instance of BaseCurrency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency import BaseCurrency + except Exception: + from .base_currency import BaseCurrency + + if base_currency is not None and not isinstance(base_currency, BaseCurrency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: base_currency EXPECTED TYPE: BaseCurrency', None, None) + + self.__base_currency = base_currency + self.__key_modified['base_currency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/body_wrapper.py new file mode 100644 index 0000000..3809faa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__currencies = None + self.__key_modified = dict() + + def get_currencies(self): + """ + The method to get the currencies + + Returns: + list: An instance of list + """ + + return self.__currencies + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/currencies_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/currencies_operations.py new file mode 100644 index 0000000..5bad4ed --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/currencies_operations.py @@ -0,0 +1,254 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CurrenciesOperations(object): + def __init__(self): + """Creates an instance of CurrenciesOperations""" + pass + + def get_currencies(self): + """ + The method to get currencies + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def add_currencies(self, request): + """ + The method to add currencies + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/org/currencies' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_currencies(self, request): + """ + The method to update currencies + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/org/currencies' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_currency(self, id): + """ + The method to get currency + + 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/v7/org/currencies/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_currency(self, id, request): + """ + The method to update currency + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/org/currencies/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def enable_base_currency(self, request): + """ + The method to enable base currency + + Parameters: + request (BaseCurrencyWrapper) : An instance of BaseCurrencyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_wrapper import BaseCurrencyWrapper + except Exception: + from .base_currency_wrapper import BaseCurrencyWrapper + + if request is not None and not isinstance(request, BaseCurrencyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BaseCurrencyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies/actions/enable' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_base_currency(self, request): + """ + The method to update base currency + + Parameters: + request (BaseCurrencyWrapper) : An instance of BaseCurrencyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_wrapper import BaseCurrencyWrapper + except Exception: + from .base_currency_wrapper import BaseCurrencyWrapper + + if request is not None and not isinstance(request, BaseCurrencyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BaseCurrencyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies/actions/enable' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/currency.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/currency.py new file mode 100644 index 0000000..e0cd45f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/currency.py @@ -0,0 +1,393 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__iso_code = None + self.__symbol = None + self.__created_time = None + self.__is_active = None + self.__exchange_rate = None + self.__format = None + self.__created_by = None + self.__prefix_symbol = None + self.__is_base = None + self.__modified_time = None + self.__name = None + self.__modified_by = None + self.__id = None + self.__key_modified = dict() + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_symbol(self): + """ + The method to get the symbol + + Returns: + string: A string representing the symbol + """ + + return self.__symbol + + def set_symbol(self, symbol): + """ + The method to set the value to symbol + + Parameters: + symbol (string) : A string representing the symbol + """ + + if symbol is not None and not isinstance(symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: str', None, None) + + self.__symbol = symbol + self.__key_modified['symbol'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_is_active(self): + """ + The method to get the is_active + + Returns: + bool: A bool representing the is_active + """ + + return self.__is_active + + def set_is_active(self, is_active): + """ + The method to set the value to is_active + + Parameters: + is_active (bool) : A bool representing the is_active + """ + + if is_active is not None and not isinstance(is_active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_active EXPECTED TYPE: bool', None, None) + + self.__is_active = is_active + self.__key_modified['is_active'] = 1 + + def get_exchange_rate(self): + """ + The method to get the exchange_rate + + Returns: + string: A string representing the exchange_rate + """ + + return self.__exchange_rate + + def set_exchange_rate(self, exchange_rate): + """ + The method to set the value to exchange_rate + + Parameters: + exchange_rate (string) : A string representing the exchange_rate + """ + + if exchange_rate is not None and not isinstance(exchange_rate, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exchange_rate EXPECTED TYPE: str', None, None) + + self.__exchange_rate = exchange_rate + self.__key_modified['exchange_rate'] = 1 + + def get_format(self): + """ + The method to get the format + + Returns: + Format: An instance of Format + """ + + return self.__format + + def set_format(self, format): + """ + The method to set the value to format + + Parameters: + format (Format) : An instance of Format + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.format import Format + except Exception: + from .format import Format + + if format is not None and not isinstance(format, Format): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: Format', None, None) + + self.__format = format + self.__key_modified['format'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_prefix_symbol(self): + """ + The method to get the prefix_symbol + + Returns: + bool: A bool representing the prefix_symbol + """ + + return self.__prefix_symbol + + def set_prefix_symbol(self, prefix_symbol): + """ + The method to set the value to prefix_symbol + + Parameters: + prefix_symbol (bool) : A bool representing the prefix_symbol + """ + + if prefix_symbol is not None and not isinstance(prefix_symbol, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix_symbol EXPECTED TYPE: bool', None, None) + + self.__prefix_symbol = prefix_symbol + self.__key_modified['prefix_symbol'] = 1 + + def get_is_base(self): + """ + The method to get the is_base + + Returns: + bool: A bool representing the is_base + """ + + return self.__is_base + + def set_is_base(self, is_base): + """ + The method to set the value to is_base + + Parameters: + is_base (bool) : A bool representing the is_base + """ + + if is_base is not None and not isinstance(is_base, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_base EXPECTED TYPE: bool', None, None) + + self.__is_base = is_base + self.__key_modified['is_base'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/error_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/format.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/format.py new file mode 100644 index 0000000..18cacb1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/format.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Format(object): + def __init__(self): + """Creates an instance of Format""" + + self.__decimal_separator = None + self.__thousand_separator = None + self.__decimal_places = None + self.__key_modified = dict() + + def get_decimal_separator(self): + """ + The method to get the decimal_separator + + Returns: + Choice: An instance of Choice + """ + + return self.__decimal_separator + + def set_decimal_separator(self, decimal_separator): + """ + The method to set the value to decimal_separator + + Parameters: + decimal_separator (Choice) : An instance of Choice + """ + + if decimal_separator is not None and not isinstance(decimal_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_separator EXPECTED TYPE: Choice', None, None) + + self.__decimal_separator = decimal_separator + self.__key_modified['decimal_separator'] = 1 + + def get_thousand_separator(self): + """ + The method to get the thousand_separator + + Returns: + Choice: An instance of Choice + """ + + return self.__thousand_separator + + def set_thousand_separator(self, thousand_separator): + """ + The method to set the value to thousand_separator + + Parameters: + thousand_separator (Choice) : An instance of Choice + """ + + if thousand_separator is not None and not isinstance(thousand_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: thousand_separator EXPECTED TYPE: Choice', None, None) + + self.__thousand_separator = thousand_separator + self.__key_modified['thousand_separator'] = 1 + + def get_decimal_places(self): + """ + The method to get the decimal_places + + Returns: + Choice: An instance of Choice + """ + + return self.__decimal_places + + def set_decimal_places(self, decimal_places): + """ + The method to set the value to decimal_places + + Parameters: + decimal_places (Choice) : An instance of Choice + """ + + if decimal_places is not None and not isinstance(decimal_places, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_places EXPECTED TYPE: Choice', None, None) + + self.__decimal_places = decimal_places + self.__key_modified['decimal_places'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/response_wrapper.py new file mode 100644 index 0000000..e1e2585 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__currencies = None + self.__key_modified = dict() + + def get_currencies(self): + """ + The method to get the currencies + + Returns: + list: An instance of list + """ + + return self.__currencies + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/success_response.py new file mode 100644 index 0000000..1fa8f30 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/currencies/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_action_response import BaseCurrencyActionResponse + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .base_currency_action_response import BaseCurrencyActionResponse + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse, BaseCurrencyActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/__init__.py new file mode 100644 index 0000000..8e47589 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/__init__.py @@ -0,0 +1,20 @@ +from .action_wrapper import ActionWrapper +from .owner import Owner +from .custom_views_operations import CustomViewsOperations, GetCustomViewsParam, GetCustomViewParam, ChangeSortOrderOfCustomViewsParam, ChangeSortOrderOfCustomViewParam +from .criteria import Criteria +from .pin_fields import PinFields +from .body_wrapper import BodyWrapper +from .sort_by import SortBy +from .shared_to import SharedTo +from .custom_views import CustomViews +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .field import Field +from .success_response import SuccessResponse +from .translation import Translation +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .pin_unpin_fields import PinUnpinFields +from .fields import Fields +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_wrapper.py new file mode 100644 index 0000000..bbde710 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__custom_views = None + self.__key_modified = dict() + + def get_custom_views(self): + """ + The method to get the custom_views + + Returns: + list: An instance of list + """ + + return self.__custom_views + + def set_custom_views(self, custom_views): + """ + The method to set the value to custom_views + + Parameters: + custom_views (list) : An instance of list + """ + + if custom_views is not None and not isinstance(custom_views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_views EXPECTED TYPE: list', None, None) + + self.__custom_views = custom_views + self.__key_modified['custom_views'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/api_exception.py new file mode 100644 index 0000000..426459d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/body_wrapper.py new file mode 100644 index 0000000..dcece8e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__custom_views = None + self.__key_modified = dict() + + def get_custom_views(self): + """ + The method to get the custom_views + + Returns: + list: An instance of list + """ + + return self.__custom_views + + def set_custom_views(self, custom_views): + """ + The method to set the value to custom_views + + Parameters: + custom_views (list) : An instance of list + """ + + if custom_views is not None and not isinstance(custom_views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_views EXPECTED TYPE: list', None, None) + + self.__custom_views = custom_views + self.__key_modified['custom_views'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/criteria.py new file mode 100644 index 0000000..212613b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views.py new file mode 100644 index 0000000..820967a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views.py @@ -0,0 +1,630 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class CustomViews(object): + def __init__(self): + """Creates an instance of CustomViews""" + + self.__display_value = None + self.__system_name = None + self.__category = None + self.__created_time = None + self.__modified_time = None + self.__last_accessed_time = None + self.__name = None + self.__created_by = None + self.__modified_by = None + self.__module = None + self.__criteria = None + self.__default = None + self.__system_defined = None + self.__locked = None + self.__favorite = None + self.__offline = None + self.__access_type = None + self.__shared_to = None + self.__fields = None + self.__sort_by = None + self.__sort_order = None + self.__id = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_system_name(self): + """ + The method to get the system_name + + Returns: + string: A string representing the system_name + """ + + return self.__system_name + + def set_system_name(self, system_name): + """ + The method to set the value to system_name + + Parameters: + system_name (string) : A string representing the system_name + """ + + if system_name is not None and not isinstance(system_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_name EXPECTED TYPE: str', None, None) + + self.__system_name = system_name + self.__key_modified['system_name'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_last_accessed_time(self): + """ + The method to get the last_accessed_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_accessed_time + + def set_last_accessed_time(self, last_accessed_time): + """ + The method to set the value to last_accessed_time + + Parameters: + last_accessed_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_accessed_time is not None and not isinstance(last_accessed_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_accessed_time EXPECTED TYPE: datetime', None, None) + + self.__last_accessed_time = last_accessed_time + self.__key_modified['last_accessed_time'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Owner: An instance of Owner + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.owner import Owner + except Exception: + from .owner import Owner + + if module is not None and not isinstance(module, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Owner', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_system_defined(self): + """ + The method to get the system_defined + + Returns: + bool: A bool representing the system_defined + """ + + return self.__system_defined + + def set_system_defined(self, system_defined): + """ + The method to set the value to system_defined + + Parameters: + system_defined (bool) : A bool representing the system_defined + """ + + if system_defined is not None and not isinstance(system_defined, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: bool', None, None) + + self.__system_defined = system_defined + self.__key_modified['system_defined'] = 1 + + def get_locked(self): + """ + The method to get the locked + + Returns: + bool: A bool representing the locked + """ + + return self.__locked + + def set_locked(self, locked): + """ + The method to set the value to locked + + Parameters: + locked (bool) : A bool representing the locked + """ + + if locked is not None and not isinstance(locked, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked EXPECTED TYPE: bool', None, None) + + self.__locked = locked + self.__key_modified['locked'] = 1 + + def get_favorite(self): + """ + The method to get the favorite + + Returns: + int: An int representing the favorite + """ + + return self.__favorite + + def set_favorite(self, favorite): + """ + The method to set the value to favorite + + Parameters: + favorite (int) : An int representing the favorite + """ + + if favorite is not None and not isinstance(favorite, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: int', None, None) + + self.__favorite = favorite + self.__key_modified['favorite'] = 1 + + def get_offline(self): + """ + The method to get the offline + + Returns: + bool: A bool representing the offline + """ + + return self.__offline + + def set_offline(self, offline): + """ + The method to set the value to offline + + Parameters: + offline (bool) : A bool representing the offline + """ + + if offline is not None and not isinstance(offline, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: offline EXPECTED TYPE: bool', None, None) + + self.__offline = offline + self.__key_modified['offline'] = 1 + + def get_access_type(self): + """ + The method to get the access_type + + Returns: + Choice: An instance of Choice + """ + + return self.__access_type + + def set_access_type(self, access_type): + """ + The method to set the value to access_type + + Parameters: + access_type (Choice) : An instance of Choice + """ + + if access_type is not None and not isinstance(access_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: access_type EXPECTED TYPE: Choice', None, None) + + self.__access_type = access_type + self.__key_modified['access_type'] = 1 + + def get_shared_to(self): + """ + The method to get the shared_to + + Returns: + list: An instance of list + """ + + return self.__shared_to + + def set_shared_to(self, shared_to): + """ + The method to set the value to shared_to + + Parameters: + shared_to (list) : An instance of list + """ + + if shared_to is not None and not isinstance(shared_to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_to EXPECTED TYPE: list', None, None) + + self.__shared_to = shared_to + self.__key_modified['shared_to'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + SortBy: An instance of SortBy + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (SortBy) : An instance of SortBy + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.sort_by import SortBy + except Exception: + from .sort_by import SortBy + + if sort_by is not None and not isinstance(sort_by, SortBy): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: SortBy', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + Choice: An instance of Choice + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (Choice) : An instance of Choice + """ + + if sort_order is not None and not isinstance(sort_order, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: Choice', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views_operations.py new file mode 100644 index 0000000..155ffb1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views_operations.py @@ -0,0 +1,206 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class CustomViewsOperations(object): + def __init__(self): + """Creates an instance of CustomViewsOperations""" + pass + + def get_custom_views(self, param_instance=None): + """ + The method to get custom views + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/custom_views' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_custom_view(self, id, param_instance=None): + """ + The method to get custom view + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/custom_views/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def change_sort_order_of_custom_views(self, request, param_instance=None): + """ + The method to change sort order of custom views + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/custom_views/actions/change_sort' + 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.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def change_sort_order_of_custom_view(self, id, request, param_instance=None): + """ + The method to change sort order of custom view + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + 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/v7/settings/custom_views/' + api_path = api_path + str(id) + api_path = api_path + '/actions/change_sort' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetCustomViewsParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam') + page = Param('page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam') + per_page = Param('per_page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam') + + +class GetCustomViewParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.GetCustomViewParam') + + +class ChangeSortOrderOfCustomViewsParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.ChangeSortOrderOfCustomViewsParam') + + +class ChangeSortOrderOfCustomViewParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.ChangeSortOrderOfCustomViewParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/fields.py new file mode 100644 index 0000000..1e98459 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/fields.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__id = None + self.__api_name = None + self.__pin = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_pin(self): + """ + The method to get the pin + + Returns: + bool: A bool representing the pin + """ + + return self.__pin + + def set_pin(self, pin): + """ + The method to set the value to pin + + Parameters: + pin (bool) : A bool representing the pin + """ + + if pin is not None and not isinstance(pin, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pin EXPECTED TYPE: bool', None, None) + + self.__pin = pin + self.__key_modified['_pin'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/info.py new file mode 100644 index 0000000..27e8842 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/info.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__default = None + self.__translation = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_default(self): + """ + The method to get the default + + Returns: + int: An int representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (int) : An int representing the default + """ + + if default is not None and not isinstance(default, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: int', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_translation(self): + """ + The method to get the translation + + Returns: + Translation: An instance of Translation + """ + + return self.__translation + + def set_translation(self, translation): + """ + The method to set the value to translation + + Parameters: + translation (Translation) : An instance of Translation + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.translation import Translation + except Exception: + from .translation import Translation + + if translation is not None and not isinstance(translation, Translation): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: translation EXPECTED TYPE: Translation', None, None) + + self.__translation = translation + self.__key_modified['translation'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/owner.py new file mode 100644 index 0000000..1c09994 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/owner.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_fields.py new file mode 100644 index 0000000..3aa23b1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_fields.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PinFields(object): + def __init__(self): + """Creates an instance of PinFields""" + + self.__api_name = None + self.__pin = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_pin(self): + """ + The method to get the pin + + Returns: + bool: A bool representing the pin + """ + + return self.__pin + + def set_pin(self, pin): + """ + The method to set the value to pin + + Parameters: + pin (bool) : A bool representing the pin + """ + + if pin is not None and not isinstance(pin, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pin EXPECTED TYPE: bool', None, None) + + self.__pin = pin + self.__key_modified['_pin'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_unpin_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_unpin_fields.py new file mode 100644 index 0000000..7ea41d3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_unpin_fields.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PinUnpinFields(object): + def __init__(self): + """Creates an instance of PinUnpinFields""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_wrapper.py new file mode 100644 index 0000000..08ca6cc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__custom_views = None + self.__info = None + self.__key_modified = dict() + + def get_custom_views(self): + """ + The method to get the custom_views + + Returns: + list: An instance of list + """ + + return self.__custom_views + + def set_custom_views(self, custom_views): + """ + The method to set the value to custom_views + + Parameters: + custom_views (list) : An instance of list + """ + + if custom_views is not None and not isinstance(custom_views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_views EXPECTED TYPE: list', None, None) + + self.__custom_views = custom_views + self.__key_modified['custom_views'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/shared_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/shared_to.py new file mode 100644 index 0000000..fb69629 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/shared_to.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SharedTo(object): + def __init__(self): + """Creates an instance of SharedTo""" + + self.__type = None + self.__name = None + self.__id = None + self.__subordinates = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/sort_by.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/sort_by.py new file mode 100644 index 0000000..4bed7d8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/sort_by.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SortBy(object): + def __init__(self): + """Creates an instance of SortBy""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/success_response.py new file mode 100644 index 0000000..c5a3ce0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/translation.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/translation.py new file mode 100644 index 0000000..1812c5c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/custom_views/translation.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Translation(object): + def __init__(self): + """Creates an instance of Translation""" + + self.__public_views = None + self.__other_users_views = None + self.__shared_with_me = None + self.__created_by_me = None + self.__key_modified = dict() + + def get_public_views(self): + """ + The method to get the public_views + + Returns: + string: A string representing the public_views + """ + + return self.__public_views + + def set_public_views(self, public_views): + """ + The method to set the value to public_views + + Parameters: + public_views (string) : A string representing the public_views + """ + + if public_views is not None and not isinstance(public_views, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: public_views EXPECTED TYPE: str', None, None) + + self.__public_views = public_views + self.__key_modified['public_views'] = 1 + + def get_other_users_views(self): + """ + The method to get the other_users_views + + Returns: + string: A string representing the other_users_views + """ + + return self.__other_users_views + + def set_other_users_views(self, other_users_views): + """ + The method to set the value to other_users_views + + Parameters: + other_users_views (string) : A string representing the other_users_views + """ + + if other_users_views is not None and not isinstance(other_users_views, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_users_views EXPECTED TYPE: str', None, None) + + self.__other_users_views = other_users_views + self.__key_modified['other_users_views'] = 1 + + def get_shared_with_me(self): + """ + The method to get the shared_with_me + + Returns: + string: A string representing the shared_with_me + """ + + return self.__shared_with_me + + def set_shared_with_me(self, shared_with_me): + """ + The method to set the value to shared_with_me + + Parameters: + shared_with_me (string) : A string representing the shared_with_me + """ + + if shared_with_me is not None and not isinstance(shared_with_me, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_with_me EXPECTED TYPE: str', None, None) + + self.__shared_with_me = shared_with_me + self.__key_modified['shared_with_me'] = 1 + + def get_created_by_me(self): + """ + The method to get the created_by_me + + Returns: + string: A string representing the created_by_me + """ + + return self.__created_by_me + + def set_created_by_me(self, created_by_me): + """ + The method to set the value to created_by_me + + Parameters: + created_by_me (string) : A string representing the created_by_me + """ + + if created_by_me is not None and not isinstance(created_by_me, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by_me EXPECTED TYPE: str', None, None) + + self.__created_by_me = created_by_me + self.__key_modified['created_by_me'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/__init__.py new file mode 100755 index 0000000..01b5c13 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/__init__.py @@ -0,0 +1,8 @@ +from .au_data_center import AUDataCenter +from .cn_data_center import CNDataCenter +from .data_center import DataCenter +from .eu_data_center import EUDataCenter +from .in_data_center import INDataCenter +from .us_data_center import USDataCenter +from .jp_data_center import JPDataCenter +from .ca_data_center import CADataCenter diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/au_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/au_data_center.py new file mode 100755 index 0000000..d6e0cca --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/au_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class AUDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in AU Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in AU domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://www.zohoapis.com.au", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in AU domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://sandbox.zohoapis.com.au", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in AU domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://developer.zohoapis.com.au", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.com.au/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.com.au" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/ca_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/ca_data_center.py new file mode 100644 index 0000000..24b8865 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/ca_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class CADataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in CA Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in CA domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.ca", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in CA domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.ca", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in CA domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.ca", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.ca/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.ca" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/cn_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/cn_data_center.py new file mode 100755 index 0000000..3de78e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/cn_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class CNDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in CN Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in CN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.com.cn", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in CN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.com.cn", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in CN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.com.cn", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.com.cn/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.com.cn" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/data_center.py new file mode 100755 index 0000000..3f0baae --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/data_center.py @@ -0,0 +1,98 @@ +from abc import abstractmethod, ABC + + +class DataCenter(ABC): + + """ + This class represents the properties of Zoho CRM DataCenter + """ + + @abstractmethod + def get_iam_url(self): + + """ + The method to get the accounts URL. + :return: A str representing the accounts URL. + """ + + pass + + @abstractmethod + def get_file_upload_url(self): + """ + The method to get the File Upload URL + :return: A str representing the File Upload URL + """ + + pass + + class Environment(object): + + def __init__(self, url, accounts_url, file_upload_url): + + """ + Creates an Environment class instance with the specified parameters. + :param url: A str representing the Zoho CRM API URL. + :param accounts_url: A str representing the accounts URL. + :param file_upload_url : A str representing the File Upload URL + """ + + self.url = url + self.accounts_url = accounts_url + self.file_upload_url = file_upload_url + return + + @staticmethod + def get(config): + + try: + from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter, JPDataCenter, INDataCenter, EUDataCenter, CNDataCenter, AUDataCenter + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + except Exception: + from ..dc import USDataCenter, JPDataCenter, INDataCenter, EUDataCenter, CNDataCenter, AUDataCenter + from ..exception import SDKException + from ..util import Constants + + if config in Constants.US_DATACENTER: + if Constants.SANDBOX in config: + return USDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return USDataCenter.DEVELOPER() + return USDataCenter.PRODUCTION() + + elif config in Constants.JP_DATACENTER: + if Constants.SANDBOX in config: + return JPDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return JPDataCenter.DEVELOPER() + return JPDataCenter.PRODUCTION() + + elif config in Constants.IN_DATACENTER: + if Constants.SANDBOX in config: + return INDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return INDataCenter.DEVELOPER() + return INDataCenter.PRODUCTION() + + elif config in Constants.EU_DATACENTER: + if Constants.SANDBOX in config: + return EUDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return EUDataCenter.DEVELOPER() + return EUDataCenter.PRODUCTION() + + elif config in Constants.CN_DATACENTER: + if Constants.SANDBOX in config: + return CNDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return CNDataCenter.DEVELOPER() + return CNDataCenter.PRODUCTION() + + elif config in Constants.AU_DATACENTER: + if Constants.SANDBOX in config: + return AUDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return AUDataCenter.DEVELOPER() + return AUDataCenter.PRODUCTION() + return None diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/eu_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/eu_data_center.py new file mode 100755 index 0000000..c2bdc17 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/eu_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class EUDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in EU Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in EU domain + :return: An instance of Environments + """ + + return DataCenter.Environment("https://www.zohoapis.eu", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in EU domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.eu", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in EU domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.eu", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.eu/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.eu" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/in_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/in_data_center.py new file mode 100755 index 0000000..3945bc4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/in_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class INDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in IN Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in IN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.in", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in IN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.in", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in IN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.in", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.in/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.in" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/jp_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/jp_data_center.py new file mode 100644 index 0000000..17fe5c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/jp_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class JPDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in Japan Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in Japan domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://www.zohoapis.jp", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in Japan domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://sandbox.zohoapis.jp", cls(). get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in Japan domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://developer.zohoapis.jp", cls(). get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.jp/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.jp" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/us_data_center.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/us_data_center.py new file mode 100755 index 0000000..df99e2a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/dc/us_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class USDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in US Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in US domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.com", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in US domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.com", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in US domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.com", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.com/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.com" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/__init__.py new file mode 100644 index 0000000..69756f5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/__init__.py @@ -0,0 +1,13 @@ +from .action_wrapper import ActionWrapper +from .deal_contact_roles_operations import DealContactRolesOperations, GetAssociatedContactRolesParam +from .data import Data +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .contact_role import ContactRole +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_wrapper.py new file mode 100644 index 0000000..89e74a1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/api_exception.py new file mode 100644 index 0000000..e060fec --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/contact_role.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/contact_role.py new file mode 100644 index 0000000..b93d5af --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/contact_role.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ContactRole(object): + def __init__(self): + """Creates an instance of ContactRole""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/data.py new file mode 100644 index 0000000..a6b6e58 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/data.py @@ -0,0 +1,218 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..record import Record + + +class Data(Record): + def __init__(self): + """Creates an instance of Data""" + super().__init__() + + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_contact_role(self): + """ + The method to get the contact_role + + Returns: + ContactRole: An instance of ContactRole + """ + + return self.get_key_value('Contact_Role') + + def set_contact_role(self, contact_role): + """ + The method to set the value to contact_role + + Parameters: + contact_role (ContactRole) : An instance of ContactRole + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.contact_role import ContactRole + except Exception: + from .contact_role import ContactRole + + if contact_role is not None and not isinstance(contact_role, ContactRole): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_role EXPECTED TYPE: ContactRole', None, None) + + self.add_key_value('Contact_Role', contact_role) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/deal_contact_roles_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/deal_contact_roles_operations.py new file mode 100644 index 0000000..46a549f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/deal_contact_roles_operations.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + + +class DealContactRolesOperations(object): + def __init__(self): + """Creates an instance of DealContactRolesOperations""" + pass + + def get_associated_contact_roles(self, deal, param_instance=None): + """ + The method to get associated contact roles + + Parameters: + deal (int) : An int representing the deal + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal EXPECTED TYPE: int', None, None) + + 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/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles' + 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.set_param(param_instance) + handler_instance.set_module_api_name("Contacts") + Utility.get_fields("Contacts", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associated_contact_roles_specific_to_contact(self, contact, deal): + """ + The method to get associated contact roles specific to contact + + Parameters: + contact (int) : An int representing the contact + deal (int) : An int representing the deal + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(contact, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact EXPECTED TYPE: int', None, None) + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles/' + api_path = api_path + str(contact) + 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.set_module_api_name("Contacts") + Utility.get_fields("Contacts", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def associate_contact_role_to_deal(self, contact, deal, request): + """ + The method to associate contact role to deal + + Parameters: + contact (int) : An int representing the contact + deal (int) : An int representing the deal + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(contact, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact EXPECTED TYPE: int', None, None) + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal 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/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles/' + api_path = api_path + str(contact) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_contact_role_realation(self, contact, deal): + """ + The method to delete contact role realation + + Parameters: + contact (int) : An int representing the contact + deal (int) : An int representing the deal + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(contact, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact EXPECTED TYPE: int', None, None) + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles/' + api_path = api_path + str(contact) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAssociatedContactRolesParam(object): + ids = Param('ids', 'com.zoho.crm.api.DealContactRoles.GetAssociatedContactRolesParam') + fields = Param('fields', 'com.zoho.crm.api.DealContactRoles.GetAssociatedContactRolesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/error_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/info.py new file mode 100644 index 0000000..c52501d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/info.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__page = None + self.__per_page = None + self.__more_records = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__next_page_token = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + string: A string representing the page_token_expiry + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (string) : A string representing the page_token_expiry + """ + + if page_token_expiry is not None and not isinstance(page_token_expiry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: str', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_wrapper.py new file mode 100644 index 0000000..dbab61d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/success_response.py new file mode 100644 index 0000000..06790e8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/__init__.py new file mode 100644 index 0000000..0154832 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .property import Property +from .response_wrapper import ResponseWrapper +from .minified_property1 import MinifiedProperty1 +from .definition import Definition +from .minified_property import MinifiedProperty diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/api_exception.py new file mode 100644 index 0000000..a68a663 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/definition.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/definition.py new file mode 100644 index 0000000..f5ce7fa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/definition.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Definition(object): + def __init__(self): + """Creates an instance of Definition""" + + self.__root_element_name = None + self.__extradetails = None + self.__properties = None + self.__key_modified = dict() + + def get_root_element_name(self): + """ + The method to get the root_element_name + + Returns: + string: A string representing the root_element_name + """ + + return self.__root_element_name + + def set_root_element_name(self, root_element_name): + """ + The method to set the value to root_element_name + + Parameters: + root_element_name (string) : A string representing the root_element_name + """ + + if root_element_name is not None and not isinstance(root_element_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: root_element_name EXPECTED TYPE: str', None, None) + + self.__root_element_name = root_element_name + self.__key_modified['root_element_name'] = 1 + + def get_extradetails(self): + """ + The method to get the extradetails + + Returns: + dict: An instance of dict + """ + + return self.__extradetails + + def set_extradetails(self, extradetails): + """ + The method to set the value to extradetails + + Parameters: + extradetails (dict) : An instance of dict + """ + + if extradetails is not None and not isinstance(extradetails, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: extradetails EXPECTED TYPE: dict', None, None) + + self.__extradetails = extradetails + self.__key_modified['extraDetails'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property.py new file mode 100644 index 0000000..1328aa1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedProperty(object): + def __init__(self): + """Creates an instance of MinifiedProperty""" + + self.__read_only = None + self.__api_name = None + self.__data_type = None + self.__length = None + self.__required = None + self.__properties = None + self.__key_modified = dict() + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property1.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property1.py new file mode 100644 index 0000000..0b965d3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property1.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedProperty1(object): + def __init__(self): + """Creates an instance of MinifiedProperty1""" + + self.__read_only = None + self.__api_name = None + self.__data_type = None + self.__length = None + self.__required = None + self.__key_modified = dict() + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/property.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/property.py new file mode 100644 index 0000000..830e2d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/property.py @@ -0,0 +1,349 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Property(object): + def __init__(self): + """Creates an instance of Property""" + + self.__display_label = None + self.__allowed_values = None + self.__ui_type = None + self.__regex = None + self.__read_only = None + self.__api_name = None + self.__field_label = None + self.__data_type = None + self.__length = None + self.__available_in_user_layout = None + self.__required = None + self.__properties = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_allowed_values(self): + """ + The method to get the allowed_values + + Returns: + list: An instance of list + """ + + return self.__allowed_values + + def set_allowed_values(self, allowed_values): + """ + The method to set the value to allowed_values + + Parameters: + allowed_values (list) : An instance of list + """ + + if allowed_values is not None and not isinstance(allowed_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_values EXPECTED TYPE: list', None, None) + + self.__allowed_values = allowed_values + self.__key_modified['allowed_values'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_regex(self): + """ + The method to get the regex + + Returns: + string: A string representing the regex + """ + + return self.__regex + + def set_regex(self, regex): + """ + The method to set the value to regex + + Parameters: + regex (string) : A string representing the regex + """ + + if regex is not None and not isinstance(regex, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: regex EXPECTED TYPE: str', None, None) + + self.__regex = regex + self.__key_modified['regex'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/response_wrapper.py new file mode 100644 index 0000000..d553333 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/definition/response_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__definition = None + self.__key_modified = dict() + + def get_definition(self): + """ + The method to get the definition + + Returns: + Definition: An instance of Definition + """ + + return self.__definition + + def set_definition(self, definition): + """ + The method to set the value to definition + + Parameters: + definition (Definition) : An instance of Definition + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.definition.definition import Definition + except Exception: + from .definition import Definition + + if definition is not None and not isinstance(definition, Definition): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: definition EXPECTED TYPE: Definition', None, None) + + self.__definition = definition + self.__key_modified['definition'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/__init__.py new file mode 100644 index 0000000..8d9e1b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/__init__.py @@ -0,0 +1,9 @@ +from .action_wrapper import ActionWrapper +from .dependee import Dependee +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .digest_operations import DigestOperations +from .digest import Digest +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_wrapper.py new file mode 100644 index 0000000..e5eccf1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.digest.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__digest = None + self.__key_modified = dict() + + def get_digest(self): + """ + The method to get the digest + + Returns: + list: An instance of list + """ + + return self.__digest + + def set_digest(self, digest): + """ + The method to set the value to digest + + Parameters: + digest (list) : An instance of list + """ + + if digest is not None and not isinstance(digest, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: digest EXPECTED TYPE: list', None, None) + + self.__digest = digest + self.__key_modified['__digest'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/api_exception.py new file mode 100644 index 0000000..b138c88 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.digest.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.digest.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/body_wrapper.py new file mode 100644 index 0000000..dd0946e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__digest = None + self.__key_modified = dict() + + def get_digest(self): + """ + The method to get the digest + + Returns: + list: An instance of list + """ + + return self.__digest + + def set_digest(self, digest): + """ + The method to set the value to digest + + Parameters: + digest (list) : An instance of list + """ + + if digest is not None and not isinstance(digest, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: digest EXPECTED TYPE: list', None, None) + + self.__digest = digest + self.__key_modified['__digest'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/dependee.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/dependee.py new file mode 100644 index 0000000..fb318b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/dependee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Dependee(object): + def __init__(self): + """Creates an instance of Dependee""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/digest.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/digest.py new file mode 100644 index 0000000..e95fea4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/digest.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Digest(object): + def __init__(self): + """Creates an instance of Digest""" + + self.__record_id = None + self.__type = None + self.__module = None + self.__key_modified = dict() + + def get_record_id(self): + """ + The method to get the record_id + + Returns: + int: An int representing the record_id + """ + + return self.__record_id + + def set_record_id(self, record_id): + """ + The method to set the value to record_id + + Parameters: + record_id (int) : An int representing the record_id + """ + + if record_id is not None and not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + self.__record_id = record_id + self.__key_modified['record_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/digest_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/digest_operations.py new file mode 100644 index 0000000..c2e315f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/digest_operations.py @@ -0,0 +1,49 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class DigestOperations(object): + def __init__(self): + """Creates an instance of DigestOperations""" + pass + + def create_digest(self, request): + """ + The method to create digest + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.digest.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/__digest' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.digest.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/success_response.py new file mode 100644 index 0000000..43854d9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/digest/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.digest.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/__init__.py new file mode 100644 index 0000000..17e29ed --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .file_body_wrapper import FileBodyWrapper +from .download_attachments_operations import DownloadAttachmentsOperations, GetDownloadAttachmentsDetailsParam diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/api_exception.py new file mode 100644 index 0000000..b6eeb88 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/download_attachments_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/download_attachments_operations.py new file mode 100644 index 0000000..1fb5252 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/download_attachments_operations.py @@ -0,0 +1,68 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class DownloadAttachmentsOperations(object): + def __init__(self): + """Creates an instance of DownloadAttachmentsOperations""" + pass + + def get_download_attachments_details(self, record_id, module, param_instance=None): + """ + The method to get download attachments details + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Emails/actions/download_attachments' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.download_attachments.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'multipart/form-data') + + +class GetDownloadAttachmentsDetailsParam(object): + user_id = Param('user_id', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') + message_id = Param('message_id', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') + id = Param('id', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') + name = Param('name', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/file_body_wrapper.py new file mode 100644 index 0000000..3165063 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_attachments/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/__init__.py new file mode 100644 index 0000000..d55d89e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .file_body_wrapper import FileBodyWrapper +from .download_inline_images_operations import DownloadInlineImagesOperations, GetDownloadInlineImagesParam diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/api_exception.py new file mode 100644 index 0000000..c3419a0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_inline_images.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/download_inline_images_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/download_inline_images_operations.py new file mode 100644 index 0000000..3714630 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/download_inline_images_operations.py @@ -0,0 +1,67 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class DownloadInlineImagesOperations(object): + def __init__(self): + """Creates an instance of DownloadInlineImagesOperations""" + pass + + def get_download_inline_images(self, record_id, module, param_instance=None): + """ + The method to get download inline images + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Emails/actions/download_inline_images' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.download_inline_images.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'multipart/form-data') + + +class GetDownloadInlineImagesParam(object): + user_id = Param('user_id', 'com.zoho.crm.api.DownloadInlineImages.GetDownloadInlineImagesParam') + message_id = Param('message_id', 'com.zoho.crm.api.DownloadInlineImages.GetDownloadInlineImagesParam') + id = Param('id', 'com.zoho.crm.api.DownloadInlineImages.GetDownloadInlineImagesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/file_body_wrapper.py new file mode 100644 index 0000000..ab10ebf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_inline_images.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/__init__.py new file mode 100644 index 0000000..bd57cb3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .mapped_field import MappedField +from .duplicate_check_preference import DuplicateCheckPreference +from .mapped_module import MappedModule +from .body_wrapper import BodyWrapper +from .duplicate_check_preference_operations import DuplicateCheckPreferenceOperations, GetDuplicateCheckPreferenceParam, CreateDuplicateCheckPreferenceParam, UpdateDuplicateCheckPreferenceParam, DeleteDuplicateCheckPreferenceParam +from .field_mappings import FieldMappings +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .expected_fields import ExpectedFields +from .current_field import CurrentField +from .type_configuration import TypeConfiguration +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_wrapper.py new file mode 100644 index 0000000..aa07144 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__duplicate_check_preference = None + self.__key_modified = dict() + + def get_duplicate_check_preference(self): + """ + The method to get the duplicate_check_preference + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__duplicate_check_preference + + def set_duplicate_check_preference(self, duplicate_check_preference): + """ + The method to set the value to duplicate_check_preference + + Parameters: + duplicate_check_preference (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if duplicate_check_preference is not None and not isinstance(duplicate_check_preference, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_preference EXPECTED TYPE: ActionResponse', None, None) + + self.__duplicate_check_preference = duplicate_check_preference + self.__key_modified['duplicate_check_preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/api_exception.py new file mode 100644 index 0000000..22dbdd1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/body_wrapper.py new file mode 100644 index 0000000..9fd9733 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__duplicate_check_preference = None + self.__key_modified = dict() + + def get_duplicate_check_preference(self): + """ + The method to get the duplicate_check_preference + + Returns: + DuplicateCheckPreference: An instance of DuplicateCheckPreference + """ + + return self.__duplicate_check_preference + + def set_duplicate_check_preference(self, duplicate_check_preference): + """ + The method to set the value to duplicate_check_preference + + Parameters: + duplicate_check_preference (DuplicateCheckPreference) : An instance of DuplicateCheckPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.duplicate_check_preference import DuplicateCheckPreference + except Exception: + from .duplicate_check_preference import DuplicateCheckPreference + + if duplicate_check_preference is not None and not isinstance(duplicate_check_preference, DuplicateCheckPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_preference EXPECTED TYPE: DuplicateCheckPreference', None, None) + + self.__duplicate_check_preference = duplicate_check_preference + self.__key_modified['duplicate_check_preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/current_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/current_field.py new file mode 100644 index 0000000..580794d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/current_field.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CurrentField(object): + def __init__(self): + """Creates an instance of CurrentField""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference.py new file mode 100644 index 0000000..95b9b53 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class DuplicateCheckPreference(object): + def __init__(self): + """Creates an instance of DuplicateCheckPreference""" + + self.__type = None + self.__type_configurations = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_type_configurations(self): + """ + The method to get the type_configurations + + Returns: + list: An instance of list + """ + + return self.__type_configurations + + def set_type_configurations(self, type_configurations): + """ + The method to set the value to type_configurations + + Parameters: + type_configurations (list) : An instance of list + """ + + if type_configurations is not None and not isinstance(type_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type_configurations EXPECTED TYPE: list', None, None) + + self.__type_configurations = type_configurations + self.__key_modified['type_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference_operations.py new file mode 100644 index 0000000..17ee055 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference_operations.py @@ -0,0 +1,164 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class DuplicateCheckPreferenceOperations(object): + def __init__(self, module=None): + """ + Creates an instance of DuplicateCheckPreferenceOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def get_duplicate_check_preference(self): + """ + The method to get duplicate check preference + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/duplicate_check_preference' + 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.DuplicateCheckPreference.GetDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_duplicate_check_preference(self, request): + """ + The method to create duplicate check preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/duplicate_check_preference' + 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('module', 'com.zoho.crm.api.DuplicateCheckPreference.CreateDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_duplicate_check_preference(self, request): + """ + The method to update duplicate check preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/duplicate_check_preference' + 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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.DuplicateCheckPreference.UpdateDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_duplicate_check_preference(self): + """ + The method to delete duplicate check preference + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/duplicate_check_preference' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.DuplicateCheckPreference.DeleteDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetDuplicateCheckPreferenceParam(object): + pass + + +class CreateDuplicateCheckPreferenceParam(object): + pass + + +class UpdateDuplicateCheckPreferenceParam(object): + pass + + +class DeleteDuplicateCheckPreferenceParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/expected_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/expected_fields.py new file mode 100644 index 0000000..eed098e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/expected_fields.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExpectedFields(object): + def __init__(self): + """Creates an instance of ExpectedFields""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/field_mappings.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/field_mappings.py new file mode 100644 index 0000000..504d770 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/field_mappings.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldMappings(object): + def __init__(self): + """Creates an instance of FieldMappings""" + + self.__current_field = None + self.__mapped_field = None + self.__key_modified = dict() + + def get_current_field(self): + """ + The method to get the current_field + + Returns: + CurrentField: An instance of CurrentField + """ + + return self.__current_field + + def set_current_field(self, current_field): + """ + The method to set the value to current_field + + Parameters: + current_field (CurrentField) : An instance of CurrentField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.current_field import CurrentField + except Exception: + from .current_field import CurrentField + + if current_field is not None and not isinstance(current_field, CurrentField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: current_field EXPECTED TYPE: CurrentField', None, None) + + self.__current_field = current_field + self.__key_modified['current_field'] = 1 + + def get_mapped_field(self): + """ + The method to get the mapped_field + + Returns: + MappedField: An instance of MappedField + """ + + return self.__mapped_field + + def set_mapped_field(self, mapped_field): + """ + The method to set the value to mapped_field + + Parameters: + mapped_field (MappedField) : An instance of MappedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.mapped_field import MappedField + except Exception: + from .mapped_field import MappedField + + if mapped_field is not None and not isinstance(mapped_field, MappedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mapped_field EXPECTED TYPE: MappedField', None, None) + + self.__mapped_field = mapped_field + self.__key_modified['mapped_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_field.py new file mode 100644 index 0000000..e51666b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_field.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MappedField(object): + def __init__(self): + """Creates an instance of MappedField""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_module.py new file mode 100644 index 0000000..96b59e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MappedModule(object): + def __init__(self): + """Creates an instance of MappedModule""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_wrapper.py new file mode 100644 index 0000000..ce81bb3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__duplicate_check_preference = None + self.__key_modified = dict() + + def get_duplicate_check_preference(self): + """ + The method to get the duplicate_check_preference + + Returns: + DuplicateCheckPreference: An instance of DuplicateCheckPreference + """ + + return self.__duplicate_check_preference + + def set_duplicate_check_preference(self, duplicate_check_preference): + """ + The method to set the value to duplicate_check_preference + + Parameters: + duplicate_check_preference (DuplicateCheckPreference) : An instance of DuplicateCheckPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.duplicate_check_preference import DuplicateCheckPreference + except Exception: + from .duplicate_check_preference import DuplicateCheckPreference + + if duplicate_check_preference is not None and not isinstance(duplicate_check_preference, DuplicateCheckPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_preference EXPECTED TYPE: DuplicateCheckPreference', None, None) + + self.__duplicate_check_preference = duplicate_check_preference + self.__key_modified['duplicate_check_preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/success_response.py new file mode 100644 index 0000000..f351f55 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/type_configuration.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/type_configuration.py new file mode 100644 index 0000000..572c9cd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/type_configuration.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TypeConfiguration(object): + def __init__(self): + """Creates an instance of TypeConfiguration""" + + self.__field_mappings = None + self.__mapped_module = None + self.__key_modified = dict() + + def get_field_mappings(self): + """ + The method to get the field_mappings + + Returns: + list: An instance of list + """ + + return self.__field_mappings + + def set_field_mappings(self, field_mappings): + """ + The method to set the value to field_mappings + + Parameters: + field_mappings (list) : An instance of list + """ + + if field_mappings is not None and not isinstance(field_mappings, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_mappings EXPECTED TYPE: list', None, None) + + self.__field_mappings = field_mappings + self.__key_modified['field_mappings'] = 1 + + def get_mapped_module(self): + """ + The method to get the mapped_module + + Returns: + MappedModule: An instance of MappedModule + """ + + return self.__mapped_module + + def set_mapped_module(self, mapped_module): + """ + The method to set the value to mapped_module + + Parameters: + mapped_module (MappedModule) : An instance of MappedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.mapped_module import MappedModule + except Exception: + from .mapped_module import MappedModule + + if mapped_module is not None and not isinstance(mapped_module, MappedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mapped_module EXPECTED TYPE: MappedModule', None, None) + + self.__mapped_module = mapped_module + self.__key_modified['mapped_module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/__init__.py new file mode 100644 index 0000000..97e9a5a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/__init__.py @@ -0,0 +1,6 @@ +from .data_map import DataMap +from .data import Data +from .signature import Signature +from .features_available import FeaturesAvailable +from .from_address import FromAddress +from .user import User diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data.py new file mode 100644 index 0000000..fa0a817 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Data(object): + def __init__(self): + """Creates an instance of Data""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data_map.py new file mode 100644 index 0000000..b43c7b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data_map.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataMap(object): + def __init__(self): + """Creates an instance of DataMap""" + + self.__user = None + self.__features_available = None + self.__from_address = None + self.__relay_domains = None + self.__mergefieldsdata = None + self.__key_modified = dict() + + def get_user(self): + """ + The method to get the user + + Returns: + User: An instance of User + """ + + return self.__user + + def set_user(self, user): + """ + The method to set the value to user + + Parameters: + user (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.user import User + except Exception: + from .user import User + + if user is not None and not isinstance(user, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: User', None, None) + + self.__user = user + self.__key_modified['user'] = 1 + + def get_features_available(self): + """ + The method to get the features_available + + Returns: + FeaturesAvailable: An instance of FeaturesAvailable + """ + + return self.__features_available + + def set_features_available(self, features_available): + """ + The method to set the value to features_available + + Parameters: + features_available (FeaturesAvailable) : An instance of FeaturesAvailable + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.features_available import FeaturesAvailable + except Exception: + from .features_available import FeaturesAvailable + + if features_available is not None and not isinstance(features_available, FeaturesAvailable): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: features_available EXPECTED TYPE: FeaturesAvailable', None, None) + + self.__features_available = features_available + self.__key_modified['features_available'] = 1 + + def get_from_address(self): + """ + The method to get the from_address + + Returns: + list: An instance of list + """ + + return self.__from_address + + def set_from_address(self, from_address): + """ + The method to set the value to from_address + + Parameters: + from_address (list) : An instance of list + """ + + if from_address is not None and not isinstance(from_address, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_address EXPECTED TYPE: list', None, None) + + self.__from_address = from_address + self.__key_modified['from_address'] = 1 + + def get_relay_domains(self): + """ + The method to get the relay_domains + + Returns: + list: An instance of list + """ + + return self.__relay_domains + + def set_relay_domains(self, relay_domains): + """ + The method to set the value to relay_domains + + Parameters: + relay_domains (list) : An instance of list + """ + + if relay_domains is not None and not isinstance(relay_domains, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: relay_domains EXPECTED TYPE: list', None, None) + + self.__relay_domains = relay_domains + self.__key_modified['relay_domains'] = 1 + + def get_mergefieldsdata(self): + """ + The method to get the mergefieldsdata + + Returns: + string: A string representing the mergefieldsdata + """ + + return self.__mergefieldsdata + + def set_mergefieldsdata(self, mergefieldsdata): + """ + The method to set the value to mergefieldsdata + + Parameters: + mergefieldsdata (string) : A string representing the mergefieldsdata + """ + + if mergefieldsdata is not None and not isinstance(mergefieldsdata, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mergefieldsdata EXPECTED TYPE: str', None, None) + + self.__mergefieldsdata = mergefieldsdata + self.__key_modified['mergeFieldsData'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/features_available.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/features_available.py new file mode 100644 index 0000000..0e27355 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/features_available.py @@ -0,0 +1,449 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class FeaturesAvailable(object): + def __init__(self): + """Creates an instance of FeaturesAvailable""" + + self.__zsurvey_enabled = None + self.__inline_compose_window = None + self.__schedule_mail = None + self.__email_cloud_picker = None + self.__form_integration_enabled = None + self.__isprivacyenabled = None + self.__auto_suggestion = None + self.__unsubscribe_link = None + self.__best_time_to_contact = None + self.__attach_teamdrive = None + self.__islivedeskenabled = None + self.__subject_line_suggestion = None + self.__email_preference = None + self.__attachment = None + self.__mandateunsublink = None + self.__old_compose_revert = None + self.__key_modified = dict() + + def get_zsurvey_enabled(self): + """ + The method to get the zsurvey_enabled + + Returns: + Choice: An instance of Choice + """ + + return self.__zsurvey_enabled + + def set_zsurvey_enabled(self, zsurvey_enabled): + """ + The method to set the value to zsurvey_enabled + + Parameters: + zsurvey_enabled (Choice) : An instance of Choice + """ + + if zsurvey_enabled is not None and not isinstance(zsurvey_enabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zsurvey_enabled EXPECTED TYPE: Choice', None, None) + + self.__zsurvey_enabled = zsurvey_enabled + self.__key_modified['zsurvey_enabled'] = 1 + + def get_inline_compose_window(self): + """ + The method to get the inline_compose_window + + Returns: + Choice: An instance of Choice + """ + + return self.__inline_compose_window + + def set_inline_compose_window(self, inline_compose_window): + """ + The method to set the value to inline_compose_window + + Parameters: + inline_compose_window (Choice) : An instance of Choice + """ + + if inline_compose_window is not None and not isinstance(inline_compose_window, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inline_compose_window EXPECTED TYPE: Choice', None, None) + + self.__inline_compose_window = inline_compose_window + self.__key_modified['inline_compose_window'] = 1 + + def get_schedule_mail(self): + """ + The method to get the schedule_mail + + Returns: + Choice: An instance of Choice + """ + + return self.__schedule_mail + + def set_schedule_mail(self, schedule_mail): + """ + The method to set the value to schedule_mail + + Parameters: + schedule_mail (Choice) : An instance of Choice + """ + + if schedule_mail is not None and not isinstance(schedule_mail, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: schedule_mail EXPECTED TYPE: Choice', None, None) + + self.__schedule_mail = schedule_mail + self.__key_modified['Schedule_Mail'] = 1 + + def get_email_cloud_picker(self): + """ + The method to get the email_cloud_picker + + Returns: + Choice: An instance of Choice + """ + + return self.__email_cloud_picker + + def set_email_cloud_picker(self, email_cloud_picker): + """ + The method to set the value to email_cloud_picker + + Parameters: + email_cloud_picker (Choice) : An instance of Choice + """ + + if email_cloud_picker is not None and not isinstance(email_cloud_picker, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_cloud_picker EXPECTED TYPE: Choice', None, None) + + self.__email_cloud_picker = email_cloud_picker + self.__key_modified['EMAIL_CLOUD_PICKER'] = 1 + + def get_form_integration_enabled(self): + """ + The method to get the form_integration_enabled + + Returns: + Choice: An instance of Choice + """ + + return self.__form_integration_enabled + + def set_form_integration_enabled(self, form_integration_enabled): + """ + The method to set the value to form_integration_enabled + + Parameters: + form_integration_enabled (Choice) : An instance of Choice + """ + + if form_integration_enabled is not None and not isinstance(form_integration_enabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_integration_enabled EXPECTED TYPE: Choice', None, None) + + self.__form_integration_enabled = form_integration_enabled + self.__key_modified['form_integration_enabled'] = 1 + + def get_isprivacyenabled(self): + """ + The method to get the isprivacyenabled + + Returns: + Choice: An instance of Choice + """ + + return self.__isprivacyenabled + + def set_isprivacyenabled(self, isprivacyenabled): + """ + The method to set the value to isprivacyenabled + + Parameters: + isprivacyenabled (Choice) : An instance of Choice + """ + + if isprivacyenabled is not None and not isinstance(isprivacyenabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isprivacyenabled EXPECTED TYPE: Choice', None, None) + + self.__isprivacyenabled = isprivacyenabled + self.__key_modified['isPrivacyEnabled'] = 1 + + def get_auto_suggestion(self): + """ + The method to get the auto_suggestion + + Returns: + Choice: An instance of Choice + """ + + return self.__auto_suggestion + + def set_auto_suggestion(self, auto_suggestion): + """ + The method to set the value to auto_suggestion + + Parameters: + auto_suggestion (Choice) : An instance of Choice + """ + + if auto_suggestion is not None and not isinstance(auto_suggestion, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_suggestion EXPECTED TYPE: Choice', None, None) + + self.__auto_suggestion = auto_suggestion + self.__key_modified['auto_suggestion'] = 1 + + def get_unsubscribe_link(self): + """ + The method to get the unsubscribe_link + + Returns: + Choice: An instance of Choice + """ + + return self.__unsubscribe_link + + def set_unsubscribe_link(self, unsubscribe_link): + """ + The method to set the value to unsubscribe_link + + Parameters: + unsubscribe_link (Choice) : An instance of Choice + """ + + if unsubscribe_link is not None and not isinstance(unsubscribe_link, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_link EXPECTED TYPE: Choice', None, None) + + self.__unsubscribe_link = unsubscribe_link + self.__key_modified['UNSUBSCRIBE_LINK'] = 1 + + def get_best_time_to_contact(self): + """ + The method to get the best_time_to_contact + + Returns: + Choice: An instance of Choice + """ + + return self.__best_time_to_contact + + def set_best_time_to_contact(self, best_time_to_contact): + """ + The method to set the value to best_time_to_contact + + Parameters: + best_time_to_contact (Choice) : An instance of Choice + """ + + if best_time_to_contact is not None and not isinstance(best_time_to_contact, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: best_time_to_contact EXPECTED TYPE: Choice', None, None) + + self.__best_time_to_contact = best_time_to_contact + self.__key_modified['best_time_to_contact'] = 1 + + def get_attach_teamdrive(self): + """ + The method to get the attach_teamdrive + + Returns: + Choice: An instance of Choice + """ + + return self.__attach_teamdrive + + def set_attach_teamdrive(self, attach_teamdrive): + """ + The method to set the value to attach_teamdrive + + Parameters: + attach_teamdrive (Choice) : An instance of Choice + """ + + if attach_teamdrive is not None and not isinstance(attach_teamdrive, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attach_teamdrive EXPECTED TYPE: Choice', None, None) + + self.__attach_teamdrive = attach_teamdrive + self.__key_modified['attach_teamdrive'] = 1 + + def get_islivedeskenabled(self): + """ + The method to get the islivedeskenabled + + Returns: + Choice: An instance of Choice + """ + + return self.__islivedeskenabled + + def set_islivedeskenabled(self, islivedeskenabled): + """ + The method to set the value to islivedeskenabled + + Parameters: + islivedeskenabled (Choice) : An instance of Choice + """ + + if islivedeskenabled is not None and not isinstance(islivedeskenabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: islivedeskenabled EXPECTED TYPE: Choice', None, None) + + self.__islivedeskenabled = islivedeskenabled + self.__key_modified['isLiveDeskEnabled'] = 1 + + def get_subject_line_suggestion(self): + """ + The method to get the subject_line_suggestion + + Returns: + bool: A bool representing the subject_line_suggestion + """ + + return self.__subject_line_suggestion + + def set_subject_line_suggestion(self, subject_line_suggestion): + """ + The method to set the value to subject_line_suggestion + + Parameters: + subject_line_suggestion (bool) : A bool representing the subject_line_suggestion + """ + + if subject_line_suggestion is not None and not isinstance(subject_line_suggestion, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject_line_suggestion EXPECTED TYPE: bool', None, None) + + self.__subject_line_suggestion = subject_line_suggestion + self.__key_modified['subject_line_suggestion'] = 1 + + def get_email_preference(self): + """ + The method to get the email_preference + + Returns: + bool: A bool representing the email_preference + """ + + return self.__email_preference + + def set_email_preference(self, email_preference): + """ + The method to set the value to email_preference + + Parameters: + email_preference (bool) : A bool representing the email_preference + """ + + if email_preference is not None and not isinstance(email_preference, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_preference EXPECTED TYPE: bool', None, None) + + self.__email_preference = email_preference + self.__key_modified['EMAIL_PREFERENCE'] = 1 + + def get_attachment(self): + """ + The method to get the attachment + + Returns: + bool: A bool representing the attachment + """ + + return self.__attachment + + def set_attachment(self, attachment): + """ + The method to set the value to attachment + + Parameters: + attachment (bool) : A bool representing the attachment + """ + + if attachment is not None and not isinstance(attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment EXPECTED TYPE: bool', None, None) + + self.__attachment = attachment + self.__key_modified['ATTACHMENT'] = 1 + + def get_mandateunsublink(self): + """ + The method to get the mandateunsublink + + Returns: + bool: A bool representing the mandateunsublink + """ + + return self.__mandateunsublink + + def set_mandateunsublink(self, mandateunsublink): + """ + The method to set the value to mandateunsublink + + Parameters: + mandateunsublink (bool) : A bool representing the mandateunsublink + """ + + if mandateunsublink is not None and not isinstance(mandateunsublink, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mandateunsublink EXPECTED TYPE: bool', None, None) + + self.__mandateunsublink = mandateunsublink + self.__key_modified['mandateUnsubLink'] = 1 + + def get_old_compose_revert(self): + """ + The method to get the old_compose_revert + + Returns: + bool: A bool representing the old_compose_revert + """ + + return self.__old_compose_revert + + def set_old_compose_revert(self, old_compose_revert): + """ + The method to set the value to old_compose_revert + + Parameters: + old_compose_revert (bool) : A bool representing the old_compose_revert + """ + + if old_compose_revert is not None and not isinstance(old_compose_revert, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: old_compose_revert EXPECTED TYPE: bool', None, None) + + self.__old_compose_revert = old_compose_revert + self.__key_modified['OLD_COMPOSE_REVERT'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/from_address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/from_address.py new file mode 100644 index 0000000..7e068e1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/from_address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class FromAddress(object): + def __init__(self): + """Creates an instance of FromAddress""" + + self.__user_name = None + self.__type = None + self.__email = None + self.__id = None + self.__default = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + Choice: An instance of Choice + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (Choice) : An instance of Choice + """ + + if default is not None and not isinstance(default, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Choice', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/signature.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/signature.py new file mode 100644 index 0000000..96f9877 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/signature.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Signature(object): + def __init__(self): + """Creates an instance of Signature""" + + self.__mode = None + self.__sign = None + self.__key_modified = dict() + + def get_mode(self): + """ + The method to get the mode + + Returns: + int: An int representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (int) : An int representing the mode + """ + + if mode is not None and not isinstance(mode, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: int', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_sign(self): + """ + The method to get the sign + + Returns: + string: A string representing the sign + """ + + return self.__sign + + def set_sign(self, sign): + """ + The method to set the value to sign + + Parameters: + sign (string) : A string representing the sign + """ + + if sign is not None and not isinstance(sign, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign EXPECTED TYPE: str', None, None) + + self.__sign = sign + self.__key_modified['sign'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/user.py new file mode 100644 index 0000000..11289ec --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/user.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__full_name = None + self.__email = None + self.__zuid = None + self.__zgid = None + self.__signature = None + self.__key_modified = dict() + + def get_full_name(self): + """ + The method to get the full_name + + Returns: + string: A string representing the full_name + """ + + return self.__full_name + + def set_full_name(self, full_name): + """ + The method to set the value to full_name + + Parameters: + full_name (string) : A string representing the full_name + """ + + if full_name is not None and not isinstance(full_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: full_name EXPECTED TYPE: str', None, None) + + self.__full_name = full_name + self.__key_modified['full_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def get_zgid(self): + """ + The method to get the zgid + + Returns: + string: A string representing the zgid + """ + + return self.__zgid + + def set_zgid(self, zgid): + """ + The method to set the value to zgid + + Parameters: + zgid (string) : A string representing the zgid + """ + + if zgid is not None and not isinstance(zgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zgid EXPECTED TYPE: str', None, None) + + self.__zgid = zgid + self.__key_modified['zgid'] = 1 + + def get_signature(self): + """ + The method to get the signature + + Returns: + Signature: An instance of Signature + """ + + return self.__signature + + def set_signature(self, signature): + """ + The method to set the value to signature + + Parameters: + signature (Signature) : An instance of Signature + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.signature import Signature + except Exception: + from .signature import Signature + + if signature is not None and not isinstance(signature, Signature): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signature EXPECTED TYPE: Signature', None, None) + + self.__signature = signature + self.__key_modified['signature'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/__init__.py new file mode 100644 index 0000000..c0a31b2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/__init__.py @@ -0,0 +1,13 @@ +from .template import Template +from .action_wrapper import ActionWrapper +from .schedule_details import ScheduleDetails +from .attachments import Attachments +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .email_drafts import EmailDrafts +from .inventory_details import InventoryDetails +from .response_wrapper import ResponseWrapper +from .to import To +from .inventory_template import InventoryTemplate diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_wrapper.py new file mode 100644 index 0000000..8c78729 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__emaildrafts = None + self.__key_modified = dict() + + def get_emaildrafts(self): + """ + The method to get the emaildrafts + + Returns: + list: An instance of list + """ + + return self.__emaildrafts + + def set_emaildrafts(self, emaildrafts): + """ + The method to set the value to emaildrafts + + Parameters: + emaildrafts (list) : An instance of list + """ + + if emaildrafts is not None and not isinstance(emaildrafts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emaildrafts EXPECTED TYPE: list', None, None) + + self.__emaildrafts = emaildrafts + self.__key_modified['__email_drafts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/api_exception.py new file mode 100644 index 0000000..5b34510 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class APIException(ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/attachments.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/attachments.py new file mode 100644 index 0000000..9979bce --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/attachments.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachments(object): + def __init__(self): + """Creates an instance of Attachments""" + + self.__service_name = None + self.__file_size = None + self.__id = None + self.__file_name = None + self.__key_modified = dict() + + def get_service_name(self): + """ + The method to get the service_name + + Returns: + string: A string representing the service_name + """ + + return self.__service_name + + def set_service_name(self, service_name): + """ + The method to set the value to service_name + + Parameters: + service_name (string) : A string representing the service_name + """ + + if service_name is not None and not isinstance(service_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_name EXPECTED TYPE: str', None, None) + + self.__service_name = service_name + self.__key_modified['service_name'] = 1 + + def get_file_size(self): + """ + The method to get the file_size + + Returns: + string: A string representing the file_size + """ + + return self.__file_size + + def set_file_size(self, file_size): + """ + The method to set the value to file_size + + Parameters: + file_size (string) : A string representing the file_size + """ + + if file_size is not None and not isinstance(file_size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_size EXPECTED TYPE: str', None, None) + + self.__file_size = file_size + self.__key_modified['file_size'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/body_wrapper.py new file mode 100644 index 0000000..3d1b65f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__emaildrafts = None + self.__key_modified = dict() + + def get_emaildrafts(self): + """ + The method to get the emaildrafts + + Returns: + list: An instance of list + """ + + return self.__emaildrafts + + def set_emaildrafts(self, emaildrafts): + """ + The method to set the value to emaildrafts + + Parameters: + emaildrafts (list) : An instance of list + """ + + if emaildrafts is not None and not isinstance(emaildrafts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emaildrafts EXPECTED TYPE: list', None, None) + + self.__emaildrafts = emaildrafts + self.__key_modified['__email_drafts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/email_drafts.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/email_drafts.py new file mode 100644 index 0000000..a9edb5e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/email_drafts.py @@ -0,0 +1,493 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailDrafts(object): + def __init__(self): + """Creates an instance of EmailDrafts""" + + self.__id = None + self.__modified_time = None + self.__created_time = None + self.__from_1 = None + self.__to = None + self.__reply_to = None + self.__cc = None + self.__bcc = None + self.__template = None + self.__inventory_details = None + self.__attachments = None + self.__schedule_details = None + self.__rich_text = None + self.__email_opt_out = None + self.__subject = None + self.__content = None + self.__summary = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_from(self): + """ + The method to get the from + + Returns: + string: A string representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (string) : A string representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: str', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_reply_to(self): + """ + The method to get the reply_to + + Returns: + string: A string representing the reply_to + """ + + return self.__reply_to + + def set_reply_to(self, reply_to): + """ + The method to set the value to reply_to + + Parameters: + reply_to (string) : A string representing the reply_to + """ + + if reply_to is not None and not isinstance(reply_to, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reply_to EXPECTED TYPE: str', None, None) + + self.__reply_to = reply_to + self.__key_modified['reply_to'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_bcc(self): + """ + The method to get the bcc + + Returns: + list: An instance of list + """ + + return self.__bcc + + def set_bcc(self, bcc): + """ + The method to set the value to bcc + + Parameters: + bcc (list) : An instance of list + """ + + if bcc is not None and not isinstance(bcc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc EXPECTED TYPE: list', None, None) + + self.__bcc = bcc + self.__key_modified['bcc'] = 1 + + def get_template(self): + """ + The method to get the template + + Returns: + Template: An instance of Template + """ + + return self.__template + + def set_template(self, template): + """ + The method to set the value to template + + Parameters: + template (Template) : An instance of Template + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.template import Template + except Exception: + from .template import Template + + if template is not None and not isinstance(template, Template): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: Template', None, None) + + self.__template = template + self.__key_modified['template'] = 1 + + def get_inventory_details(self): + """ + The method to get the inventory_details + + Returns: + InventoryDetails: An instance of InventoryDetails + """ + + return self.__inventory_details + + def set_inventory_details(self, inventory_details): + """ + The method to set the value to inventory_details + + Parameters: + inventory_details (InventoryDetails) : An instance of InventoryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.inventory_details import InventoryDetails + except Exception: + from .inventory_details import InventoryDetails + + if inventory_details is not None and not isinstance(inventory_details, InventoryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_details EXPECTED TYPE: InventoryDetails', None, None) + + self.__inventory_details = inventory_details + self.__key_modified['inventory_details'] = 1 + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_schedule_details(self): + """ + The method to get the schedule_details + + Returns: + ScheduleDetails: An instance of ScheduleDetails + """ + + return self.__schedule_details + + def set_schedule_details(self, schedule_details): + """ + The method to set the value to schedule_details + + Parameters: + schedule_details (ScheduleDetails) : An instance of ScheduleDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.schedule_details import ScheduleDetails + except Exception: + from .schedule_details import ScheduleDetails + + if schedule_details is not None and not isinstance(schedule_details, ScheduleDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: schedule_details EXPECTED TYPE: ScheduleDetails', None, None) + + self.__schedule_details = schedule_details + self.__key_modified['schedule_details'] = 1 + + def get_rich_text(self): + """ + The method to get the rich_text + + Returns: + bool: A bool representing the rich_text + """ + + return self.__rich_text + + def set_rich_text(self, rich_text): + """ + The method to set the value to rich_text + + Parameters: + rich_text (bool) : A bool representing the rich_text + """ + + if rich_text is not None and not isinstance(rich_text, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rich_text EXPECTED TYPE: bool', None, None) + + self.__rich_text = rich_text + self.__key_modified['rich_text'] = 1 + + def get_email_opt_out(self): + """ + The method to get the email_opt_out + + Returns: + bool: A bool representing the email_opt_out + """ + + return self.__email_opt_out + + def set_email_opt_out(self, email_opt_out): + """ + The method to set the value to email_opt_out + + Parameters: + email_opt_out (bool) : A bool representing the email_opt_out + """ + + if email_opt_out is not None and not isinstance(email_opt_out, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_opt_out EXPECTED TYPE: bool', None, None) + + self.__email_opt_out = email_opt_out + self.__key_modified['email_opt_out'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_summary(self): + """ + The method to get the summary + + Returns: + string: A string representing the summary + """ + + return self.__summary + + def set_summary(self, summary): + """ + The method to set the value to summary + + Parameters: + summary (string) : A string representing the summary + """ + + if summary is not None and not isinstance(summary, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: summary EXPECTED TYPE: str', None, None) + + self.__summary = summary + self.__key_modified['summary'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_details.py new file mode 100644 index 0000000..03f57f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_details.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryDetails(object): + def __init__(self): + """Creates an instance of InventoryDetails""" + + self.__inventory_template = None + self.__record = None + self.__paper_type = None + self.__view_type = None + self.__key_modified = dict() + + def get_inventory_template(self): + """ + The method to get the inventory_template + + Returns: + InventoryTemplate: An instance of InventoryTemplate + """ + + return self.__inventory_template + + def set_inventory_template(self, inventory_template): + """ + The method to set the value to inventory_template + + Parameters: + inventory_template (InventoryTemplate) : An instance of InventoryTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.inventory_template import InventoryTemplate + except Exception: + from .inventory_template import InventoryTemplate + + if inventory_template is not None and not isinstance(inventory_template, InventoryTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_template EXPECTED TYPE: InventoryTemplate', None, None) + + self.__inventory_template = inventory_template + self.__key_modified['inventory_template'] = 1 + + def get_record(self): + """ + The method to get the record + + Returns: + Record: An instance of Record + """ + + return self.__record + + def set_record(self, record): + """ + The method to set the value to record + + Parameters: + record (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if record is not None and not isinstance(record, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: Record', None, None) + + self.__record = record + self.__key_modified['record'] = 1 + + def get_paper_type(self): + """ + The method to get the paper_type + + Returns: + string: A string representing the paper_type + """ + + return self.__paper_type + + def set_paper_type(self, paper_type): + """ + The method to set the value to paper_type + + Parameters: + paper_type (string) : A string representing the paper_type + """ + + if paper_type is not None and not isinstance(paper_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paper_type EXPECTED TYPE: str', None, None) + + self.__paper_type = paper_type + self.__key_modified['paper_type'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + string: A string representing the view_type + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (string) : A string representing the view_type + """ + + if view_type is not None and not isinstance(view_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: str', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_template.py new file mode 100644 index 0000000..e8124fb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryTemplate(object): + def __init__(self): + """Creates an instance of InventoryTemplate""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/response_wrapper.py new file mode 100644 index 0000000..3774947 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__emaildrafts = None + self.__key_modified = dict() + + def get_emaildrafts(self): + """ + The method to get the emaildrafts + + Returns: + list: An instance of list + """ + + return self.__emaildrafts + + def set_emaildrafts(self, emaildrafts): + """ + The method to set the value to emaildrafts + + Parameters: + emaildrafts (list) : An instance of list + """ + + if emaildrafts is not None and not isinstance(emaildrafts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emaildrafts EXPECTED TYPE: list', None, None) + + self.__emaildrafts = emaildrafts + self.__key_modified['__email_drafts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/schedule_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/schedule_details.py new file mode 100644 index 0000000..1765ce3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/schedule_details.py @@ -0,0 +1,123 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScheduleDetails(object): + def __init__(self): + """Creates an instance of ScheduleDetails""" + + self.__time = None + self.__timezone = None + self.__source = None + self.__key_modified = dict() + + def get_time(self): + """ + The method to get the time + + Returns: + datetime: An instance of datetime + """ + + return self.__time + + def set_time(self, time): + """ + The method to set the value to time + + Parameters: + time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if time is not None and not isinstance(time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time EXPECTED TYPE: datetime', None, None) + + self.__time = time + self.__key_modified['time'] = 1 + + def get_timezone(self): + """ + The method to get the timezone + + Returns: + string: An instance of string + """ + + return self.__timezone + + def set_timezone(self, timezone): + """ + The method to set the value to timezone + + Parameters: + timezone (string) : An instance of string + """ + + self.__timezone = timezone + self.__key_modified['timezone'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/success_response.py new file mode 100644 index 0000000..3c4cdca --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/template.py new file mode 100644 index 0000000..5310677 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Template(object): + def __init__(self): + """Creates an instance of Template""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/to.py new file mode 100644 index 0000000..dbe309e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_drafts/to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class To(object): + def __init__(self): + """Creates an instance of To""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/__init__.py new file mode 100644 index 0000000..ae0a2d3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/__init__.py @@ -0,0 +1,13 @@ +from .attachments import Attachments +from .user_details import UserDetails +from .criteria import Criteria +from .module import Module +from .email_related_records_operations import EmailRelatedRecordsOperations, GetEmailsRelatedRecordsParam, GetEmailsRelatedRecordParam +from .linked_record import LinkedRecord +from .api_exception import APIException +from .response_handler import ResponseHandler +from .field import Field +from .response_wrapper import ResponseWrapper +from .email import Email +from .info import Info +from .status import Status diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/api_exception.py new file mode 100644 index 0000000..192d6c7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/attachments.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/attachments.py new file mode 100644 index 0000000..8332cb3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/attachments.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachments(object): + def __init__(self): + """Creates an instance of Attachments""" + + self.__size = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_size(self): + """ + The method to get the size + + Returns: + string: A string representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (string) : A string representing the size + """ + + if size is not None and not isinstance(size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: str', None, None) + + self.__size = size + self.__key_modified['size'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/criteria.py new file mode 100644 index 0000000..a7a855e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/criteria.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + Choice: An instance of Choice + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (Choice) : An instance of Choice + """ + + if comparator is not None and not isinstance(comparator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Choice', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email.py new file mode 100644 index 0000000..7337825 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email.py @@ -0,0 +1,718 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Email(object): + def __init__(self): + """Creates an instance of Email""" + + self.__attachments = None + self.__thread_id = None + self.__cc = None + self.__summary = None + self.__owner = None + self.__read = None + self.__content = None + self.__sent = None + self.__subject = None + self.__activity_info = None + self.__intent = None + self.__sentiment_info = None + self.__message_id = None + self.__source = None + self.__linked_record = None + self.__sent_time = None + self.__emotion = None + self.__from_1 = None + self.__to = None + self.__time = None + self.__status = None + self.__has_attachment = None + self.__has_thread_attachment = None + self.__editable = None + self.__mail_format = None + self.__reply_to = None + self.__key_modified = dict() + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_thread_id(self): + """ + The method to get the thread_id + + Returns: + int: An int representing the thread_id + """ + + return self.__thread_id + + def set_thread_id(self, thread_id): + """ + The method to set the value to thread_id + + Parameters: + thread_id (int) : An int representing the thread_id + """ + + if thread_id is not None and not isinstance(thread_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: thread_id EXPECTED TYPE: int', None, None) + + self.__thread_id = thread_id + self.__key_modified['thread_id'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_summary(self): + """ + The method to get the summary + + Returns: + string: A string representing the summary + """ + + return self.__summary + + def set_summary(self, summary): + """ + The method to set the value to summary + + Parameters: + summary (string) : A string representing the summary + """ + + if summary is not None and not isinstance(summary, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: summary EXPECTED TYPE: str', None, None) + + self.__summary = summary + self.__key_modified['summary'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_read(self): + """ + The method to get the read + + Returns: + bool: A bool representing the read + """ + + return self.__read + + def set_read(self, read): + """ + The method to set the value to read + + Parameters: + read (bool) : A bool representing the read + """ + + if read is not None and not isinstance(read, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read EXPECTED TYPE: bool', None, None) + + self.__read = read + self.__key_modified['read'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_sent(self): + """ + The method to get the sent + + Returns: + bool: A bool representing the sent + """ + + return self.__sent + + def set_sent(self, sent): + """ + The method to set the value to sent + + Parameters: + sent (bool) : A bool representing the sent + """ + + if sent is not None and not isinstance(sent, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent EXPECTED TYPE: bool', None, None) + + self.__sent = sent + self.__key_modified['sent'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_activity_info(self): + """ + The method to get the activity_info + + Returns: + Object: A Object representing the activity_info + """ + + return self.__activity_info + + def set_activity_info(self, activity_info): + """ + The method to set the value to activity_info + + Parameters: + activity_info (Object) : A Object representing the activity_info + """ + + self.__activity_info = activity_info + self.__key_modified['activity_info'] = 1 + + def get_intent(self): + """ + The method to get the intent + + Returns: + Choice: An instance of Choice + """ + + return self.__intent + + def set_intent(self, intent): + """ + The method to set the value to intent + + Parameters: + intent (Choice) : An instance of Choice + """ + + if intent is not None and not isinstance(intent, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: intent EXPECTED TYPE: Choice', None, None) + + self.__intent = intent + self.__key_modified['intent'] = 1 + + def get_sentiment_info(self): + """ + The method to get the sentiment_info + + Returns: + Choice: An instance of Choice + """ + + return self.__sentiment_info + + def set_sentiment_info(self, sentiment_info): + """ + The method to set the value to sentiment_info + + Parameters: + sentiment_info (Choice) : An instance of Choice + """ + + if sentiment_info is not None and not isinstance(sentiment_info, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sentiment_info EXPECTED TYPE: Choice', None, None) + + self.__sentiment_info = sentiment_info + self.__key_modified['sentiment_info'] = 1 + + def get_message_id(self): + """ + The method to get the message_id + + Returns: + string: A string representing the message_id + """ + + return self.__message_id + + def set_message_id(self, message_id): + """ + The method to set the value to message_id + + Parameters: + message_id (string) : A string representing the message_id + """ + + if message_id is not None and not isinstance(message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message_id EXPECTED TYPE: str', None, None) + + self.__message_id = message_id + self.__key_modified['message_id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def get_sent_time(self): + """ + The method to get the sent_time + + Returns: + string: A string representing the sent_time + """ + + return self.__sent_time + + def set_sent_time(self, sent_time): + """ + The method to set the value to sent_time + + Parameters: + sent_time (string) : A string representing the sent_time + """ + + if sent_time is not None and not isinstance(sent_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent_time EXPECTED TYPE: str', None, None) + + self.__sent_time = sent_time + self.__key_modified['sent_time'] = 1 + + def get_emotion(self): + """ + The method to get the emotion + + Returns: + string: A string representing the emotion + """ + + return self.__emotion + + def set_emotion(self, emotion): + """ + The method to set the value to emotion + + Parameters: + emotion (string) : A string representing the emotion + """ + + if emotion is not None and not isinstance(emotion, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emotion EXPECTED TYPE: str', None, None) + + self.__emotion = emotion + self.__key_modified['emotion'] = 1 + + def get_from(self): + """ + The method to get the from + + Returns: + UserDetails: An instance of UserDetails + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (UserDetails) : An instance of UserDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.user_details import UserDetails + except Exception: + from .user_details import UserDetails + + if from_1 is not None and not isinstance(from_1, UserDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: UserDetails', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_time(self): + """ + The method to get the time + + Returns: + datetime: An instance of datetime + """ + + return self.__time + + def set_time(self, time): + """ + The method to set the value to time + + Parameters: + time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if time is not None and not isinstance(time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time EXPECTED TYPE: datetime', None, None) + + self.__time = time + self.__key_modified['time'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + list: An instance of list + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (list) : An instance of list + """ + + if status is not None and not isinstance(status, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: list', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_has_attachment(self): + """ + The method to get the has_attachment + + Returns: + bool: A bool representing the has_attachment + """ + + return self.__has_attachment + + def set_has_attachment(self, has_attachment): + """ + The method to set the value to has_attachment + + Parameters: + has_attachment (bool) : A bool representing the has_attachment + """ + + if has_attachment is not None and not isinstance(has_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_attachment EXPECTED TYPE: bool', None, None) + + self.__has_attachment = has_attachment + self.__key_modified['has_attachment'] = 1 + + def get_has_thread_attachment(self): + """ + The method to get the has_thread_attachment + + Returns: + bool: A bool representing the has_thread_attachment + """ + + return self.__has_thread_attachment + + def set_has_thread_attachment(self, has_thread_attachment): + """ + The method to set the value to has_thread_attachment + + Parameters: + has_thread_attachment (bool) : A bool representing the has_thread_attachment + """ + + if has_thread_attachment is not None and not isinstance(has_thread_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_thread_attachment EXPECTED TYPE: bool', None, None) + + self.__has_thread_attachment = has_thread_attachment + self.__key_modified['has_thread_attachment'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['editable'] = 1 + + def get_mail_format(self): + """ + The method to get the mail_format + + Returns: + string: A string representing the mail_format + """ + + return self.__mail_format + + def set_mail_format(self, mail_format): + """ + The method to set the value to mail_format + + Parameters: + mail_format (string) : A string representing the mail_format + """ + + if mail_format is not None and not isinstance(mail_format, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_format EXPECTED TYPE: str', None, None) + + self.__mail_format = mail_format + self.__key_modified['mail_format'] = 1 + + def get_reply_to(self): + """ + The method to get the reply_to + + Returns: + UserDetails: An instance of UserDetails + """ + + return self.__reply_to + + def set_reply_to(self, reply_to): + """ + The method to set the value to reply_to + + Parameters: + reply_to (UserDetails) : An instance of UserDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.user_details import UserDetails + except Exception: + from .user_details import UserDetails + + if reply_to is not None and not isinstance(reply_to, UserDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reply_to EXPECTED TYPE: UserDetails', None, None) + + self.__reply_to = reply_to + self.__key_modified['reply_to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email_related_records_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email_related_records_operations.py new file mode 100644 index 0000000..fbfe72f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email_related_records_operations.py @@ -0,0 +1,125 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class EmailRelatedRecordsOperations(object): + def __init__(self, record_id, module_name, type=None, owner_id=None): + """ + Creates an instance of EmailRelatedRecordsOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module_name (string) : A string representing the module_name + type (string) : A string representing the type + owner_id (int) : An int representing the owner_id + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + if owner_id is not None and not isinstance(owner_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner_id EXPECTED TYPE: int', None, None) + + self.__record_id = record_id + self.__module_name = module_name + self.__type = type + self.__owner_id = owner_id + + + def get_emails_related_records(self, param_instance=None): + """ + The method to get emails related records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Emails' + 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('type', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam'), self.__type) + handler_instance.add_param(Param('owner_id', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam'), self.__owner_id) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_emails_related_record(self, message_id): + """ + The method to get emails related record + + Parameters: + message_id (string) : A string representing the message_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Emails/' + api_path = api_path + str(message_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('type', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordParam'), self.__type) + handler_instance.add_param(Param('owner_id', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordParam'), self.__owner_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetEmailsRelatedRecordsParam(object): + filter = Param('filter', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam') + index = Param('index', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam') + + +class GetEmailsRelatedRecordParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/field.py new file mode 100644 index 0000000..0ad50d5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/field.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/info.py new file mode 100644 index 0000000..18ef1f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/info.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__next_index = None + self.__prev_index = None + self.__per_page = None + self.__more_records = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_next_index(self): + """ + The method to get the next_index + + Returns: + string: A string representing the next_index + """ + + return self.__next_index + + def set_next_index(self, next_index): + """ + The method to set the value to next_index + + Parameters: + next_index (string) : A string representing the next_index + """ + + if next_index is not None and not isinstance(next_index, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_index EXPECTED TYPE: str', None, None) + + self.__next_index = next_index + self.__key_modified['next_index'] = 1 + + def get_prev_index(self): + """ + The method to get the prev_index + + Returns: + string: A string representing the prev_index + """ + + return self.__prev_index + + def set_prev_index(self, prev_index): + """ + The method to set the value to prev_index + + Parameters: + prev_index (string) : A string representing the prev_index + """ + + if prev_index is not None and not isinstance(prev_index, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prev_index EXPECTED TYPE: str', None, None) + + self.__prev_index = prev_index + self.__key_modified['prev_index'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/linked_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/linked_record.py new file mode 100644 index 0000000..bc620d4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/linked_record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedRecord(object): + def __init__(self): + """Creates an instance of LinkedRecord""" + + self.__id = None + self.__name = None + self.__module = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_wrapper.py new file mode 100644 index 0000000..18505db --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__emails = None + self.__info = None + self.__key_modified = dict() + + def get_emails(self): + """ + The method to get the emails + + Returns: + list: An instance of list + """ + + return self.__emails + + def set_emails(self, emails): + """ + The method to set the value to emails + + Parameters: + emails (list) : An instance of list + """ + + if emails is not None and not isinstance(emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emails EXPECTED TYPE: list', None, None) + + self.__emails = emails + self.__key_modified['Emails'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/status.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/status.py new file mode 100644 index 0000000..4b08153 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/status.py @@ -0,0 +1,255 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__first_open = None + self.__count = None + self.__type = None + self.__last_open = None + self.__bounced_time = None + self.__bounced_reason = None + self.__category = None + self.__sub_category = None + self.__key_modified = dict() + + def get_first_open(self): + """ + The method to get the first_open + + Returns: + datetime: An instance of datetime + """ + + return self.__first_open + + def set_first_open(self, first_open): + """ + The method to set the value to first_open + + Parameters: + first_open (datetime) : An instance of datetime + """ + + from datetime import datetime + + if first_open is not None and not isinstance(first_open, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_open EXPECTED TYPE: datetime', None, None) + + self.__first_open = first_open + self.__key_modified['first_open'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + string: A string representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (string) : A string representing the count + """ + + if count is not None and not isinstance(count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: str', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_last_open(self): + """ + The method to get the last_open + + Returns: + datetime: An instance of datetime + """ + + return self.__last_open + + def set_last_open(self, last_open): + """ + The method to set the value to last_open + + Parameters: + last_open (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_open is not None and not isinstance(last_open, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_open EXPECTED TYPE: datetime', None, None) + + self.__last_open = last_open + self.__key_modified['last_open'] = 1 + + def get_bounced_time(self): + """ + The method to get the bounced_time + + Returns: + datetime: An instance of datetime + """ + + return self.__bounced_time + + def set_bounced_time(self, bounced_time): + """ + The method to set the value to bounced_time + + Parameters: + bounced_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if bounced_time is not None and not isinstance(bounced_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced_time EXPECTED TYPE: datetime', None, None) + + self.__bounced_time = bounced_time + self.__key_modified['bounced_time'] = 1 + + def get_bounced_reason(self): + """ + The method to get the bounced_reason + + Returns: + string: A string representing the bounced_reason + """ + + return self.__bounced_reason + + def set_bounced_reason(self, bounced_reason): + """ + The method to set the value to bounced_reason + + Parameters: + bounced_reason (string) : A string representing the bounced_reason + """ + + if bounced_reason is not None and not isinstance(bounced_reason, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced_reason EXPECTED TYPE: str', None, None) + + self.__bounced_reason = bounced_reason + self.__key_modified['bounced_reason'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_sub_category(self): + """ + The method to get the sub_category + + Returns: + string: A string representing the sub_category + """ + + return self.__sub_category + + def set_sub_category(self, sub_category): + """ + The method to set the value to sub_category + + Parameters: + sub_category (string) : A string representing the sub_category + """ + + if sub_category is not None and not isinstance(sub_category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_category EXPECTED TYPE: str', None, None) + + self.__sub_category = sub_category + self.__key_modified['sub_category'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/user_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/user_details.py new file mode 100644 index 0000000..839c8d0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_related_records/user_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UserDetails(object): + def __init__(self): + """Creates an instance of UserDetails""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/__init__.py new file mode 100644 index 0000000..54b0ea7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .email_sharing_details_operations import EmailSharingDetailsOperations +from .share_from_user import ShareFromUser +from .response_wrapper import ResponseWrapper +from .email_sharings import EmailSharings diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/api_exception.py new file mode 100644 index 0000000..f343c9c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharing_details_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharing_details_operations.py new file mode 100644 index 0000000..c30ecaf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharing_details_operations.py @@ -0,0 +1,54 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class EmailSharingDetailsOperations(object): + def __init__(self, record_id, module): + """ + Creates an instance of EmailSharingDetailsOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module = module + + + def get_email_sharing_details(self): + """ + The method to get email sharing details + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/__emails_sharing_details' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharings.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharings.py new file mode 100644 index 0000000..cc3f69b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharings.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailSharings(object): + def __init__(self): + """Creates an instance of EmailSharings""" + + self.__share_from_users = None + self.__available_types = None + self.__key_modified = dict() + + def get_share_from_users(self): + """ + The method to get the share_from_users + + Returns: + list: An instance of list + """ + + return self.__share_from_users + + def set_share_from_users(self, share_from_users): + """ + The method to set the value to share_from_users + + Parameters: + share_from_users (list) : An instance of list + """ + + if share_from_users is not None and not isinstance(share_from_users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_from_users EXPECTED TYPE: list', None, None) + + self.__share_from_users = share_from_users + self.__key_modified['share_from_users'] = 1 + + def get_available_types(self): + """ + The method to get the available_types + + Returns: + list: An instance of list + """ + + return self.__available_types + + def set_available_types(self, available_types): + """ + The method to set the value to available_types + + Parameters: + available_types (list) : An instance of list + """ + + if available_types is not None and not isinstance(available_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_types EXPECTED TYPE: list', None, None) + + self.__available_types = available_types + self.__key_modified['available_types'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_wrapper.py new file mode 100644 index 0000000..0c10171 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__emailssharingdetails = None + self.__key_modified = dict() + + def get_emailssharingdetails(self): + """ + The method to get the emailssharingdetails + + Returns: + list: An instance of list + """ + + return self.__emailssharingdetails + + def set_emailssharingdetails(self, emailssharingdetails): + """ + The method to set the value to emailssharingdetails + + Parameters: + emailssharingdetails (list) : An instance of list + """ + + if emailssharingdetails is not None and not isinstance(emailssharingdetails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emailssharingdetails EXPECTED TYPE: list', None, None) + + self.__emailssharingdetails = emailssharingdetails + self.__key_modified['__emails_sharing_details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/share_from_user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/share_from_user.py new file mode 100644 index 0000000..37ad1bb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/share_from_user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShareFromUser(object): + def __init__(self): + """Creates an instance of ShareFromUser""" + + self.__name = None + self.__type = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['_type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/__init__.py new file mode 100644 index 0000000..46a5983 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/__init__.py @@ -0,0 +1,8 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .attachment import Attachment +from .email_templates_operations import EmailTemplatesOperations, GetEmailTemplatesParam +from .response_wrapper import ResponseWrapper +from .last_version_statistics import LastVersionStatistics +from .email_template import EmailTemplate +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/api_exception.py new file mode 100644 index 0000000..d22e630 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/attachment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/attachment.py new file mode 100644 index 0000000..f6a4a11 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/attachment.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachment(object): + def __init__(self): + """Creates an instance of Attachment""" + + self.__size = None + self.__file_name = None + self.__file_id = None + self.__id = None + self.__key_modified = dict() + + def get_size(self): + """ + The method to get the size + + Returns: + int: An int representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (int) : An int representing the size + """ + + if size is not None and not isinstance(size, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: int', None, None) + + self.__size = size + self.__key_modified['size'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_file_id(self): + """ + The method to get the file_id + + Returns: + string: A string representing the file_id + """ + + return self.__file_id + + def set_file_id(self, file_id): + """ + The method to set the value to file_id + + Parameters: + file_id (string) : A string representing the file_id + """ + + if file_id is not None and not isinstance(file_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: str', None, None) + + self.__file_id = file_id + self.__key_modified['file_id'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_template.py new file mode 100644 index 0000000..b32b172 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_template.py @@ -0,0 +1,610 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import InventoryTemplates + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail import Template +except Exception: + from ..exception import SDKException + from ..inventory_templates import InventoryTemplates + from ..util import Constants + from ..send_mail import Template + + +class EmailTemplate(InventoryTemplates, Template): + def __init__(self): + """Creates an instance of EmailTemplate""" + super().__init__() + + self.__attachments = None + self.__subject = None + self.__associated = None + self.__consent_linked = None + self.__description = None + self.__last_version_statistics = None + self.__category = None + self.__created_time = None + self.__modified_time = None + self.__last_usage_time = None + self.__folder = None + self.__module = None + self.__created_by = None + self.__modified_by = None + self.__name = None + self.__id = None + self.__editor_mode = None + self.__favorite = None + self.__content = None + self.__active = None + self.__mail_content = None + self.__key_modified = dict() + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_associated(self): + """ + The method to get the associated + + Returns: + bool: A bool representing the associated + """ + + return self.__associated + + def set_associated(self, associated): + """ + The method to set the value to associated + + Parameters: + associated (bool) : A bool representing the associated + """ + + if associated is not None and not isinstance(associated, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated EXPECTED TYPE: bool', None, None) + + self.__associated = associated + self.__key_modified['associated'] = 1 + + def get_consent_linked(self): + """ + The method to get the consent_linked + + Returns: + bool: A bool representing the consent_linked + """ + + return self.__consent_linked + + def set_consent_linked(self, consent_linked): + """ + The method to set the value to consent_linked + + Parameters: + consent_linked (bool) : A bool representing the consent_linked + """ + + if consent_linked is not None and not isinstance(consent_linked, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_linked EXPECTED TYPE: bool', None, None) + + self.__consent_linked = consent_linked + self.__key_modified['consent_linked'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_last_version_statistics(self): + """ + The method to get the last_version_statistics + + Returns: + LastVersionStatistics: An instance of LastVersionStatistics + """ + + return self.__last_version_statistics + + def set_last_version_statistics(self, last_version_statistics): + """ + The method to set the value to last_version_statistics + + Parameters: + last_version_statistics (LastVersionStatistics) : An instance of LastVersionStatistics + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.last_version_statistics import LastVersionStatistics + except Exception: + from .last_version_statistics import LastVersionStatistics + + if last_version_statistics is not None and not isinstance(last_version_statistics, LastVersionStatistics): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_version_statistics EXPECTED TYPE: LastVersionStatistics', None, None) + + self.__last_version_statistics = last_version_statistics + self.__key_modified['last_version_statistics'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_last_usage_time(self): + """ + The method to get the last_usage_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_usage_time + + def set_last_usage_time(self, last_usage_time): + """ + The method to set the value to last_usage_time + + Parameters: + last_usage_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_usage_time is not None and not isinstance(last_usage_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_usage_time EXPECTED TYPE: datetime', None, None) + + self.__last_usage_time = last_usage_time + self.__key_modified['last_usage_time'] = 1 + + def get_folder(self): + """ + The method to get the folder + + Returns: + Folder: An instance of Folder + """ + + return self.__folder + + def set_folder(self, folder): + """ + The method to set the value to folder + + Parameters: + folder (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import Folder + except Exception: + from ..inventory_templates import Folder + + if folder is not None and not isinstance(folder, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: Folder', None, None) + + self.__folder = folder + self.__key_modified['folder'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import ModuleMap + except Exception: + from ..inventory_templates import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import User + except Exception: + from ..inventory_templates import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import User + except Exception: + from ..inventory_templates import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_editor_mode(self): + """ + The method to get the editor_mode + + Returns: + string: A string representing the editor_mode + """ + + return self.__editor_mode + + def set_editor_mode(self, editor_mode): + """ + The method to set the value to editor_mode + + Parameters: + editor_mode (string) : A string representing the editor_mode + """ + + if editor_mode is not None and not isinstance(editor_mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editor_mode EXPECTED TYPE: str', None, None) + + self.__editor_mode = editor_mode + self.__key_modified['editor_mode'] = 1 + + def get_favorite(self): + """ + The method to get the favorite + + Returns: + bool: A bool representing the favorite + """ + + return self.__favorite + + def set_favorite(self, favorite): + """ + The method to set the value to favorite + + Parameters: + favorite (bool) : A bool representing the favorite + """ + + if favorite is not None and not isinstance(favorite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: bool', None, None) + + self.__favorite = favorite + self.__key_modified['favorite'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_mail_content(self): + """ + The method to get the mail_content + + Returns: + string: A string representing the mail_content + """ + + return self.__mail_content + + def set_mail_content(self, mail_content): + """ + The method to set the value to mail_content + + Parameters: + mail_content (string) : A string representing the mail_content + """ + + if mail_content is not None and not isinstance(mail_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_content EXPECTED TYPE: str', None, None) + + self.__mail_content = mail_content + self.__key_modified['mail_content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_templates_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_templates_operations.py new file mode 100644 index 0000000..8e7b02f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_templates_operations.py @@ -0,0 +1,83 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class EmailTemplatesOperations(object): + def __init__(self): + """Creates an instance of EmailTemplatesOperations""" + pass + + def get_email_templates(self, param_instance=None): + """ + The method to get email templates + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/email_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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_email_template(self, template): + """ + The method to get email template + + Parameters: + template (int) : An int representing the template + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(template, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/email_templates/' + api_path = api_path + str(template) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetEmailTemplatesParam(object): + module = Param('module', 'com.zoho.crm.api.EmailTemplates.GetEmailTemplatesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/last_version_statistics.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/last_version_statistics.py new file mode 100644 index 0000000..a1d3a50 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/last_version_statistics.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LastVersionStatistics(object): + def __init__(self): + """Creates an instance of LastVersionStatistics""" + + self.__tracked = None + self.__delivered = None + self.__opened = None + self.__bounced = None + self.__sent = None + self.__clicked = None + self.__key_modified = dict() + + def get_tracked(self): + """ + The method to get the tracked + + Returns: + int: An int representing the tracked + """ + + return self.__tracked + + def set_tracked(self, tracked): + """ + The method to set the value to tracked + + Parameters: + tracked (int) : An int representing the tracked + """ + + if tracked is not None and not isinstance(tracked, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tracked EXPECTED TYPE: int', None, None) + + self.__tracked = tracked + self.__key_modified['tracked'] = 1 + + def get_delivered(self): + """ + The method to get the delivered + + Returns: + int: An int representing the delivered + """ + + return self.__delivered + + def set_delivered(self, delivered): + """ + The method to set the value to delivered + + Parameters: + delivered (int) : An int representing the delivered + """ + + if delivered is not None and not isinstance(delivered, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delivered EXPECTED TYPE: int', None, None) + + self.__delivered = delivered + self.__key_modified['delivered'] = 1 + + def get_opened(self): + """ + The method to get the opened + + Returns: + int: An int representing the opened + """ + + return self.__opened + + def set_opened(self, opened): + """ + The method to set the value to opened + + Parameters: + opened (int) : An int representing the opened + """ + + if opened is not None and not isinstance(opened, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: opened EXPECTED TYPE: int', None, None) + + self.__opened = opened + self.__key_modified['opened'] = 1 + + def get_bounced(self): + """ + The method to get the bounced + + Returns: + int: An int representing the bounced + """ + + return self.__bounced + + def set_bounced(self, bounced): + """ + The method to set the value to bounced + + Parameters: + bounced (int) : An int representing the bounced + """ + + if bounced is not None and not isinstance(bounced, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced EXPECTED TYPE: int', None, None) + + self.__bounced = bounced + self.__key_modified['bounced'] = 1 + + def get_sent(self): + """ + The method to get the sent + + Returns: + int: An int representing the sent + """ + + return self.__sent + + def set_sent(self, sent): + """ + The method to set the value to sent + + Parameters: + sent (int) : An int representing the sent + """ + + if sent is not None and not isinstance(sent, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent EXPECTED TYPE: int', None, None) + + self.__sent = sent + self.__key_modified['sent'] = 1 + + def get_clicked(self): + """ + The method to get the clicked + + Returns: + int: An int representing the clicked + """ + + return self.__clicked + + def set_clicked(self, clicked): + """ + The method to set the value to clicked + + Parameters: + clicked (int) : An int representing the clicked + """ + + if clicked is not None and not isinstance(clicked, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: clicked EXPECTED TYPE: int', None, None) + + self.__clicked = clicked + self.__key_modified['clicked'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_wrapper.py new file mode 100644 index 0000000..d9a7e9c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__email_templates = None + self.__info = None + self.__key_modified = dict() + + def get_email_templates(self): + """ + The method to get the email_templates + + Returns: + list: An instance of list + """ + + return self.__email_templates + + def set_email_templates(self, email_templates): + """ + The method to set the value to email_templates + + Parameters: + email_templates (list) : An instance of list + """ + + if email_templates is not None and not isinstance(email_templates, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_templates EXPECTED TYPE: list', None, None) + + self.__email_templates = email_templates + self.__key_modified['email_templates'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/__init__.py new file mode 100644 index 0000000..73f395b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/__init__.py @@ -0,0 +1,9 @@ +from .entity_scores_operations import EntityScoresOperations, GetEntityScoreParam, GetEntityScoresParam, GetEntityScoresHeader +from .scoring_rule import ScoringRule +from .api_exception import APIException +from .entity_scores import EntityScores +from .response_handler import ResponseHandler +from .module import Module +from .response_wrapper import ResponseWrapper +from .entity import Entity +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/api_exception.py new file mode 100644 index 0000000..0c6e190 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity.py new file mode 100644 index 0000000..1261643 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Entity(object): + def __init__(self): + """Creates an instance of Entity""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores.py new file mode 100644 index 0000000..0dabdde --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores.py @@ -0,0 +1,334 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EntityScores(object): + def __init__(self): + """Creates an instance of EntityScores""" + + self.__entity = None + self.__positive_score = None + self.__touch_point_score = None + self.__score = None + self.__negative_score = None + self.__touch_point_negative_score = None + self.__scoring_rule = None + self.__field_states = None + self.__id = None + self.__zia_visions = None + self.__touch_point_positive_score = None + self.__key_modified = dict() + + def get_entity(self): + """ + The method to get the entity + + Returns: + Entity: An instance of Entity + """ + + return self.__entity + + def set_entity(self, entity): + """ + The method to set the value to entity + + Parameters: + entity (Entity) : An instance of Entity + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.entity import Entity + except Exception: + from .entity import Entity + + if entity is not None and not isinstance(entity, Entity): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: entity EXPECTED TYPE: Entity', None, None) + + self.__entity = entity + self.__key_modified['Entity'] = 1 + + def get_positive_score(self): + """ + The method to get the positive_score + + Returns: + int: An int representing the positive_score + """ + + return self.__positive_score + + def set_positive_score(self, positive_score): + """ + The method to set the value to positive_score + + Parameters: + positive_score (int) : An int representing the positive_score + """ + + if positive_score is not None and not isinstance(positive_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: positive_score EXPECTED TYPE: int', None, None) + + self.__positive_score = positive_score + self.__key_modified['Positive_Score'] = 1 + + def get_touch_point_score(self): + """ + The method to get the touch_point_score + + Returns: + int: An int representing the touch_point_score + """ + + return self.__touch_point_score + + def set_touch_point_score(self, touch_point_score): + """ + The method to set the value to touch_point_score + + Parameters: + touch_point_score (int) : An int representing the touch_point_score + """ + + if touch_point_score is not None and not isinstance(touch_point_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: touch_point_score EXPECTED TYPE: int', None, None) + + self.__touch_point_score = touch_point_score + self.__key_modified['Touch_Point_Score'] = 1 + + def get_score(self): + """ + The method to get the score + + Returns: + int: An int representing the score + """ + + return self.__score + + def set_score(self, score): + """ + The method to set the value to score + + Parameters: + score (int) : An int representing the score + """ + + if score is not None and not isinstance(score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: score EXPECTED TYPE: int', None, None) + + self.__score = score + self.__key_modified['Score'] = 1 + + def get_negative_score(self): + """ + The method to get the negative_score + + Returns: + int: An int representing the negative_score + """ + + return self.__negative_score + + def set_negative_score(self, negative_score): + """ + The method to set the value to negative_score + + Parameters: + negative_score (int) : An int representing the negative_score + """ + + if negative_score is not None and not isinstance(negative_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: negative_score EXPECTED TYPE: int', None, None) + + self.__negative_score = negative_score + self.__key_modified['Negative_Score'] = 1 + + def get_touch_point_negative_score(self): + """ + The method to get the touch_point_negative_score + + Returns: + int: An int representing the touch_point_negative_score + """ + + return self.__touch_point_negative_score + + def set_touch_point_negative_score(self, touch_point_negative_score): + """ + The method to set the value to touch_point_negative_score + + Parameters: + touch_point_negative_score (int) : An int representing the touch_point_negative_score + """ + + if touch_point_negative_score is not None and not isinstance(touch_point_negative_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: touch_point_negative_score EXPECTED TYPE: int', None, None) + + self.__touch_point_negative_score = touch_point_negative_score + self.__key_modified['Touch_Point_Negative_Score'] = 1 + + def get_scoring_rule(self): + """ + The method to get the scoring_rule + + Returns: + ScoringRule: An instance of ScoringRule + """ + + return self.__scoring_rule + + def set_scoring_rule(self, scoring_rule): + """ + The method to set the value to scoring_rule + + Parameters: + scoring_rule (ScoringRule) : An instance of ScoringRule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.scoring_rule import ScoringRule + except Exception: + from .scoring_rule import ScoringRule + + if scoring_rule is not None and not isinstance(scoring_rule, ScoringRule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rule EXPECTED TYPE: ScoringRule', None, None) + + self.__scoring_rule = scoring_rule + self.__key_modified['Scoring_Rule'] = 1 + + def get_field_states(self): + """ + The method to get the field_states + + Returns: + list: An instance of list + """ + + return self.__field_states + + def set_field_states(self, field_states): + """ + The method to set the value to field_states + + Parameters: + field_states (list) : An instance of list + """ + + if field_states is not None and not isinstance(field_states, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_states EXPECTED TYPE: list', None, None) + + self.__field_states = field_states + self.__key_modified['$field_states'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_zia_visions(self): + """ + The method to get the zia_visions + + Returns: + bool: A bool representing the zia_visions + """ + + return self.__zia_visions + + def set_zia_visions(self, zia_visions): + """ + The method to set the value to zia_visions + + Parameters: + zia_visions (bool) : A bool representing the zia_visions + """ + + if zia_visions is not None and not isinstance(zia_visions, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_visions EXPECTED TYPE: bool', None, None) + + self.__zia_visions = zia_visions + self.__key_modified['$zia_visions'] = 1 + + def get_touch_point_positive_score(self): + """ + The method to get the touch_point_positive_score + + Returns: + int: An int representing the touch_point_positive_score + """ + + return self.__touch_point_positive_score + + def set_touch_point_positive_score(self, touch_point_positive_score): + """ + The method to set the value to touch_point_positive_score + + Parameters: + touch_point_positive_score (int) : An int representing the touch_point_positive_score + """ + + if touch_point_positive_score is not None and not isinstance(touch_point_positive_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: touch_point_positive_score EXPECTED TYPE: int', None, None) + + self.__touch_point_positive_score = touch_point_positive_score + self.__key_modified['Touch_Point_Positive_Score'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores_operations.py new file mode 100644 index 0000000..d56ceb2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores_operations.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class EntityScoresOperations(object): + def __init__(self, fields=None, cvid=None): + """ + Creates an instance of EntityScoresOperations with the given parameters + + Parameters: + fields (string) : A string representing the fields + cvid (string) : A string representing the cvid + """ + + if fields is not None and not isinstance(fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: str', None, None) + + if cvid is not None and not isinstance(cvid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: str', None, None) + + self.__fields = fields + self.__cvid = cvid + + + def get_entity_score(self, record_id): + """ + The method to get entity score + + Parameters: + record_id (int) : An int representing the record_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Entity_Scores__s/' + api_path = api_path + str(record_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('fields', 'com.zoho.crm.api.EntityScores.GetEntityScoreParam'), self.__fields) + handler_instance.add_param(Param('cvid', 'com.zoho.crm.api.EntityScores.GetEntityScoreParam'), self.__cvid) + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_entity_scores(self, param_instance=None, header_instance=None): + """ + The method to get entity scores + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Entity_Scores__s' + 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', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam'), self.__fields) + handler_instance.add_param(Param('cvid', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam'), self.__cvid) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetEntityScoreParam(object): + pass + + +class GetEntityScoresParam(object): + ids = Param('ids', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + page = Param('page', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + per_page = Param('per_page', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + page_token = Param('page_token', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + + +class GetEntityScoresHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.EntityScores.GetEntityScoresHeader') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/info.py new file mode 100644 index 0000000..b2f0541 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/info.py @@ -0,0 +1,274 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__sort_by = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__sort_order = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + string: A string representing the page_token_expiry + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (string) : A string representing the page_token_expiry + """ + + if page_token_expiry is not None and not isinstance(page_token_expiry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: str', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_wrapper.py new file mode 100644 index 0000000..605cc68 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/scoring_rule.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/scoring_rule.py new file mode 100644 index 0000000..22057df --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/entity_scores/scoring_rule.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScoringRule(object): + def __init__(self): + """Creates an instance of ScoringRule""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/exception/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/exception/__init__.py new file mode 100755 index 0000000..dcf5633 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/exception/__init__.py @@ -0,0 +1 @@ +from .sdk_exception import SDKException diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/exception/sdk_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/exception/sdk_exception.py new file mode 100755 index 0000000..2f50bb7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/exception/sdk_exception.py @@ -0,0 +1,38 @@ +import json + + +class SDKException(Exception): + + """ + This class is the common SDKException object. + """ + + message = 'Caused By: {code} - {message}' + + def __init__(self, code=None, message=None, details=None, cause=None): + + """ + Creates an SDKException class instance with the specified parameters. + + Parameters: + code (str) : A string containing the Exception error code. + message (str) : A string containing the Exception error message. + details (dict) : A dict containing the error response. + cause (Exception) : A Exception class instance. + """ + + self.code = code + self.cause = cause + self.details = details + self.error_message = "" if message is None else message + + if self.details is not None: + self.error_message = self.error_message + json.dumps(self.details,default=str) + + if self.cause is not None: + self.error_message = self.error_message + str(self.cause) + + Exception.__init__(self, code, message) + + def __str__(self): + return self.message.format(code=self.code, message=self.error_message) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/__init__.py new file mode 100644 index 0000000..58e9ba0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/__init__.py @@ -0,0 +1,9 @@ +from .features_operations import FeaturesOperations, GetFeatureDetailsParam, GetFeatureDetailParam +from .api_exception import APIException +from .component import Component +from .response_handler import ResponseHandler +from .feature import Feature +from .limit import Limit +from .response_wrapper import ResponseWrapper +from .detail import Detail +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/api_exception.py new file mode 100644 index 0000000..c759a23 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/component.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/component.py new file mode 100644 index 0000000..f458ebe --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/component.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Component(object): + def __init__(self): + """Creates an instance of Component""" + + self.__api_name = None + self.__module_supported = None + self.__details = None + self.__feature_label = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module_supported(self): + """ + The method to get the module_supported + + Returns: + bool: A bool representing the module_supported + """ + + return self.__module_supported + + def set_module_supported(self, module_supported): + """ + The method to set the value to module_supported + + Parameters: + module_supported (bool) : A bool representing the module_supported + """ + + if module_supported is not None and not isinstance(module_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_supported EXPECTED TYPE: bool', None, None) + + self.__module_supported = module_supported + self.__key_modified['module_supported'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + Detail: An instance of Detail + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Detail) : An instance of Detail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.detail import Detail + except Exception: + from .detail import Detail + + if details is not None and not isinstance(details, Detail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Detail', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_feature_label(self): + """ + The method to get the feature_label + + Returns: + string: A string representing the feature_label + """ + + return self.__feature_label + + def set_feature_label(self, feature_label): + """ + The method to set the value to feature_label + + Parameters: + feature_label (string) : A string representing the feature_label + """ + + if feature_label is not None and not isinstance(feature_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_label EXPECTED TYPE: str', None, None) + + self.__feature_label = feature_label + self.__key_modified['feature_label'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/detail.py new file mode 100644 index 0000000..f3a80d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/detail.py @@ -0,0 +1,139 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Detail(object): + def __init__(self): + """Creates an instance of Detail""" + + self.__available_count = None + self.__limits = None + self.__used_count = None + self.__key_modified = dict() + + def get_available_count(self): + """ + The method to get the available_count + + Returns: + Limit: An instance of Limit + """ + + return self.__available_count + + def set_available_count(self, available_count): + """ + The method to set the value to available_count + + Parameters: + available_count (Limit) : An instance of Limit + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.limit import Limit + except Exception: + from .limit import Limit + + if available_count is not None and not isinstance(available_count, Limit): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_count EXPECTED TYPE: Limit', None, None) + + self.__available_count = available_count + self.__key_modified['available_count'] = 1 + + def get_limits(self): + """ + The method to get the limits + + Returns: + Limit: An instance of Limit + """ + + return self.__limits + + def set_limits(self, limits): + """ + The method to set the value to limits + + Parameters: + limits (Limit) : An instance of Limit + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.limit import Limit + except Exception: + from .limit import Limit + + if limits is not None and not isinstance(limits, Limit): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: limits EXPECTED TYPE: Limit', None, None) + + self.__limits = limits + self.__key_modified['limits'] = 1 + + def get_used_count(self): + """ + The method to get the used_count + + Returns: + Limit: An instance of Limit + """ + + return self.__used_count + + def set_used_count(self, used_count): + """ + The method to set the value to used_count + + Parameters: + used_count (Limit) : An instance of Limit + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.limit import Limit + except Exception: + from .limit import Limit + + if used_count is not None and not isinstance(used_count, Limit): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: used_count EXPECTED TYPE: Limit', None, None) + + self.__used_count = used_count + self.__key_modified['used_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/feature.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/feature.py new file mode 100644 index 0000000..4f2b4fb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/feature.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Feature(object): + def __init__(self): + """Creates an instance of Feature""" + + self.__api_name = None + self.__parent_feature = None + self.__module_supported = None + self.__details = None + self.__feature_label = None + self.__components = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_parent_feature(self): + """ + The method to get the parent_feature + + Returns: + Feature: An instance of Feature + """ + + return self.__parent_feature + + def set_parent_feature(self, parent_feature): + """ + The method to set the value to parent_feature + + Parameters: + parent_feature (Feature) : An instance of Feature + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.feature import Feature + except Exception: + from .feature import Feature + + if parent_feature is not None and not isinstance(parent_feature, Feature): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_feature EXPECTED TYPE: Feature', None, None) + + self.__parent_feature = parent_feature + self.__key_modified['parent_feature'] = 1 + + def get_module_supported(self): + """ + The method to get the module_supported + + Returns: + bool: A bool representing the module_supported + """ + + return self.__module_supported + + def set_module_supported(self, module_supported): + """ + The method to set the value to module_supported + + Parameters: + module_supported (bool) : A bool representing the module_supported + """ + + if module_supported is not None and not isinstance(module_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_supported EXPECTED TYPE: bool', None, None) + + self.__module_supported = module_supported + self.__key_modified['module_supported'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + Detail: An instance of Detail + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Detail) : An instance of Detail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.detail import Detail + except Exception: + from .detail import Detail + + if details is not None and not isinstance(details, Detail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Detail', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_feature_label(self): + """ + The method to get the feature_label + + Returns: + string: A string representing the feature_label + """ + + return self.__feature_label + + def set_feature_label(self, feature_label): + """ + The method to set the value to feature_label + + Parameters: + feature_label (string) : A string representing the feature_label + """ + + if feature_label is not None and not isinstance(feature_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_label EXPECTED TYPE: str', None, None) + + self.__feature_label = feature_label + self.__key_modified['feature_label'] = 1 + + def get_components(self): + """ + The method to get the components + + Returns: + list: An instance of list + """ + + return self.__components + + def set_components(self, components): + """ + The method to set the value to components + + Parameters: + components (list) : An instance of list + """ + + if components is not None and not isinstance(components, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: components EXPECTED TYPE: list', None, None) + + self.__components = components + self.__key_modified['components'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/features_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/features_operations.py new file mode 100644 index 0000000..2107009 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/features_operations.py @@ -0,0 +1,144 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FeaturesOperations(object): + def __init__(self): + """Creates an instance of FeaturesOperations""" + pass + + def get_feature_details(self, param_instance=None): + """ + The method to get feature details + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/__features' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_feature_detail(self, feature_api_name, param_instance=None): + """ + The method to get feature detail + + Parameters: + feature_api_name (string) : A string representing the feature_api_name + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(feature_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_api_name EXPECTED TYPE: str', None, None) + + 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/v7/__features/' + api_path = api_path + str(feature_api_name) + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_data_enrichment(self): + """ + The method to get data enrichment + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__features/data_enrichment' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_user_licences_count(self): + """ + The method to get user licences count + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__features/user_licenses' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetFeatureDetailsParam(object): + module = Param('module', 'com.zoho.crm.api.Features.GetFeatureDetailsParam') + api_names = Param('api_names', 'com.zoho.crm.api.Features.GetFeatureDetailsParam') + + +class GetFeatureDetailParam(object): + module = Param('module', 'com.zoho.crm.api.Features.GetFeatureDetailParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/limit.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/limit.py new file mode 100644 index 0000000..ba686d5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/limit.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Limit(object): + def __init__(self): + """Creates an instance of Limit""" + + self.__total = None + self.__edition_limit = None + self.__key_modified = dict() + + def get_total(self): + """ + The method to get the total + + Returns: + int: An int representing the total + """ + + return self.__total + + def set_total(self, total): + """ + The method to set the value to total + + Parameters: + total (int) : An int representing the total + """ + + if total is not None and not isinstance(total, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total EXPECTED TYPE: int', None, None) + + self.__total = total + self.__key_modified['total'] = 1 + + def get_edition_limit(self): + """ + The method to get the edition_limit + + Returns: + int: An int representing the edition_limit + """ + + return self.__edition_limit + + def set_edition_limit(self, edition_limit): + """ + The method to set the value to edition_limit + + Parameters: + edition_limit (int) : An int representing the edition_limit + """ + + if edition_limit is not None and not isinstance(edition_limit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edition_limit EXPECTED TYPE: int', None, None) + + self.__edition_limit = edition_limit + self.__key_modified['edition_limit'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/response_wrapper.py new file mode 100644 index 0000000..545ace3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/features/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__features = None + self.__info = None + self.__key_modified = dict() + + def get_features(self): + """ + The method to get the features + + Returns: + list: An instance of list + """ + + return self.__features + + def set_features(self, features): + """ + The method to set the value to features + + Parameters: + features (list) : An instance of list + """ + + if features is not None and not isinstance(features, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: features EXPECTED TYPE: list', None, None) + + self.__features = features + self.__key_modified['__features'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/__init__.py new file mode 100644 index 0000000..483ad85 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .file_body_wrapper import FileBodyWrapper +from .field_attachments_operations import FieldAttachmentsOperations, GetFieldAttachmentsParam diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/api_exception.py new file mode 100644 index 0000000..85696a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/field_attachments_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/field_attachments_operations.py new file mode 100644 index 0000000..9f253a9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/field_attachments_operations.py @@ -0,0 +1,66 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FieldAttachmentsOperations(object): + def __init__(self, module_api_name, record_id, fields_attachment_id=None): + """ + Creates an instance of FieldAttachmentsOperations with the given parameters + + Parameters: + module_api_name (string) : A string representing the module_api_name + record_id (int) : An int representing the record_id + fields_attachment_id (int) : An int representing the fields_attachment_id + """ + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if fields_attachment_id is not None and not isinstance(fields_attachment_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields_attachment_id EXPECTED TYPE: int', None, None) + + self.__module_api_name = module_api_name + self.__record_id = record_id + self.__fields_attachment_id = fields_attachment_id + + + 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/v7/' + 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 zohocrmsdk.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 GetFieldAttachmentsParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/file_body_wrapper.py new file mode 100644 index 0000000..ca5364e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_attachments/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/__init__.py new file mode 100644 index 0000000..3868bf9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .parent import Parent +from .field_map_dependency_operations import FieldMapDependencyOperations, CreateMapDependencyParam, CreateMapDependencyHeader, GetMapDependenciesParam, UpdateMapDependencyParam, GetMapDependencyParam, DeleteMapDependencyParam +from .pick_list_mapping import PickListMapping +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .map_dependency import MapDependency +from .sub_module import SubModule +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .picklist_map import PicklistMap +from .child import Child +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_wrapper.py new file mode 100644 index 0000000..4bc153c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__map_dependency = None + self.__key_modified = dict() + + def get_map_dependency(self): + """ + The method to get the map_dependency + + Returns: + list: An instance of list + """ + + return self.__map_dependency + + def set_map_dependency(self, map_dependency): + """ + The method to set the value to map_dependency + + Parameters: + map_dependency (list) : An instance of list + """ + + if map_dependency is not None and not isinstance(map_dependency, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: map_dependency EXPECTED TYPE: list', None, None) + + self.__map_dependency = map_dependency + self.__key_modified['map_dependency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/api_exception.py new file mode 100644 index 0000000..95dded1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/body_wrapper.py new file mode 100644 index 0000000..950fe6e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__map_dependency = None + self.__key_modified = dict() + + def get_map_dependency(self): + """ + The method to get the map_dependency + + Returns: + list: An instance of list + """ + + return self.__map_dependency + + def set_map_dependency(self, map_dependency): + """ + The method to set the value to map_dependency + + Parameters: + map_dependency (list) : An instance of list + """ + + if map_dependency is not None and not isinstance(map_dependency, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: map_dependency EXPECTED TYPE: list', None, None) + + self.__map_dependency = map_dependency + self.__key_modified['map_dependency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/child.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/child.py new file mode 100644 index 0000000..7c7d505 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/child.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Child(object): + def __init__(self): + """Creates an instance of Child""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/field_map_dependency_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/field_map_dependency_operations.py new file mode 100644 index 0000000..90fffdf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/field_map_dependency_operations.py @@ -0,0 +1,244 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FieldMapDependencyOperations(object): + def __init__(self, layout_id, module=None): + """ + Creates an instance of FieldMapDependencyOperations with the given parameters + + Parameters: + layout_id (int) : An int representing the layout_id + module (string) : A string representing the module + """ + + if not isinstance(layout_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: int', None, None) + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__layout_id = layout_id + self.__module = module + + + def create_map_dependency(self, request): + """ + The method to create map dependency + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency' + 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('module', 'com.zoho.crm.api.FieldMapDependency.CreateMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_map_dependencies(self, param_instance=None): + """ + The method to get map dependencies + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency' + 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.FieldMapDependency.GetMapDependenciesParam'), self.__module) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_map_dependency(self, dependency_id, request): + """ + The method to update map dependency + + Parameters: + dependency_id (int) : An int representing the dependency_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(dependency_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dependency_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/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency/' + api_path = api_path + str(dependency_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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.FieldMapDependency.UpdateMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_map_dependency(self, dependency_id): + """ + The method to get map dependency + + Parameters: + dependency_id (int) : An int representing the dependency_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(dependency_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dependency_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency/' + api_path = api_path + str(dependency_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.FieldMapDependency.GetMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_map_dependency(self, dependency_id): + """ + The method to delete map dependency + + Parameters: + dependency_id (int) : An int representing the dependency_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(dependency_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dependency_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency/' + api_path = api_path + str(dependency_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.FieldMapDependency.DeleteMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class CreateMapDependencyParam(object): + pass + + +class CreateMapDependencyHeader(object): + pass + + +class GetMapDependenciesParam(object): + page = Param('page', 'com.zoho.crm.api.FieldMapDependency.GetMapDependenciesParam') + per_page = Param('per_page', 'com.zoho.crm.api.FieldMapDependency.GetMapDependenciesParam') + filters = Param('filters', 'com.zoho.crm.api.FieldMapDependency.GetMapDependenciesParam') + + +class UpdateMapDependencyParam(object): + pass + + +class GetMapDependencyParam(object): + pass + + +class DeleteMapDependencyParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/info.py new file mode 100644 index 0000000..b33ef98 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__page = None + self.__per_page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/map_dependency.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/map_dependency.py new file mode 100644 index 0000000..2efbaaa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/map_dependency.py @@ -0,0 +1,289 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MapDependency(object): + def __init__(self): + """Creates an instance of MapDependency""" + + self.__parent = None + self.__child = None + self.__pick_list_values = None + self.__internal = None + self.__active = None + self.__id = None + self.__source = None + self.__category = None + self.__sub_module = None + self.__key_modified = dict() + + def get_parent(self): + """ + The method to get the parent + + Returns: + Parent: An instance of Parent + """ + + return self.__parent + + def set_parent(self, parent): + """ + The method to set the value to parent + + Parameters: + parent (Parent) : An instance of Parent + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.parent import Parent + except Exception: + from .parent import Parent + + if parent is not None and not isinstance(parent, Parent): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent EXPECTED TYPE: Parent', None, None) + + self.__parent = parent + self.__key_modified['parent'] = 1 + + def get_child(self): + """ + The method to get the child + + Returns: + Child: An instance of Child + """ + + return self.__child + + def set_child(self, child): + """ + The method to set the value to child + + Parameters: + child (Child) : An instance of Child + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.child import Child + except Exception: + from .child import Child + + if child is not None and not isinstance(child, Child): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: child EXPECTED TYPE: Child', None, None) + + self.__child = child + self.__key_modified['child'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_internal(self): + """ + The method to get the internal + + Returns: + bool: A bool representing the internal + """ + + return self.__internal + + def set_internal(self, internal): + """ + The method to set the value to internal + + Parameters: + internal (bool) : A bool representing the internal + """ + + if internal is not None and not isinstance(internal, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: internal EXPECTED TYPE: bool', None, None) + + self.__internal = internal + self.__key_modified['internal'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + int: An int representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (int) : An int representing the source + """ + + if source is not None and not isinstance(source, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: int', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + SubModule: An instance of SubModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (SubModule) : An instance of SubModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.sub_module import SubModule + except Exception: + from .sub_module import SubModule + + if sub_module is not None and not isinstance(sub_module, SubModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: SubModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/parent.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/parent.py new file mode 100644 index 0000000..1f3545c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/parent.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Parent(object): + def __init__(self): + """Creates an instance of Parent""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/pick_list_mapping.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/pick_list_mapping.py new file mode 100644 index 0000000..dbebea2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/pick_list_mapping.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PickListMapping(object): + def __init__(self): + """Creates an instance of PickListMapping""" + + self.__id = None + self.__actual_value = None + self.__display_value = None + self.__maps = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_maps(self): + """ + The method to get the maps + + Returns: + list: An instance of list + """ + + return self.__maps + + def set_maps(self, maps): + """ + The method to set the value to maps + + Parameters: + maps (list) : An instance of list + """ + + if maps is not None and not isinstance(maps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: list', None, None) + + self.__maps = maps + self.__key_modified['maps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/picklist_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/picklist_map.py new file mode 100644 index 0000000..6a0d019 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/picklist_map.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PicklistMap(object): + def __init__(self): + """Creates an instance of PicklistMap""" + + self.__id = None + self.__actual_value = None + self.__display_value = None + self.__delete = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_wrapper.py new file mode 100644 index 0000000..136b7ba --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__map_dependency = None + self.__info = None + self.__key_modified = dict() + + def get_map_dependency(self): + """ + The method to get the map_dependency + + Returns: + list: An instance of list + """ + + return self.__map_dependency + + def set_map_dependency(self, map_dependency): + """ + The method to set the value to map_dependency + + Parameters: + map_dependency (list) : An instance of list + """ + + if map_dependency is not None and not isinstance(map_dependency, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: map_dependency EXPECTED TYPE: list', None, None) + + self.__map_dependency = map_dependency + self.__key_modified['map_dependency'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/sub_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/sub_module.py new file mode 100644 index 0000000..61cd5c5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/sub_module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SubModule(object): + def __init__(self): + """Creates an instance of SubModule""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/success_response.py new file mode 100644 index 0000000..561ce2c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/__init__.py new file mode 100644 index 0000000..c575e85 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/__init__.py @@ -0,0 +1,48 @@ +from .history_tracking_module import HistoryTrackingModule +from .layout_association import LayoutAssociation +from .private import Private +from .operation_type import OperationType +from .file_upolad_option import FileUpoladOption +from .criteria import Criteria +from .crypt import Crypt +from .tooltip import Tooltip +from .forecast_category import ForecastCategory +from .textarea import Textarea +from .fields_operations import FieldsOperations, GetFieldsParam, GetFieldsHeader, CreateFieldParam, UpdateFieldsParam, GetFieldParam, GetFieldHeader, UpdateFieldParam, DeleteFieldParam +from .function_parameter import FunctionParameter +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .association_details import AssociationDetails +from .success_response import SuccessResponse +from .email_parser import EmailParser +from .rollup_criteria import RollupCriteria +from .sharing_properties import SharingProperties +from .multi_module_lookup import MultiModuleLookup +from .action_handler import ActionHandler +from .currency import Currency +from .mandatory_details import MandatoryDetails +from .minified_field import MinifiedField +from .action_wrapper import ActionWrapper +from .lookup import Lookup +from .hipaa_compliance import HipaaCompliance +from .convert_mapping import ConvertMapping +from .expression import Expression +from .refer_from_field import ReferFromField +from .show_fields import ShowFields +from .maps import Maps +from .profile import Profile +from .rollup_summary import RollupSummary +from .view_type import ViewType +from .body_wrapper import BodyWrapper +from .subform import Subform +from .external import External +from .history_tracking import HistoryTracking +from .unique import Unique +from .formula import Formula +from .response_wrapper import ResponseWrapper +from .fields import Fields +from .query_details import QueryDetails +from .pick_list_value import PickListValue +from .multiselectlookup import Multiselectlookup +from .auto_number import AutoNumber diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_wrapper.py new file mode 100644 index 0000000..60f0f7c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/api_exception.py new file mode 100644 index 0000000..6d24100 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.fields.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/association_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/association_details.py new file mode 100644 index 0000000..ef1872d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/association_details.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationDetails(object): + def __init__(self): + """Creates an instance of AssociationDetails""" + + self.__related_field = None + self.__lookup_field = None + self.__key_modified = dict() + + def get_related_field(self): + """ + The method to get the related_field + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__related_field + + def set_related_field(self, related_field): + """ + The method to set the value to related_field + + Parameters: + related_field (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if related_field is not None and not isinstance(related_field, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_field EXPECTED TYPE: MinifiedModule', None, None) + + self.__related_field = related_field + self.__key_modified['related_field'] = 1 + + def get_lookup_field(self): + """ + The method to get the lookup_field + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__lookup_field + + def set_lookup_field(self, lookup_field): + """ + The method to set the value to lookup_field + + Parameters: + lookup_field (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if lookup_field is not None and not isinstance(lookup_field, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_field EXPECTED TYPE: MinifiedModule', None, None) + + self.__lookup_field = lookup_field + self.__key_modified['lookup_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/auto_number.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/auto_number.py new file mode 100644 index 0000000..f47dc56 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/auto_number.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutoNumber(object): + def __init__(self): + """Creates an instance of AutoNumber""" + + self.__starting_number_length = None + self.__prefix = None + self.__suffix = None + self.__start_number = None + self.__key_modified = dict() + + def get_starting_number_length(self): + """ + The method to get the starting_number_length + + Returns: + int: An int representing the starting_number_length + """ + + return self.__starting_number_length + + def set_starting_number_length(self, starting_number_length): + """ + The method to set the value to starting_number_length + + Parameters: + starting_number_length (int) : An int representing the starting_number_length + """ + + if starting_number_length is not None and not isinstance(starting_number_length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: starting_number_length EXPECTED TYPE: int', None, None) + + self.__starting_number_length = starting_number_length + self.__key_modified['starting_number_length'] = 1 + + def get_prefix(self): + """ + The method to get the prefix + + Returns: + string: A string representing the prefix + """ + + return self.__prefix + + def set_prefix(self, prefix): + """ + The method to set the value to prefix + + Parameters: + prefix (string) : A string representing the prefix + """ + + if prefix is not None and not isinstance(prefix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix EXPECTED TYPE: str', None, None) + + self.__prefix = prefix + self.__key_modified['prefix'] = 1 + + def get_suffix(self): + """ + The method to get the suffix + + Returns: + string: A string representing the suffix + """ + + return self.__suffix + + def set_suffix(self, suffix): + """ + The method to set the value to suffix + + Parameters: + suffix (string) : A string representing the suffix + """ + + if suffix is not None and not isinstance(suffix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suffix EXPECTED TYPE: str', None, None) + + self.__suffix = suffix + self.__key_modified['suffix'] = 1 + + def get_start_number(self): + """ + The method to get the start_number + + Returns: + int: An int representing the start_number + """ + + return self.__start_number + + def set_start_number(self, start_number): + """ + The method to set the value to start_number + + Parameters: + start_number (int) : An int representing the start_number + """ + + if start_number is not None and not isinstance(start_number, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_number EXPECTED TYPE: int', None, None) + + self.__start_number = start_number + self.__key_modified['start_number'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/body_wrapper.py new file mode 100644 index 0000000..bbb1400 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/convert_mapping.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/convert_mapping.py new file mode 100644 index 0000000..cad894a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/convert_mapping.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertMapping(object): + def __init__(self): + """Creates an instance of ConvertMapping""" + + self.__contacts = None + self.__deals = None + self.__accounts = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + string: A string representing the contacts + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (string) : A string representing the contacts + """ + + if contacts is not None and not isinstance(contacts, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: str', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + string: A string representing the deals + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (string) : A string representing the deals + """ + + if deals is not None and not isinstance(deals, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: str', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + string: A string representing the accounts + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (string) : A string representing the accounts + """ + + if accounts is not None and not isinstance(accounts, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: str', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/criteria.py new file mode 100644 index 0000000..3c48d81 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/crypt.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/crypt.py new file mode 100644 index 0000000..3302bbd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/crypt.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Crypt(object): + def __init__(self): + """Creates an instance of Crypt""" + + self.__mode = None + self.__status = None + self.__column = None + self.__table = None + self.__encfldids = None + self.__notify = None + self.__key_modified = dict() + + def get_mode(self): + """ + The method to get the mode + + Returns: + string: A string representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (string) : A string representing the mode + """ + + if mode is not None and not isinstance(mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: str', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + int: An int representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (int) : An int representing the status + """ + + if status is not None and not isinstance(status, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: int', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_column(self): + """ + The method to get the column + + Returns: + string: A string representing the column + """ + + return self.__column + + def set_column(self, column): + """ + The method to set the value to column + + Parameters: + column (string) : A string representing the column + """ + + if column is not None and not isinstance(column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: str', None, None) + + self.__column = column + self.__key_modified['column'] = 1 + + def get_table(self): + """ + The method to get the table + + Returns: + string: A string representing the table + """ + + return self.__table + + def set_table(self, table): + """ + The method to set the value to table + + Parameters: + table (string) : A string representing the table + """ + + if table is not None and not isinstance(table, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: table EXPECTED TYPE: str', None, None) + + self.__table = table + self.__key_modified['table'] = 1 + + def get_encfldids(self): + """ + The method to get the encfldids + + Returns: + list: An instance of list + """ + + return self.__encfldids + + def set_encfldids(self, encfldids): + """ + The method to set the value to encfldids + + Parameters: + encfldids (list) : An instance of list + """ + + if encfldids is not None and not isinstance(encfldids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encfldids EXPECTED TYPE: list', None, None) + + self.__encfldids = encfldids + self.__key_modified['encFldIds'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + string: A string representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (string) : A string representing the notify + """ + + if notify is not None and not isinstance(notify, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: str', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/currency.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/currency.py new file mode 100644 index 0000000..4bc8b8c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/currency.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__rounding_option = None + self.__precision = None + self.__key_modified = dict() + + def get_rounding_option(self): + """ + The method to get the rounding_option + + Returns: + Choice: An instance of Choice + """ + + return self.__rounding_option + + def set_rounding_option(self, rounding_option): + """ + The method to set the value to rounding_option + + Parameters: + rounding_option (Choice) : An instance of Choice + """ + + if rounding_option is not None and not isinstance(rounding_option, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rounding_option EXPECTED TYPE: Choice', None, None) + + self.__rounding_option = rounding_option + self.__key_modified['rounding_option'] = 1 + + def get_precision(self): + """ + The method to get the precision + + Returns: + int: An int representing the precision + """ + + return self.__precision + + def set_precision(self, precision): + """ + The method to set the value to precision + + Parameters: + precision (int) : An int representing the precision + """ + + if precision is not None and not isinstance(precision, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: precision EXPECTED TYPE: int', None, None) + + self.__precision = precision + self.__key_modified['precision'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/email_parser.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/email_parser.py new file mode 100644 index 0000000..3932f08 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/email_parser.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailParser(object): + def __init__(self): + """Creates an instance of EmailParser""" + + self.__fields_update_supported = None + self.__record_operations_supported = None + self.__key_modified = dict() + + def get_fields_update_supported(self): + """ + The method to get the fields_update_supported + + Returns: + bool: A bool representing the fields_update_supported + """ + + return self.__fields_update_supported + + def set_fields_update_supported(self, fields_update_supported): + """ + The method to set the value to fields_update_supported + + Parameters: + fields_update_supported (bool) : A bool representing the fields_update_supported + """ + + if fields_update_supported is not None and not isinstance(fields_update_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields_update_supported EXPECTED TYPE: bool', None, None) + + self.__fields_update_supported = fields_update_supported + self.__key_modified['fields_update_supported'] = 1 + + def get_record_operations_supported(self): + """ + The method to get the record_operations_supported + + Returns: + bool: A bool representing the record_operations_supported + """ + + return self.__record_operations_supported + + def set_record_operations_supported(self, record_operations_supported): + """ + The method to set the value to record_operations_supported + + Parameters: + record_operations_supported (bool) : A bool representing the record_operations_supported + """ + + if record_operations_supported is not None and not isinstance(record_operations_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_operations_supported EXPECTED TYPE: bool', None, None) + + self.__record_operations_supported = record_operations_supported + self.__key_modified['record_operations_supported'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/expression.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/expression.py new file mode 100644 index 0000000..882aa40 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/expression.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Expression(object): + def __init__(self): + """Creates an instance of Expression""" + + self.__function_parameters = None + self.__criteria = None + self.__function = None + self.__key_modified = dict() + + def get_function_parameters(self): + """ + The method to get the function_parameters + + Returns: + list: An instance of list + """ + + return self.__function_parameters + + def set_function_parameters(self, function_parameters): + """ + The method to set the value to function_parameters + + Parameters: + function_parameters (list) : An instance of list + """ + + if function_parameters is not None and not isinstance(function_parameters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: function_parameters EXPECTED TYPE: list', None, None) + + self.__function_parameters = function_parameters + self.__key_modified['function_parameters'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + RollupCriteria: An instance of RollupCriteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (RollupCriteria) : An instance of RollupCriteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.rollup_criteria import RollupCriteria + except Exception: + from .rollup_criteria import RollupCriteria + + if criteria is not None and not isinstance(criteria, RollupCriteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: RollupCriteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_function(self): + """ + The method to get the function + + Returns: + string: A string representing the function + """ + + return self.__function + + def set_function(self, function): + """ + The method to set the value to function + + Parameters: + function (string) : A string representing the function + """ + + if function is not None and not isinstance(function, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: function EXPECTED TYPE: str', None, None) + + self.__function = function + self.__key_modified['function'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/external.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/external.py new file mode 100644 index 0000000..942e95d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/external.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class External(object): + def __init__(self): + """Creates an instance of External""" + + self.__show = None + self.__type = None + self.__allow_multiple_config = None + self.__key_modified = dict() + + def get_show(self): + """ + The method to get the show + + Returns: + bool: A bool representing the show + """ + + return self.__show + + def set_show(self, show): + """ + The method to set the value to show + + Parameters: + show (bool) : A bool representing the show + """ + + if show is not None and not isinstance(show, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show EXPECTED TYPE: bool', None, None) + + self.__show = show + self.__key_modified['show'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_allow_multiple_config(self): + """ + The method to get the allow_multiple_config + + Returns: + bool: A bool representing the allow_multiple_config + """ + + return self.__allow_multiple_config + + def set_allow_multiple_config(self, allow_multiple_config): + """ + The method to set the value to allow_multiple_config + + Parameters: + allow_multiple_config (bool) : A bool representing the allow_multiple_config + """ + + if allow_multiple_config is not None and not isinstance(allow_multiple_config, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allow_multiple_config EXPECTED TYPE: bool', None, None) + + self.__allow_multiple_config = allow_multiple_config + self.__key_modified['allow_multiple_config'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/fields.py new file mode 100644 index 0000000..af6bd1b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/fields.py @@ -0,0 +1,2135 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__associated_module = None + self.__data_type = None + self.__operation_type = None + self.__system_mandatory = None + self.__webhook = None + self.__sequence_number = None + self.__default_value = None + self.__blueprint_supported = None + self.__virtual_field = None + self.__field_read_only = None + self.__customizable_properties = None + self.__read_only = None + self.__custom_field = None + self.__businesscard_supported = None + self.__filterable = None + self.__visible = None + self.__available_in_user_layout = None + self.__display_field = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__layout_associations = None + self.__separator = None + self.__searchable = None + self.__enable_colour_code = None + self.__mass_update = None + self.__json_type = None + self.__created_source = None + self.__type = None + self.__display_label = None + self.__column_name = None + self.__api_name = None + self.__display_type = None + self.__ui_type = None + self.__colour_code_enabled_by_system = None + self.__length = None + self.__decimal_place = None + self.__quick_sequence_number = None + self.__email_parser = None + self.__rollup_summary = None + self.__refer_from_field = None + self.__created_time = None + self.__modified_time = None + self.__show_type = None + self.__category = None + self.__id = None + self.__multi_module_lookup = None + self.__sharing_properties = None + self.__currency = None + self.__file_upolad_optionlist = None + self.__lookup = None + self.__profiles = None + self.__view_type = None + self.__unique = None + self.__sub_module = None + self.__subform = None + self.__external = None + self.__formula = None + self.__private = None + self.__convert_mapping = None + self.__multiselectlookup = None + self.__multiuserlookup = None + self.__autonumber = None + self.__auto_number_61 = None + self.__pick_list_values = None + self.__crypt = None + self.__tooltip = None + self.__history_tracking = None + self.__association_details = None + self.__allowed_modules = None + self.__additional_column = None + self.__field_label = None + self.__global_picklist = None + self.__hipaa_compliance_enabled = None + self.__hipaa_compliance = None + self.__updateexistingrecords = None + self.__number_separator = None + self.__textarea = None + self.__static_field = None + self.__key_modified = dict() + + def get_associated_module(self): + """ + The method to get the associated_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__associated_module + + def set_associated_module(self, associated_module): + """ + The method to set the value to associated_module + + Parameters: + associated_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if associated_module is not None and not isinstance(associated_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__associated_module = associated_module + self.__key_modified['associated_module'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_operation_type(self): + """ + The method to get the operation_type + + Returns: + OperationType: An instance of OperationType + """ + + return self.__operation_type + + def set_operation_type(self, operation_type): + """ + The method to set the value to operation_type + + Parameters: + operation_type (OperationType) : An instance of OperationType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.operation_type import OperationType + except Exception: + from .operation_type import OperationType + + if operation_type is not None and not isinstance(operation_type, OperationType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_type EXPECTED TYPE: OperationType', None, None) + + self.__operation_type = operation_type + self.__key_modified['operation_type'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_default_value(self): + """ + The method to get the default_value + + Returns: + string: A string representing the default_value + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (string) : A string representing the default_value + """ + + if default_value is not None and not isinstance(default_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: str', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_blueprint_supported(self): + """ + The method to get the blueprint_supported + + Returns: + bool: A bool representing the blueprint_supported + """ + + return self.__blueprint_supported + + def set_blueprint_supported(self, blueprint_supported): + """ + The method to set the value to blueprint_supported + + Parameters: + blueprint_supported (bool) : A bool representing the blueprint_supported + """ + + if blueprint_supported is not None and not isinstance(blueprint_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: bool', None, None) + + self.__blueprint_supported = blueprint_supported + self.__key_modified['blueprint_supported'] = 1 + + def get_virtual_field(self): + """ + The method to get the virtual_field + + Returns: + bool: A bool representing the virtual_field + """ + + return self.__virtual_field + + def set_virtual_field(self, virtual_field): + """ + The method to set the value to virtual_field + + Parameters: + virtual_field (bool) : A bool representing the virtual_field + """ + + if virtual_field is not None and not isinstance(virtual_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: virtual_field EXPECTED TYPE: bool', None, None) + + self.__virtual_field = virtual_field + self.__key_modified['virtual_field'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_customizable_properties(self): + """ + The method to get the customizable_properties + + Returns: + list: An instance of list + """ + + return self.__customizable_properties + + def set_customizable_properties(self, customizable_properties): + """ + The method to set the value to customizable_properties + + Parameters: + customizable_properties (list) : An instance of list + """ + + if customizable_properties is not None and not isinstance(customizable_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable_properties EXPECTED TYPE: list', None, None) + + self.__customizable_properties = customizable_properties + self.__key_modified['customizable_properties'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_businesscard_supported(self): + """ + The method to get the businesscard_supported + + Returns: + bool: A bool representing the businesscard_supported + """ + + return self.__businesscard_supported + + def set_businesscard_supported(self, businesscard_supported): + """ + The method to set the value to businesscard_supported + + Parameters: + businesscard_supported (bool) : A bool representing the businesscard_supported + """ + + if businesscard_supported is not None and not isinstance(businesscard_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: bool', None, None) + + self.__businesscard_supported = businesscard_supported + self.__key_modified['businesscard_supported'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + bool: A bool representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (bool) : A bool representing the display_field + """ + + if display_field is not None and not isinstance(display_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: bool', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def get_separator(self): + """ + The method to get the separator + + Returns: + bool: A bool representing the separator + """ + + return self.__separator + + def set_separator(self, separator): + """ + The method to set the value to separator + + Parameters: + separator (bool) : A bool representing the separator + """ + + if separator is not None and not isinstance(separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: separator EXPECTED TYPE: bool', None, None) + + self.__separator = separator + self.__key_modified['separator'] = 1 + + def get_searchable(self): + """ + The method to get the searchable + + Returns: + bool: A bool representing the searchable + """ + + return self.__searchable + + def set_searchable(self, searchable): + """ + The method to set the value to searchable + + Parameters: + searchable (bool) : A bool representing the searchable + """ + + if searchable is not None and not isinstance(searchable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: searchable EXPECTED TYPE: bool', None, None) + + self.__searchable = searchable + self.__key_modified['searchable'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_mass_update(self): + """ + The method to get the mass_update + + Returns: + bool: A bool representing the mass_update + """ + + return self.__mass_update + + def set_mass_update(self, mass_update): + """ + The method to set the value to mass_update + + Parameters: + mass_update (bool) : A bool representing the mass_update + """ + + if mass_update is not None and not isinstance(mass_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: bool', None, None) + + self.__mass_update = mass_update + self.__key_modified['mass_update'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_colour_code_enabled_by_system(self): + """ + The method to get the colour_code_enabled_by_system + + Returns: + bool: A bool representing the colour_code_enabled_by_system + """ + + return self.__colour_code_enabled_by_system + + def set_colour_code_enabled_by_system(self, colour_code_enabled_by_system): + """ + The method to set the value to colour_code_enabled_by_system + + Parameters: + colour_code_enabled_by_system (bool) : A bool representing the colour_code_enabled_by_system + """ + + if colour_code_enabled_by_system is not None and not isinstance(colour_code_enabled_by_system, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code_enabled_by_system EXPECTED TYPE: bool', None, None) + + self.__colour_code_enabled_by_system = colour_code_enabled_by_system + self.__key_modified['colour_code_enabled_by_system'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + int: An int representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (int) : An int representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: int', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + string: A string representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (string) : A string representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: str', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_email_parser(self): + """ + The method to get the email_parser + + Returns: + EmailParser: An instance of EmailParser + """ + + return self.__email_parser + + def set_email_parser(self, email_parser): + """ + The method to set the value to email_parser + + Parameters: + email_parser (EmailParser) : An instance of EmailParser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.email_parser import EmailParser + except Exception: + from .email_parser import EmailParser + + if email_parser is not None and not isinstance(email_parser, EmailParser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser EXPECTED TYPE: EmailParser', None, None) + + self.__email_parser = email_parser + self.__key_modified['email_parser'] = 1 + + def get_rollup_summary(self): + """ + The method to get the rollup_summary + + Returns: + RollupSummary: An instance of RollupSummary + """ + + return self.__rollup_summary + + def set_rollup_summary(self, rollup_summary): + """ + The method to set the value to rollup_summary + + Parameters: + rollup_summary (RollupSummary) : An instance of RollupSummary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.rollup_summary import RollupSummary + except Exception: + from .rollup_summary import RollupSummary + + if rollup_summary is not None and not isinstance(rollup_summary, RollupSummary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_summary EXPECTED TYPE: RollupSummary', None, None) + + self.__rollup_summary = rollup_summary + self.__key_modified['rollup_summary'] = 1 + + def get_refer_from_field(self): + """ + The method to get the refer_from_field + + Returns: + ReferFromField: An instance of ReferFromField + """ + + return self.__refer_from_field + + def set_refer_from_field(self, refer_from_field): + """ + The method to set the value to refer_from_field + + Parameters: + refer_from_field (ReferFromField) : An instance of ReferFromField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.refer_from_field import ReferFromField + except Exception: + from .refer_from_field import ReferFromField + + if refer_from_field is not None and not isinstance(refer_from_field, ReferFromField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: refer_from_field EXPECTED TYPE: ReferFromField', None, None) + + self.__refer_from_field = refer_from_field + self.__key_modified['refer_from_field'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_show_type(self): + """ + The method to get the show_type + + Returns: + int: An int representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (int) : An int representing the show_type + """ + + if show_type is not None and not isinstance(show_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: int', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.multi_module_lookup import MultiModuleLookup + except Exception: + from .multi_module_lookup import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_sharing_properties(self): + """ + The method to get the sharing_properties + + Returns: + SharingProperties: An instance of SharingProperties + """ + + return self.__sharing_properties + + def set_sharing_properties(self, sharing_properties): + """ + The method to set the value to sharing_properties + + Parameters: + sharing_properties (SharingProperties) : An instance of SharingProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import SharingProperties + except Exception: + from ..modules import SharingProperties + + if sharing_properties is not None and not isinstance(sharing_properties, SharingProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_properties EXPECTED TYPE: SharingProperties', None, None) + + self.__sharing_properties = sharing_properties + self.__key_modified['sharing_properties'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.currency import Currency + except Exception: + from .currency import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_file_upolad_optionlist(self): + """ + The method to get the file_upolad_optionlist + + Returns: + list: An instance of list + """ + + return self.__file_upolad_optionlist + + def set_file_upolad_optionlist(self, file_upolad_optionlist): + """ + The method to set the value to file_upolad_optionlist + + Parameters: + file_upolad_optionlist (list) : An instance of list + """ + + if file_upolad_optionlist is not None and not isinstance(file_upolad_optionlist, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_upolad_optionlist EXPECTED TYPE: list', None, None) + + self.__file_upolad_optionlist = file_upolad_optionlist + self.__key_modified['file_upolad_optionlist'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Lookup: An instance of Lookup + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Lookup) : An instance of Lookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.lookup import Lookup + except Exception: + from .lookup import Lookup + + if lookup is not None and not isinstance(lookup, Lookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Lookup', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.view_type import ViewType + except Exception: + from .view_type import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.unique import Unique + except Exception: + from .unique import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if sub_module is not None and not isinstance(sub_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def get_subform(self): + """ + The method to get the subform + + Returns: + Subform: An instance of Subform + """ + + return self.__subform + + def set_subform(self, subform): + """ + The method to set the value to subform + + Parameters: + subform (Subform) : An instance of Subform + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.subform import Subform + except Exception: + from .subform import Subform + + if subform is not None and not isinstance(subform, Subform): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Subform', None, None) + + self.__subform = subform + self.__key_modified['subform'] = 1 + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.external import External + except Exception: + from .external import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.formula import Formula + except Exception: + from .formula import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.private import Private + except Exception: + from .private import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.convert_mapping import ConvertMapping + except Exception: + from .convert_mapping import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.multiselectlookup import Multiselectlookup + except Exception: + from .multiselectlookup import Multiselectlookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_multiuserlookup(self): + """ + The method to get the multiuserlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiuserlookup + + def set_multiuserlookup(self, multiuserlookup): + """ + The method to set the value to multiuserlookup + + Parameters: + multiuserlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.multiselectlookup import Multiselectlookup + except Exception: + from .multiselectlookup import Multiselectlookup + + if multiuserlookup is not None and not isinstance(multiuserlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiuserlookup = multiuserlookup + self.__key_modified['multiuserlookup'] = 1 + + def get_autonumber(self): + """ + The method to get the autonumber + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__autonumber + + def set_autonumber(self, autonumber): + """ + The method to set the value to autonumber + + Parameters: + autonumber (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.auto_number import AutoNumber + except Exception: + from .auto_number import AutoNumber + + if autonumber is not None and not isinstance(autonumber, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: autonumber EXPECTED TYPE: AutoNumber', None, None) + + self.__autonumber = autonumber + self.__key_modified['autonumber'] = 1 + + def get_auto_number_61(self): + """ + The method to get the auto_number_61 + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number_61 + + def set_auto_number_61(self, auto_number_61): + """ + The method to set the value to auto_number_61 + + Parameters: + auto_number_61 (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.auto_number import AutoNumber + except Exception: + from .auto_number import AutoNumber + + if auto_number_61 is not None and not isinstance(auto_number_61, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number_61 EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number_61 = auto_number_61 + self.__key_modified['auto_number'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.crypt import Crypt + except Exception: + from .crypt import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.tooltip import Tooltip + except Exception: + from .tooltip import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + HistoryTracking: An instance of HistoryTracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (HistoryTracking) : An instance of HistoryTracking + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.history_tracking import HistoryTracking + except Exception: + from .history_tracking import HistoryTracking + + if history_tracking is not None and not isinstance(history_tracking, HistoryTracking): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.association_details import AssociationDetails + except Exception: + from .association_details import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_allowed_modules(self): + """ + The method to get the allowed_modules + + Returns: + list: An instance of list + """ + + return self.__allowed_modules + + def set_allowed_modules(self, allowed_modules): + """ + The method to set the value to allowed_modules + + Parameters: + allowed_modules (list) : An instance of list + """ + + if allowed_modules is not None and not isinstance(allowed_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_modules EXPECTED TYPE: list', None, None) + + self.__allowed_modules = allowed_modules + self.__key_modified['allowed_modules'] = 1 + + def get_additional_column(self): + """ + The method to get the additional_column + + Returns: + string: A string representing the additional_column + """ + + return self.__additional_column + + def set_additional_column(self, additional_column): + """ + The method to set the value to additional_column + + Parameters: + additional_column (string) : A string representing the additional_column + """ + + if additional_column is not None and not isinstance(additional_column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: additional_column EXPECTED TYPE: str', None, None) + + self.__additional_column = additional_column + self.__key_modified['additional_column'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_global_picklist(self): + """ + The method to get the global_picklist + + Returns: + Object: A Object representing the global_picklist + """ + + return self.__global_picklist + + def set_global_picklist(self, global_picklist): + """ + The method to set the value to global_picklist + + Parameters: + global_picklist (Object) : A Object representing the global_picklist + """ + + self.__global_picklist = global_picklist + self.__key_modified['global_picklist'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.hipaa_compliance import HipaaCompliance + except Exception: + from .hipaa_compliance import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def get_updateexistingrecords(self): + """ + The method to get the updateexistingrecords + + Returns: + bool: A bool representing the updateexistingrecords + """ + + return self.__updateexistingrecords + + def set_updateexistingrecords(self, updateexistingrecords): + """ + The method to set the value to updateexistingrecords + + Parameters: + updateexistingrecords (bool) : A bool representing the updateexistingrecords + """ + + if updateexistingrecords is not None and not isinstance(updateexistingrecords, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updateexistingrecords EXPECTED TYPE: bool', None, None) + + self.__updateexistingrecords = updateexistingrecords + self.__key_modified['_update_existing_records'] = 1 + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + bool: A bool representing the number_separator + """ + + return self.__number_separator + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (bool) : A bool representing the number_separator + """ + + if number_separator is not None and not isinstance(number_separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: bool', None, None) + + self.__number_separator = number_separator + self.__key_modified['number_separator'] = 1 + + def get_textarea(self): + """ + The method to get the textarea + + Returns: + Textarea: An instance of Textarea + """ + + return self.__textarea + + def set_textarea(self, textarea): + """ + The method to set the value to textarea + + Parameters: + textarea (Textarea) : An instance of Textarea + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.textarea import Textarea + except Exception: + from .textarea import Textarea + + if textarea is not None and not isinstance(textarea, Textarea): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: textarea EXPECTED TYPE: Textarea', None, None) + + self.__textarea = textarea + self.__key_modified['textarea'] = 1 + + def get_static_field(self): + """ + The method to get the static_field + + Returns: + bool: A bool representing the static_field + """ + + return self.__static_field + + def set_static_field(self, static_field): + """ + The method to set the value to static_field + + Parameters: + static_field (bool) : A bool representing the static_field + """ + + if static_field is not None and not isinstance(static_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_field EXPECTED TYPE: bool', None, None) + + self.__static_field = static_field + self.__key_modified['static_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/fields_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/fields_operations.py new file mode 100644 index 0000000..81105df --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/fields_operations.py @@ -0,0 +1,314 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class FieldsOperations(object): + def __init__(self): + """Creates an instance of FieldsOperations""" + pass + + def get_fields(self, param_instance=None): + """ + The method to get fields + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/fields' + 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.set_param(param_instance) + try: + from zohocrmsdk.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 create_field(self, request, param_instance=None): + """ + The method to create field + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/fields' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_fields(self, request, param_instance=None): + """ + The method to update fields + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/fields' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_field(self, field, param_instance=None): + """ + The method to get field + + Parameters: + field (int) : An int representing the field + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(field, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: int', None, None) + + 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/v7/settings/fields/' + api_path = api_path + str(field) + 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.set_param(param_instance) + try: + from zohocrmsdk.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 update_field(self, field, request, param_instance=None): + """ + The method to update field + + Parameters: + field (int) : An int representing the field + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(field, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field 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) + + 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/v7/settings/fields/' + api_path = api_path + str(field) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_field(self, field, param_instance=None): + """ + The method to delete field + + Parameters: + field (int) : An int representing the field + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(field, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: int', None, None) + + 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/v7/settings/fields/' + api_path = api_path + str(field) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetFieldsParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.GetFieldsParam') + data_type = Param('data_type', 'com.zoho.crm.api.Fields.GetFieldsParam') + type = Param('type', 'com.zoho.crm.api.Fields.GetFieldsParam') + include = Param('include', 'com.zoho.crm.api.Fields.GetFieldsParam') + feature_name = Param('feature_name', 'com.zoho.crm.api.Fields.GetFieldsParam') + component = Param('component', 'com.zoho.crm.api.Fields.GetFieldsParam') + layout_id = Param('layout_id', 'com.zoho.crm.api.Fields.GetFieldsParam') + + +class GetFieldsHeader(object): + pass + + +class CreateFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.CreateFieldParam') + + +class UpdateFieldsParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.UpdateFieldsParam') + + +class GetFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.GetFieldParam') + include = Param('include', 'com.zoho.crm.api.Fields.GetFieldParam') + + +class GetFieldHeader(object): + pass + + +class UpdateFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.UpdateFieldParam') + + +class DeleteFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.DeleteFieldParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/file_upolad_option.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/file_upolad_option.py new file mode 100644 index 0000000..a8fa70a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/file_upolad_option.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FileUpoladOption(object): + def __init__(self): + """Creates an instance of FileUpoladOption""" + + self.__actual_value = None + self.__display_value = None + self.__key_modified = dict() + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/forecast_category.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/forecast_category.py new file mode 100644 index 0000000..502f910 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/forecast_category.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ForecastCategory(object): + def __init__(self): + """Creates an instance of ForecastCategory""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/formula.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/formula.py new file mode 100644 index 0000000..e31c6e4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/formula.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Formula(object): + def __init__(self): + """Creates an instance of Formula""" + + self.__return_type = None + self.__expression = None + self.__key_modified = dict() + + def get_return_type(self): + """ + The method to get the return_type + + Returns: + string: A string representing the return_type + """ + + return self.__return_type + + def set_return_type(self, return_type): + """ + The method to set the value to return_type + + Parameters: + return_type (string) : A string representing the return_type + """ + + if return_type is not None and not isinstance(return_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: str', None, None) + + self.__return_type = return_type + self.__key_modified['return_type'] = 1 + + def get_expression(self): + """ + The method to get the expression + + Returns: + string: A string representing the expression + """ + + return self.__expression + + def set_expression(self, expression): + """ + The method to set the value to expression + + Parameters: + expression (string) : A string representing the expression + """ + + if expression is not None and not isinstance(expression, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: str', None, None) + + self.__expression = expression + self.__key_modified['expression'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/function_parameter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/function_parameter.py new file mode 100644 index 0000000..6f22c9f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/function_parameter.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FunctionParameter(object): + def __init__(self): + """Creates an instance of FunctionParameter""" + + self.__api_name = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/hipaa_compliance.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/hipaa_compliance.py new file mode 100644 index 0000000..0c338e9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/hipaa_compliance.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HipaaCompliance(object): + def __init__(self): + """Creates an instance of HipaaCompliance""" + + self.__restricted_in_export = None + self.__restricted = None + self.__key_modified = dict() + + def get_restricted_in_export(self): + """ + The method to get the restricted_in_export + + Returns: + bool: A bool representing the restricted_in_export + """ + + return self.__restricted_in_export + + def set_restricted_in_export(self, restricted_in_export): + """ + The method to set the value to restricted_in_export + + Parameters: + restricted_in_export (bool) : A bool representing the restricted_in_export + """ + + if restricted_in_export is not None and not isinstance(restricted_in_export, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_in_export EXPECTED TYPE: bool', None, None) + + self.__restricted_in_export = restricted_in_export + self.__key_modified['restricted_in_export'] = 1 + + def get_restricted(self): + """ + The method to get the restricted + + Returns: + bool: A bool representing the restricted + """ + + return self.__restricted + + def set_restricted(self, restricted): + """ + The method to set the value to restricted + + Parameters: + restricted (bool) : A bool representing the restricted + """ + + if restricted is not None and not isinstance(restricted, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted EXPECTED TYPE: bool', None, None) + + self.__restricted = restricted + self.__key_modified['restricted'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking.py new file mode 100644 index 0000000..61eec83 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HistoryTracking(object): + def __init__(self): + """Creates an instance of HistoryTracking""" + + self.__module = None + self.__duration_configured_field = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + HistoryTrackingModule: An instance of HistoryTrackingModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (HistoryTrackingModule) : An instance of HistoryTrackingModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.history_tracking_module import HistoryTrackingModule + except Exception: + from .history_tracking_module import HistoryTrackingModule + + if module is not None and not isinstance(module, HistoryTrackingModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: HistoryTrackingModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_duration_configured_field(self): + """ + The method to get the duration_configured_field + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__duration_configured_field + + def set_duration_configured_field(self, duration_configured_field): + """ + The method to set the value to duration_configured_field + + Parameters: + duration_configured_field (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if duration_configured_field is not None and not isinstance(duration_configured_field, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duration_configured_field EXPECTED TYPE: MinifiedModule', None, None) + + self.__duration_configured_field = duration_configured_field + self.__key_modified['duration_configured_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking_module.py new file mode 100644 index 0000000..3fc5140 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking_module.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HistoryTrackingModule(object): + def __init__(self): + """Creates an instance of HistoryTrackingModule""" + + self.__layout = None + self.__display_label = None + self.__api_name = None + self.__module = None + self.__id = None + self.__module_name = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layouts: An instance of Layouts + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layouts) : An instance of Layouts + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts import Layouts + except Exception: + from ..layouts import Layouts + + if layout is not None and not isinstance(layout, Layouts): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layouts', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + HistoryTrackingModule: An instance of HistoryTrackingModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (HistoryTrackingModule) : An instance of HistoryTrackingModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.history_tracking_module import HistoryTrackingModule + except Exception: + from .history_tracking_module import HistoryTrackingModule + + if module is not None and not isinstance(module, HistoryTrackingModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: HistoryTrackingModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/layout_association.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/layout_association.py new file mode 100644 index 0000000..615c716 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/layout_association.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LayoutAssociation(object): + def __init__(self): + """Creates an instance of LayoutAssociation""" + + self.__api_name = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/lookup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/lookup.py new file mode 100644 index 0000000..40a08d9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/lookup.py @@ -0,0 +1,234 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Lookup(object): + def __init__(self): + """Creates an instance of Lookup""" + + self.__display_label = None + self.__api_name = None + self.__query_details = None + self.__module = None + self.__id = None + self.__revalidate_filter_during_edit = None + self.__show_fields = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_query_details(self): + """ + The method to get the query_details + + Returns: + QueryDetails: An instance of QueryDetails + """ + + return self.__query_details + + def set_query_details(self, query_details): + """ + The method to set the value to query_details + + Parameters: + query_details (QueryDetails) : An instance of QueryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.query_details import QueryDetails + except Exception: + from .query_details import QueryDetails + + if query_details is not None and not isinstance(query_details, QueryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_details EXPECTED TYPE: QueryDetails', None, None) + + self.__query_details = query_details + self.__key_modified['query_details'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_revalidate_filter_during_edit(self): + """ + The method to get the revalidate_filter_during_edit + + Returns: + bool: A bool representing the revalidate_filter_during_edit + """ + + return self.__revalidate_filter_during_edit + + def set_revalidate_filter_during_edit(self, revalidate_filter_during_edit): + """ + The method to set the value to revalidate_filter_during_edit + + Parameters: + revalidate_filter_during_edit (bool) : A bool representing the revalidate_filter_during_edit + """ + + if revalidate_filter_during_edit is not None and not isinstance(revalidate_filter_during_edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: revalidate_filter_during_edit EXPECTED TYPE: bool', None, None) + + self.__revalidate_filter_during_edit = revalidate_filter_during_edit + self.__key_modified['revalidate_filter_during_edit'] = 1 + + def get_show_fields(self): + """ + The method to get the show_fields + + Returns: + list: An instance of list + """ + + return self.__show_fields + + def set_show_fields(self, show_fields): + """ + The method to set the value to show_fields + + Parameters: + show_fields (list) : An instance of list + """ + + if show_fields is not None and not isinstance(show_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_fields EXPECTED TYPE: list', None, None) + + self.__show_fields = show_fields + self.__key_modified['show_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/mandatory_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/mandatory_details.py new file mode 100644 index 0000000..6ee3c77 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/mandatory_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MandatoryDetails(object): + def __init__(self): + """Creates an instance of MandatoryDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/maps.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/maps.py new file mode 100644 index 0000000..da59ce0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/maps.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Maps(object): + def __init__(self): + """Creates an instance of Maps""" + + self.__api_name = None + self.__pick_list_values = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/minified_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/minified_field.py new file mode 100644 index 0000000..472ee6d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/minified_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedField(object): + def __init__(self): + """Creates an instance of MinifiedField""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/multi_module_lookup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/multi_module_lookup.py new file mode 100644 index 0000000..106f35c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/multi_module_lookup.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiModuleLookup(object): + def __init__(self): + """Creates an instance of MultiModuleLookup""" + + self.__display_label = None + self.__api_name = None + self.__modules = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/multiselectlookup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/multiselectlookup.py new file mode 100644 index 0000000..18e2dc6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/multiselectlookup.py @@ -0,0 +1,284 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Multiselectlookup(object): + def __init__(self): + """Creates an instance of Multiselectlookup""" + + self.__display_label = None + self.__linking_module = None + self.__connected_module = None + self.__lookup_apiname = None + self.__api_name = None + self.__connectedfield_apiname = None + self.__connectedlookup_apiname = None + self.__id = None + self.__record_access = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_linking_module(self): + """ + The method to get the linking_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__linking_module + + def set_linking_module(self, linking_module): + """ + The method to set the value to linking_module + + Parameters: + linking_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if linking_module is not None and not isinstance(linking_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linking_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__linking_module = linking_module + self.__key_modified['linking_module'] = 1 + + def get_connected_module(self): + """ + The method to get the connected_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__connected_module + + def set_connected_module(self, connected_module): + """ + The method to set the value to connected_module + + Parameters: + connected_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if connected_module is not None and not isinstance(connected_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: connected_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__connected_module = connected_module + self.__key_modified['connected_module'] = 1 + + def get_lookup_apiname(self): + """ + The method to get the lookup_apiname + + Returns: + string: A string representing the lookup_apiname + """ + + return self.__lookup_apiname + + def set_lookup_apiname(self, lookup_apiname): + """ + The method to set the value to lookup_apiname + + Parameters: + lookup_apiname (string) : A string representing the lookup_apiname + """ + + if lookup_apiname is not None and not isinstance(lookup_apiname, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_apiname EXPECTED TYPE: str', None, None) + + self.__lookup_apiname = lookup_apiname + self.__key_modified['lookup_apiname'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_connectedfield_apiname(self): + """ + The method to get the connectedfield_apiname + + Returns: + string: A string representing the connectedfield_apiname + """ + + return self.__connectedfield_apiname + + def set_connectedfield_apiname(self, connectedfield_apiname): + """ + The method to set the value to connectedfield_apiname + + Parameters: + connectedfield_apiname (string) : A string representing the connectedfield_apiname + """ + + if connectedfield_apiname is not None and not isinstance(connectedfield_apiname, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: connectedfield_apiname EXPECTED TYPE: str', None, None) + + self.__connectedfield_apiname = connectedfield_apiname + self.__key_modified['connectedfield_apiname'] = 1 + + def get_connectedlookup_apiname(self): + """ + The method to get the connectedlookup_apiname + + Returns: + string: A string representing the connectedlookup_apiname + """ + + return self.__connectedlookup_apiname + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_record_access(self): + """ + The method to get the record_access + + Returns: + bool: A bool representing the record_access + """ + + return self.__record_access + + def set_record_access(self, record_access): + """ + The method to set the value to record_access + + Parameters: + record_access (bool) : A bool representing the record_access + """ + + if record_access is not None and not isinstance(record_access, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_access EXPECTED TYPE: bool', None, None) + + self.__record_access = record_access + self.__key_modified['record_access'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/operation_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/operation_type.py new file mode 100644 index 0000000..1ff5ab7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/operation_type.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OperationType(object): + def __init__(self): + """Creates an instance of OperationType""" + + self.__web_update = None + self.__api_create = None + self.__web_create = None + self.__api_update = None + self.__key_modified = dict() + + def get_web_update(self): + """ + The method to get the web_update + + Returns: + bool: A bool representing the web_update + """ + + return self.__web_update + + def set_web_update(self, web_update): + """ + The method to set the value to web_update + + Parameters: + web_update (bool) : A bool representing the web_update + """ + + if web_update is not None and not isinstance(web_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: web_update EXPECTED TYPE: bool', None, None) + + self.__web_update = web_update + self.__key_modified['web_update'] = 1 + + def get_api_create(self): + """ + The method to get the api_create + + Returns: + bool: A bool representing the api_create + """ + + return self.__api_create + + def set_api_create(self, api_create): + """ + The method to set the value to api_create + + Parameters: + api_create (bool) : A bool representing the api_create + """ + + if api_create is not None and not isinstance(api_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_create EXPECTED TYPE: bool', None, None) + + self.__api_create = api_create + self.__key_modified['api_create'] = 1 + + def get_web_create(self): + """ + The method to get the web_create + + Returns: + bool: A bool representing the web_create + """ + + return self.__web_create + + def set_web_create(self, web_create): + """ + The method to set the value to web_create + + Parameters: + web_create (bool) : A bool representing the web_create + """ + + if web_create is not None and not isinstance(web_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: web_create EXPECTED TYPE: bool', None, None) + + self.__web_create = web_create + self.__key_modified['web_create'] = 1 + + def get_api_update(self): + """ + The method to get the api_update + + Returns: + bool: A bool representing the api_update + """ + + return self.__api_update + + def set_api_update(self, api_update): + """ + The method to set the value to api_update + + Parameters: + api_update (bool) : A bool representing the api_update + """ + + if api_update is not None and not isinstance(api_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_update EXPECTED TYPE: bool', None, None) + + self.__api_update = api_update + self.__key_modified['api_update'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/pick_list_value.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/pick_list_value.py new file mode 100644 index 0000000..f26d32e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/pick_list_value.py @@ -0,0 +1,354 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class PickListValue(object): + def __init__(self): + """Creates an instance of PickListValue""" + + self.__colour_code = None + self.__actual_value = None + self.__type = None + self.__id = None + self.__sequence_number = None + self.__display_value = None + self.__probability = None + self.__forecast_category = None + self.__expected_data_type = None + self.__sys_ref_name = None + self.__forecast_type = None + self.__maps = None + self.__key_modified = dict() + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_probability(self): + """ + The method to get the probability + + Returns: + int: An int representing the probability + """ + + return self.__probability + + def set_probability(self, probability): + """ + The method to set the value to probability + + Parameters: + probability (int) : An int representing the probability + """ + + if probability is not None and not isinstance(probability, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: probability EXPECTED TYPE: int', None, None) + + self.__probability = probability + self.__key_modified['probability'] = 1 + + def get_forecast_category(self): + """ + The method to get the forecast_category + + Returns: + ForecastCategory: An instance of ForecastCategory + """ + + return self.__forecast_category + + def set_forecast_category(self, forecast_category): + """ + The method to set the value to forecast_category + + Parameters: + forecast_category (ForecastCategory) : An instance of ForecastCategory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.forecast_category import ForecastCategory + except Exception: + from .forecast_category import ForecastCategory + + if forecast_category is not None and not isinstance(forecast_category, ForecastCategory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_category EXPECTED TYPE: ForecastCategory', None, None) + + self.__forecast_category = forecast_category + self.__key_modified['forecast_category'] = 1 + + def get_expected_data_type(self): + """ + The method to get the expected_data_type + + Returns: + string: A string representing the expected_data_type + """ + + return self.__expected_data_type + + def set_expected_data_type(self, expected_data_type): + """ + The method to set the value to expected_data_type + + Parameters: + expected_data_type (string) : A string representing the expected_data_type + """ + + if expected_data_type is not None and not isinstance(expected_data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expected_data_type EXPECTED TYPE: str', None, None) + + self.__expected_data_type = expected_data_type + self.__key_modified['expected_data_type'] = 1 + + def get_sys_ref_name(self): + """ + The method to get the sys_ref_name + + Returns: + string: A string representing the sys_ref_name + """ + + return self.__sys_ref_name + + def set_sys_ref_name(self, sys_ref_name): + """ + The method to set the value to sys_ref_name + + Parameters: + sys_ref_name (string) : A string representing the sys_ref_name + """ + + if sys_ref_name is not None and not isinstance(sys_ref_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sys_ref_name EXPECTED TYPE: str', None, None) + + self.__sys_ref_name = sys_ref_name + self.__key_modified['sys_ref_name'] = 1 + + def get_forecast_type(self): + """ + The method to get the forecast_type + + Returns: + string: A string representing the forecast_type + """ + + return self.__forecast_type + + def set_forecast_type(self, forecast_type): + """ + The method to set the value to forecast_type + + Parameters: + forecast_type (string) : A string representing the forecast_type + """ + + if forecast_type is not None and not isinstance(forecast_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_type EXPECTED TYPE: str', None, None) + + self.__forecast_type = forecast_type + self.__key_modified['forecast_type'] = 1 + + def get_maps(self): + """ + The method to get the maps + + Returns: + list: An instance of list + """ + + return self.__maps + + def set_maps(self, maps): + """ + The method to set the value to maps + + Parameters: + maps (list) : An instance of list + """ + + if maps is not None and not isinstance(maps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: list', None, None) + + self.__maps = maps + self.__key_modified['maps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/private.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/private.py new file mode 100644 index 0000000..ad849e1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/private.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Private(object): + def __init__(self): + """Creates an instance of Private""" + + self.__restricted = None + self.__type = None + self.__export = None + self.__key_modified = dict() + + def get_restricted(self): + """ + The method to get the restricted + + Returns: + bool: A bool representing the restricted + """ + + return self.__restricted + + def set_restricted(self, restricted): + """ + The method to set the value to restricted + + Parameters: + restricted (bool) : A bool representing the restricted + """ + + if restricted is not None and not isinstance(restricted, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted EXPECTED TYPE: bool', None, None) + + self.__restricted = restricted + self.__key_modified['restricted'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_export(self): + """ + The method to get the export + + Returns: + bool: A bool representing the export + """ + + return self.__export + + def set_export(self, export): + """ + The method to set the value to export + + Parameters: + export (bool) : A bool representing the export + """ + + if export is not None and not isinstance(export, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: export EXPECTED TYPE: bool', None, None) + + self.__export = export + self.__key_modified['export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/profile.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/profile.py new file mode 100644 index 0000000..239ea71 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/profile.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__name = None + self.__id = None + self.__permission_type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + string: A string representing the permission_type + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (string) : A string representing the permission_type + """ + + if permission_type is not None and not isinstance(permission_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: str', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/query_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/query_details.py new file mode 100644 index 0000000..6d09f04 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/query_details.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class QueryDetails(object): + def __init__(self): + """Creates an instance of QueryDetails""" + + self.__query_id = None + self.__criteria = None + self.__key_modified = dict() + + def get_query_id(self): + """ + The method to get the query_id + + Returns: + int: An int representing the query_id + """ + + return self.__query_id + + def set_query_id(self, query_id): + """ + The method to set the value to query_id + + Parameters: + query_id (int) : An int representing the query_id + """ + + if query_id is not None and not isinstance(query_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_id EXPECTED TYPE: int', None, None) + + self.__query_id = query_id + self.__key_modified['query_id'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/refer_from_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/refer_from_field.py new file mode 100644 index 0000000..20ebb50 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/refer_from_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReferFromField(object): + def __init__(self): + """Creates an instance of ReferFromField""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/response_wrapper.py new file mode 100644 index 0000000..fa47a01 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_criteria.py new file mode 100644 index 0000000..1e07caa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_criteria.py @@ -0,0 +1,126 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RollupCriteria(object): + def __init__(self): + """Creates an instance of RollupCriteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_summary.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_summary.py new file mode 100644 index 0000000..559d5bc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_summary.py @@ -0,0 +1,189 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RollupSummary(object): + def __init__(self): + """Creates an instance of RollupSummary""" + + self.__return_type = None + self.__expression = None + self.__based_on_module = None + self.__related_list = None + self.__rollup_based_on = None + self.__key_modified = dict() + + def get_return_type(self): + """ + The method to get the return_type + + Returns: + string: A string representing the return_type + """ + + return self.__return_type + + def set_return_type(self, return_type): + """ + The method to set the value to return_type + + Parameters: + return_type (string) : A string representing the return_type + """ + + if return_type is not None and not isinstance(return_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: str', None, None) + + self.__return_type = return_type + self.__key_modified['return_type'] = 1 + + def get_expression(self): + """ + The method to get the expression + + Returns: + Expression: An instance of Expression + """ + + return self.__expression + + def set_expression(self, expression): + """ + The method to set the value to expression + + Parameters: + expression (Expression) : An instance of Expression + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.expression import Expression + except Exception: + from .expression import Expression + + if expression is not None and not isinstance(expression, Expression): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: Expression', None, None) + + self.__expression = expression + self.__key_modified['expression'] = 1 + + def get_based_on_module(self): + """ + The method to get the based_on_module + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__based_on_module + + def set_based_on_module(self, based_on_module): + """ + The method to set the value to based_on_module + + Parameters: + based_on_module (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if based_on_module is not None and not isinstance(based_on_module, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: based_on_module EXPECTED TYPE: MinifiedField', None, None) + + self.__based_on_module = based_on_module + self.__key_modified['based_on_module'] = 1 + + def get_related_list(self): + """ + The method to get the related_list + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__related_list + + def set_related_list(self, related_list): + """ + The method to set the value to related_list + + Parameters: + related_list (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if related_list is not None and not isinstance(related_list, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_list EXPECTED TYPE: MinifiedField', None, None) + + self.__related_list = related_list + self.__key_modified['related_list'] = 1 + + def get_rollup_based_on(self): + """ + The method to get the rollup_based_on + + Returns: + string: A string representing the rollup_based_on + """ + + return self.__rollup_based_on + + def set_rollup_based_on(self, rollup_based_on): + """ + The method to set the value to rollup_based_on + + Parameters: + rollup_based_on (string) : A string representing the rollup_based_on + """ + + if rollup_based_on is not None and not isinstance(rollup_based_on, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_based_on EXPECTED TYPE: str', None, None) + + self.__rollup_based_on = rollup_based_on + self.__key_modified['rollup_based_on'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/sharing_properties.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/sharing_properties.py new file mode 100644 index 0000000..aeb4540 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/sharing_properties.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SharingProperties(object): + def __init__(self): + """Creates an instance of SharingProperties""" + + self.__scheduler_status = None + self.__share_preference_enabled = None + self.__share_permission = None + self.__key_modified = dict() + + def get_scheduler_status(self): + """ + The method to get the scheduler_status + + Returns: + string: A string representing the scheduler_status + """ + + return self.__scheduler_status + + def set_scheduler_status(self, scheduler_status): + """ + The method to set the value to scheduler_status + + Parameters: + scheduler_status (string) : A string representing the scheduler_status + """ + + if scheduler_status is not None and not isinstance(scheduler_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduler_status EXPECTED TYPE: str', None, None) + + self.__scheduler_status = scheduler_status + self.__key_modified['scheduler_status'] = 1 + + def get_share_preference_enabled(self): + """ + The method to get the share_preference_enabled + + Returns: + bool: A bool representing the share_preference_enabled + """ + + return self.__share_preference_enabled + + def set_share_preference_enabled(self, share_preference_enabled): + """ + The method to set the value to share_preference_enabled + + Parameters: + share_preference_enabled (bool) : A bool representing the share_preference_enabled + """ + + if share_preference_enabled is not None and not isinstance(share_preference_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_preference_enabled EXPECTED TYPE: bool', None, None) + + self.__share_preference_enabled = share_preference_enabled + self.__key_modified['share_preference_enabled'] = 1 + + def get_share_permission(self): + """ + The method to get the share_permission + + Returns: + Choice: An instance of Choice + """ + + return self.__share_permission + + def set_share_permission(self, share_permission): + """ + The method to set the value to share_permission + + Parameters: + share_permission (Choice) : An instance of Choice + """ + + if share_permission is not None and not isinstance(share_permission, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_permission EXPECTED TYPE: Choice', None, None) + + self.__share_permission = share_permission + self.__key_modified['share_permission'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/show_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/show_fields.py new file mode 100644 index 0000000..deee745 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/show_fields.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShowFields(object): + def __init__(self): + """Creates an instance of ShowFields""" + + self.__show_data = None + self.__field = None + self.__key_modified = dict() + + def get_show_data(self): + """ + The method to get the show_data + + Returns: + bool: A bool representing the show_data + """ + + return self.__show_data + + def set_show_data(self, show_data): + """ + The method to set the value to show_data + + Parameters: + show_data (bool) : A bool representing the show_data + """ + + if show_data is not None and not isinstance(show_data, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_data EXPECTED TYPE: bool', None, None) + + self.__show_data = show_data + self.__key_modified['show_data'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/subform.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/subform.py new file mode 100644 index 0000000..8dce54d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/subform.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Subform(object): + def __init__(self): + """Creates an instance of Subform""" + + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/success_response.py new file mode 100644 index 0000000..d27a86b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/textarea.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/textarea.py new file mode 100644 index 0000000..f85bf55 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/textarea.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Textarea(object): + def __init__(self): + """Creates an instance of Textarea""" + + self.__type = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/tooltip.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/tooltip.py new file mode 100644 index 0000000..5637a62 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/tooltip.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tooltip(object): + def __init__(self): + """Creates an instance of Tooltip""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/unique.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/unique.py new file mode 100644 index 0000000..a3d499d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/unique.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Unique(object): + def __init__(self): + """Creates an instance of Unique""" + + self.__casesensitive = None + self.__key_modified = dict() + + def get_casesensitive(self): + """ + The method to get the casesensitive + + Returns: + string: A string representing the casesensitive + """ + + return self.__casesensitive + + def set_casesensitive(self, casesensitive): + """ + The method to set the value to casesensitive + + Parameters: + casesensitive (string) : A string representing the casesensitive + """ + + if casesensitive is not None and not isinstance(casesensitive, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: casesensitive EXPECTED TYPE: str', None, None) + + self.__casesensitive = casesensitive + self.__key_modified['casesensitive'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/view_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/view_type.py new file mode 100644 index 0000000..be78bd4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fields/view_type.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ViewType(object): + def __init__(self): + """Creates an instance of ViewType""" + + self.__view = None + self.__edit = None + self.__quick_create = None + self.__create = None + self.__key_modified = dict() + + def get_view(self): + """ + The method to get the view + + Returns: + bool: A bool representing the view + """ + + return self.__view + + def set_view(self, view): + """ + The method to set the value to view + + Parameters: + view (bool) : A bool representing the view + """ + + if view is not None and not isinstance(view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view EXPECTED TYPE: bool', None, None) + + self.__view = view + self.__key_modified['view'] = 1 + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_quick_create(self): + """ + The method to get the quick_create + + Returns: + bool: A bool representing the quick_create + """ + + return self.__quick_create + + def set_quick_create(self, quick_create): + """ + The method to set the value to quick_create + + Parameters: + quick_create (bool) : A bool representing the quick_create + """ + + if quick_create is not None and not isinstance(quick_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_create EXPECTED TYPE: bool', None, None) + + self.__quick_create = quick_create + self.__key_modified['quick_create'] = 1 + + def get_create(self): + """ + The method to get the create + + Returns: + bool: A bool representing the create + """ + + return self.__create + + def set_create(self, create): + """ + The method to set the value to create + + Parameters: + create (bool) : A bool representing the create + """ + + if create is not None and not isinstance(create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create EXPECTED TYPE: bool', None, None) + + self.__create = create + self.__key_modified['create'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/__init__.py new file mode 100644 index 0000000..5d0fe34 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/__init__.py @@ -0,0 +1,9 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .files_operations import FilesOperations, UploadFilesParam, UploadFilesHeader, GetFileParam diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_wrapper.py new file mode 100644 index 0000000..3f3af91 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.files.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/api_exception.py new file mode 100644 index 0000000..374cdf3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.files.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.files.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/body_wrapper.py new file mode 100644 index 0000000..5546eee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + list: An instance of list + """ + + return self.__file + + def set_file(self, file): + """ + The method to set the value to file + + Parameters: + file (list) : An instance of list + """ + + if file is not None and not isinstance(file, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: list', None, None) + + self.__file = file + self.__key_modified['file'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/file_body_wrapper.py new file mode 100644 index 0000000..cf98187 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.files.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/files_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/files_operations.py new file mode 100644 index 0000000..0f3c93f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/files_operations.py @@ -0,0 +1,108 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FilesOperations(object): + def __init__(self): + """Creates an instance of FilesOperations""" + pass + + def upload_files(self, request, param_instance=None): + """ + The method to upload files + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.files.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/files' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.files.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_file(self, param_instance=None): + """ + The method to get file + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/files' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.files.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/x-download') + + +class UploadFilesParam(object): + type = Param('type', 'com.zoho.crm.api.Files.UploadFilesParam') + + +class UploadFilesHeader(object): + pass + + +class GetFileParam(object): + id = Param('id', 'com.zoho.crm.api.Files.GetFileParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/success_response.py new file mode 100644 index 0000000..fcdc80a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/files/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.files.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/__init__.py new file mode 100644 index 0000000..fb7efa8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .body_wrapper import BodyWrapper +from .master_record_fields import MasterRecordFields +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .merge import Merge +from .image_data import ImageData +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .find_and_merge_operations import FindAndMergeOperations, GetRecordMergeParam +from .data_fields import DataFields +from .merge_data import MergeData diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_wrapper.py new file mode 100644 index 0000000..d8c3ec2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__merge = None + self.__key_modified = dict() + + def get_merge(self): + """ + The method to get the merge + + Returns: + list: An instance of list + """ + + return self.__merge + + def set_merge(self, merge): + """ + The method to set the value to merge + + Parameters: + merge (list) : An instance of list + """ + + if merge is not None and not isinstance(merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: merge EXPECTED TYPE: list', None, None) + + self.__merge = merge + self.__key_modified['merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/api_exception.py new file mode 100644 index 0000000..6af12de --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/body_wrapper.py new file mode 100644 index 0000000..3c0b528 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__merge = None + self.__key_modified = dict() + + def get_merge(self): + """ + The method to get the merge + + Returns: + list: An instance of list + """ + + return self.__merge + + def set_merge(self, merge): + """ + The method to set the value to merge + + Parameters: + merge (list) : An instance of list + """ + + if merge is not None and not isinstance(merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: merge EXPECTED TYPE: list', None, None) + + self.__merge = merge + self.__key_modified['merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/data_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/data_fields.py new file mode 100644 index 0000000..a206fe3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/data_fields.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataFields(object): + def __init__(self): + """Creates an instance of DataFields""" + + self.__api_name = None + self.__data = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['_data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/find_and_merge_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/find_and_merge_operations.py new file mode 100644 index 0000000..f069dd8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/find_and_merge_operations.py @@ -0,0 +1,113 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FindAndMergeOperations(object): + def __init__(self, module, masterrecordid): + """ + Creates an instance of FindAndMergeOperations with the given parameters + + Parameters: + module (string) : A string representing the module + masterrecordid (int) : An int representing the masterrecordid + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(masterrecordid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: masterrecordid EXPECTED TYPE: int', None, None) + + self.__module = module + self.__masterrecordid = masterrecordid + + + def get_record_merge(self, param_instance=None): + """ + The method to get record merge + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__masterrecordid) + api_path = api_path + '/actions/merge' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def merge_records(self, request): + """ + The method to merge records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__masterrecordid) + api_path = api_path + '/actions/merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetRecordMergeParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.FindAndMerge.GetRecordMergeParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/image_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/image_data.py new file mode 100644 index 0000000..5e1d646 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/image_data.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ImageData(object): + def __init__(self): + """Creates an instance of ImageData""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/master_record_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/master_record_fields.py new file mode 100644 index 0000000..02bd986 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/master_record_fields.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MasterRecordFields(object): + def __init__(self): + """Creates an instance of MasterRecordFields""" + + self.__api_name = None + self.__data = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['_data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge.py new file mode 100644 index 0000000..39f1e32 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Merge(object): + def __init__(self): + """Creates an instance of Merge""" + + self.__job_id = None + self.__status = None + self.__data = None + self.__master_record_fields = None + self.__key_modified = dict() + + def get_job_id(self): + """ + The method to get the job_id + + Returns: + int: An int representing the job_id + """ + + return self.__job_id + + def set_job_id(self, job_id): + """ + The method to set the value to job_id + + Parameters: + job_id (int) : An int representing the job_id + """ + + if job_id is not None and not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + self.__job_id = job_id + self.__key_modified['job_id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_master_record_fields(self): + """ + The method to get the master_record_fields + + Returns: + list: An instance of list + """ + + return self.__master_record_fields + + def set_master_record_fields(self, master_record_fields): + """ + The method to set the value to master_record_fields + + Parameters: + master_record_fields (list) : An instance of list + """ + + if master_record_fields is not None and not isinstance(master_record_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: master_record_fields EXPECTED TYPE: list', None, None) + + self.__master_record_fields = master_record_fields + self.__key_modified['master_record_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge_data.py new file mode 100644 index 0000000..02a0909 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge_data.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MergeData(object): + def __init__(self): + """Creates an instance of MergeData""" + + self.__fields = None + self.__id = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['_fields'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_wrapper.py new file mode 100644 index 0000000..1ca51be --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__merge = None + self.__key_modified = dict() + + def get_merge(self): + """ + The method to get the merge + + Returns: + list: An instance of list + """ + + return self.__merge + + def set_merge(self, merge): + """ + The method to set the value to merge + + Parameters: + merge (list) : An instance of list + """ + + if merge is not None and not isinstance(merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: merge EXPECTED TYPE: list', None, None) + + self.__merge = merge + self.__key_modified['merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/success_response.py new file mode 100644 index 0000000..7177c25 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/__init__.py new file mode 100644 index 0000000..470e40e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .year import Year +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .fiscal_year_operations import FiscalYearOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_wrapper.py new file mode 100644 index 0000000..7ca56d5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__fiscal_year = None + self.__key_modified = dict() + + def get_fiscal_year(self): + """ + The method to get the fiscal_year + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__fiscal_year + + def set_fiscal_year(self, fiscal_year): + """ + The method to set the value to fiscal_year + + Parameters: + fiscal_year (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if fiscal_year is not None and not isinstance(fiscal_year, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fiscal_year EXPECTED TYPE: ActionResponse', None, None) + + self.__fiscal_year = fiscal_year + self.__key_modified['fiscal_year'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/api_exception.py new file mode 100644 index 0000000..02689a1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/body_wrapper.py new file mode 100644 index 0000000..e7c178a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__fiscal_year = None + self.__key_modified = dict() + + def get_fiscal_year(self): + """ + The method to get the fiscal_year + + Returns: + Year: An instance of Year + """ + + return self.__fiscal_year + + def set_fiscal_year(self, fiscal_year): + """ + The method to set the value to fiscal_year + + Parameters: + fiscal_year (Year) : An instance of Year + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.year import Year + except Exception: + from .year import Year + + if fiscal_year is not None and not isinstance(fiscal_year, Year): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fiscal_year EXPECTED TYPE: Year', None, None) + + self.__fiscal_year = fiscal_year + self.__key_modified['fiscal_year'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/fiscal_year_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/fiscal_year_operations.py new file mode 100644 index 0000000..73e6439 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/fiscal_year_operations.py @@ -0,0 +1,72 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class FiscalYearOperations(object): + def __init__(self): + """Creates an instance of FiscalYearOperations""" + pass + + def get_fiscal_year(self): + """ + The method to get fiscal year + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/fiscal_year' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_fiscal_year(self, request): + """ + The method to update fiscal year + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/fiscal_year' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_wrapper.py new file mode 100644 index 0000000..06f1231 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__fiscal_year = None + self.__key_modified = dict() + + def get_fiscal_year(self): + """ + The method to get the fiscal_year + + Returns: + Year: An instance of Year + """ + + return self.__fiscal_year + + def set_fiscal_year(self, fiscal_year): + """ + The method to set the value to fiscal_year + + Parameters: + fiscal_year (Year) : An instance of Year + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.year import Year + except Exception: + from .year import Year + + if fiscal_year is not None and not isinstance(fiscal_year, Year): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fiscal_year EXPECTED TYPE: Year', None, None) + + self.__fiscal_year = fiscal_year + self.__key_modified['fiscal_year'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/success_response.py new file mode 100644 index 0000000..fc40578 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/year.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/year.py new file mode 100644 index 0000000..5361883 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/year.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Year(object): + def __init__(self): + """Creates an instance of Year""" + + self.__start_month = None + self.__display_based_on = None + self.__id = None + self.__key_modified = dict() + + def get_start_month(self): + """ + The method to get the start_month + + Returns: + Choice: An instance of Choice + """ + + return self.__start_month + + def set_start_month(self, start_month): + """ + The method to set the value to start_month + + Parameters: + start_month (Choice) : An instance of Choice + """ + + if start_month is not None and not isinstance(start_month, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_month EXPECTED TYPE: Choice', None, None) + + self.__start_month = start_month + self.__key_modified['start_month'] = 1 + + def get_display_based_on(self): + """ + The method to get the display_based_on + + Returns: + Choice: An instance of Choice + """ + + return self.__display_based_on + + def set_display_based_on(self, display_based_on): + """ + The method to set the value to display_based_on + + Parameters: + display_based_on (Choice) : An instance of Choice + """ + + if display_based_on is not None and not isinstance(display_based_on, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_based_on EXPECTED TYPE: Choice', None, None) + + self.__display_based_on = display_based_on + self.__key_modified['display_based_on'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/__init__.py new file mode 100644 index 0000000..00c417b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/__init__.py @@ -0,0 +1,5 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .address import Address +from .response_wrapper import ResponseWrapper +from .from_addresses_operations import FromAddressesOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/address.py new file mode 100644 index 0000000..34c4e25 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__email = None + self.__type = None + self.__id = None + self.__user_name = None + self.__default = None + self.__key_modified = dict() + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/api_exception.py new file mode 100644 index 0000000..a3c633a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.from_addresses.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/from_addresses_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/from_addresses_operations.py new file mode 100644 index 0000000..a0fb2de --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/from_addresses_operations.py @@ -0,0 +1,35 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class FromAddressesOperations(object): + def __init__(self): + """Creates an instance of FromAddressesOperations""" + pass + + def get_from_addresses(self): + """ + The method to get from addresses + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/emails/actions/from_addresses' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.from_addresses.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_wrapper.py new file mode 100644 index 0000000..9c1d0a7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.from_addresses.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__from_addresses = None + self.__key_modified = dict() + + def get_from_addresses(self): + """ + The method to get the from_addresses + + Returns: + list: An instance of list + """ + + return self.__from_addresses + + def set_from_addresses(self, from_addresses): + """ + The method to set the value to from_addresses + + Parameters: + from_addresses (list) : An instance of list + """ + + if from_addresses is not None and not isinstance(from_addresses, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_addresses EXPECTED TYPE: list', None, None) + + self.__from_addresses = from_addresses + self.__key_modified['from_addresses'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/__init__.py new file mode 100644 index 0000000..a541852 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .functions_operations import FunctionsOperations, ExecuteFunctionUsingRequestBodyParam, ExecuteFunctionUsingRequestBodyHeader, ExecuteFunctionUsingParametersParam, ExecuteFunctionUsingParametersHeader, ExecuteFunctionUsingFileParam, ExecuteFunctionUsingFileHeader +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/api_exception.py new file mode 100644 index 0000000..a62d300 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_wrapper import ResponseWrapper + + +class APIException(ResponseWrapper): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/body_wrapper.py new file mode 100644 index 0000000..1991c62 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__body = None + self.__key_modified = dict() + + def get_body(self): + """ + The method to get the body + + Returns: + dict: An instance of dict + """ + + return self.__body + + def set_body(self, body): + """ + The method to set the value to body + + Parameters: + body (dict) : An instance of dict + """ + + if body is not None and not isinstance(body, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: body EXPECTED TYPE: dict', None, None) + + self.__body = body + self.__key_modified['body'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/file_body_wrapper.py new file mode 100644 index 0000000..06224c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/file_body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + + +class FileBodyWrapper(object): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + + self.__inputfile = None + self.__key_modified = dict() + + def get_inputfile(self): + """ + The method to get the inputfile + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__inputfile + + def set_inputfile(self, inputfile): + """ + The method to set the value to inputfile + + Parameters: + inputfile (StreamWrapper) : An instance of StreamWrapper + """ + + if inputfile is not None and not isinstance(inputfile, StreamWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inputfile EXPECTED TYPE: StreamWrapper', None, None) + + self.__inputfile = inputfile + self.__key_modified['inputFile'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/functions_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/functions_operations.py new file mode 100644 index 0000000..495e3bb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/functions_operations.py @@ -0,0 +1,231 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class FunctionsOperations(object): + def __init__(self, function_name, auth_type=None, arguments=None): + """ + Creates an instance of FunctionsOperations with the given parameters + + Parameters: + function_name (string) : A string representing the function_name + auth_type (string) : A string representing the auth_type + arguments (dict) : An instance of dict + """ + + if not isinstance(function_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: function_name EXPECTED TYPE: str', None, None) + + if auth_type is not None and not isinstance(auth_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auth_type EXPECTED TYPE: str', None, None) + + if arguments is not None and not isinstance(arguments, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: arguments EXPECTED TYPE: dict', None, None) + + self.__function_name = function_name + self.__auth_type = auth_type + self.__arguments = arguments + + + def execute_function_using_request_body(self, request, param_instance=None, header_instance=None): + """ + The method to execute function using request body + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/functions/' + api_path = api_path + str(self.__function_name) + api_path = api_path + '/actions/execute' + 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('auth_type', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyParam'), self.__auth_type) + handler_instance.add_param(Param('arguments', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyParam'), self.__arguments) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + def execute_function_using_parameters(self, param_instance=None, header_instance=None): + """ + The method to execute function using parameters + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/functions/' + api_path = api_path + str(self.__function_name) + api_path = api_path + '/actions/execute' + 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('auth_type', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersParam'), self.__auth_type) + handler_instance.add_param(Param('arguments', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersParam'), self.__arguments) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + def execute_function_using_file(self, request, param_instance=None, header_instance=None): + """ + The method to execute function using file + + Parameters: + request (FileBodyWrapper) : An instance of FileBodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/functions/' + api_path = api_path + str(self.__function_name) + api_path = api_path + '/actions/execute' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.add_param(Param('auth_type', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileParam'), self.__auth_type) + handler_instance.add_param(Param('arguments', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileParam'), self.__arguments) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + +class ExecuteFunctionUsingRequestBodyParam(object): + custom_functions_param = Param('custom_functions_param', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyParam') + + +class ExecuteFunctionUsingRequestBodyHeader(object): + custom_functions_header = Header('custom_functions_header', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyHeader') + + +class ExecuteFunctionUsingParametersParam(object): + get_custom_functions_param = Param('get_custom_functions_param', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersParam') + + +class ExecuteFunctionUsingParametersHeader(object): + get_custom_functions_header = Header('get_custom_functions_header', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersHeader') + + +class ExecuteFunctionUsingFileParam(object): + upload_file_param = Param('upload_file_param', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileParam') + + +class ExecuteFunctionUsingFileHeader(object): + upload_file_header = Header('upload_file_header', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileHeader') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/response_wrapper.py new file mode 100644 index 0000000..1c2d2c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/response_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseWrapper(ABC): + def __init__(self): + """Creates an instance of ResponseWrapper""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/success_response.py new file mode 100644 index 0000000..3466ae0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/functions/success_response.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_wrapper import ResponseWrapper + + +class SuccessResponse(ResponseWrapper): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/__init__.py new file mode 100644 index 0000000..8741349 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/__init__.py @@ -0,0 +1,32 @@ +from .pick_list_values_associations_response_wrapper import PickListValuesAssociationsResponseWrapper +from .associations_response_wrapper import AssociationsResponseWrapper +from .replace_body_wrapper import ReplaceBodyWrapper +from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler +from .picklist import Picklist +from .association import Association +from .pick_list_values_association import PickListValuesAssociation +from .associations_response_handler import AssociationsResponseHandler +from .global_picklists_operations import GlobalPicklistsOperations, GetGlobalPicklistsParam, DeleteGlobalPicklistsParam, GetGlobalPicklistParam, GetAssociationsParam, GetPickListValueAssociationsParam +from .replace_action_handler import ReplaceActionHandler +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .replace_picklist_values import ReplacePicklistValues +from .success_response import SuccessResponse +from .action_handler import ActionHandler +from .replace_action_wrapper import ReplaceActionWrapper +from .info import Info +from .replaced_response_handler import ReplacedResponseHandler +from .action_wrapper import ActionWrapper +from .replaced_value import ReplacedValue +from .resource import Resource +from .module import Module +from .body_wrapper import BodyWrapper +from .replace_success_response import ReplaceSuccessResponse +from .layout import Layout +from .field import Field +from .replaced_response_wrapper import ReplacedResponseWrapper +from .response_wrapper import ResponseWrapper +from .replace_picklist_value import ReplacePicklistValue +from .replace_action_response import ReplaceActionResponse +from .pick_list_values import PickListValues diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_wrapper.py new file mode 100644 index 0000000..3bc6238 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__global_picklists = None + self.__key_modified = dict() + + def get_global_picklists(self): + """ + The method to get the global_picklists + + Returns: + list: An instance of list + """ + + return self.__global_picklists + + def set_global_picklists(self, global_picklists): + """ + The method to set the value to global_picklists + + Parameters: + global_picklists (list) : An instance of list + """ + + if global_picklists is not None and not isinstance(global_picklists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_picklists EXPECTED TYPE: list', None, None) + + self.__global_picklists = global_picklists + self.__key_modified['global_picklists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/api_exception.py new file mode 100644 index 0000000..5eb174c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/api_exception.py @@ -0,0 +1,166 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.associations_response_handler import AssociationsResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_handler import ReplaceActionHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_response import ReplaceActionResponse + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replaced_response_handler import ReplacedResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + from .action_handler import ActionHandler + from .associations_response_handler import AssociationsResponseHandler + from .replace_action_handler import ReplaceActionHandler + from .replace_action_response import ReplaceActionResponse + from .replaced_response_handler import ReplacedResponseHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler, ReplaceActionHandler, ReplaceActionResponse, ReplacedResponseHandler, AssociationsResponseHandler, PickListValuesAssociationsResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/association.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/association.py new file mode 100644 index 0000000..e99f80a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/association.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Association(object): + def __init__(self): + """Creates an instance of Association""" + + self.__field = None + self.__module = None + self.__layouts = None + self.__key_modified = dict() + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_handler.py new file mode 100644 index 0000000..0b460f7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class AssociationsResponseHandler(ABC): + def __init__(self): + """Creates an instance of AssociationsResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_wrapper.py new file mode 100644 index 0000000..b7056b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.associations_response_handler import AssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .associations_response_handler import AssociationsResponseHandler + + +class AssociationsResponseWrapper(AssociationsResponseHandler): + def __init__(self): + """Creates an instance of AssociationsResponseWrapper""" + super().__init__() + + self.__associations = None + self.__info = None + self.__key_modified = dict() + + def get_associations(self): + """ + The method to get the associations + + Returns: + list: An instance of list + """ + + return self.__associations + + def set_associations(self, associations): + """ + The method to set the value to associations + + Parameters: + associations (list) : An instance of list + """ + + if associations is not None and not isinstance(associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associations EXPECTED TYPE: list', None, None) + + self.__associations = associations + self.__key_modified['associations'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/body_wrapper.py new file mode 100644 index 0000000..3ae2801 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__global_picklists = None + self.__key_modified = dict() + + def get_global_picklists(self): + """ + The method to get the global_picklists + + Returns: + list: An instance of list + """ + + return self.__global_picklists + + def set_global_picklists(self, global_picklists): + """ + The method to set the value to global_picklists + + Parameters: + global_picklists (list) : An instance of list + """ + + if global_picklists is not None and not isinstance(global_picklists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_picklists EXPECTED TYPE: list', None, None) + + self.__global_picklists = global_picklists + self.__key_modified['global_picklists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/global_picklists_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/global_picklists_operations.py new file mode 100644 index 0000000..f10029a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/global_picklists_operations.py @@ -0,0 +1,448 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class GlobalPicklistsOperations(object): + def __init__(self): + """Creates an instance of GlobalPicklistsOperations""" + pass + + def get_global_picklists(self, param_instance=None): + """ + The method to get global picklists + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/global_picklists' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_global_picklist(self, request): + """ + The method to create global picklist + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/global_picklists' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_global_picklists(self, request): + """ + The method to update global picklists + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/global_picklists' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_global_picklists(self, param_instance=None): + """ + The method to delete global picklists + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/global_picklists' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_global_picklist(self, id, param_instance=None): + """ + The method to get global picklist + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/global_picklists/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_global_picklist(self, id, request): + """ + The method to update global picklist + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/global_picklists/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_global_picklist(self, id): + """ + The method to delete global picklist + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def replace_picklist_values(self, id, request): + """ + The method to replace picklist values + + Parameters: + id (int) : An int representing the id + request (ReplaceBodyWrapper) : An instance of ReplaceBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_body_wrapper import ReplaceBodyWrapper + except Exception: + from .replace_body_wrapper import ReplaceBodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, ReplaceBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ReplaceBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/replace_picklist_values' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_handler import ReplaceActionHandler + except Exception: + from .replace_action_handler import ReplaceActionHandler + return handler_instance.api_call(ReplaceActionHandler.__module__, 'application/json') + + def get_replace_values(self, id): + """ + The method to get replace values + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/replaced_values' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replaced_response_handler import ReplacedResponseHandler + except Exception: + from .replaced_response_handler import ReplacedResponseHandler + return handler_instance.api_call(ReplacedResponseHandler.__module__, 'application/json') + + def get_associations(self, id, param_instance=None): + """ + The method to get associations + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.associations_response_handler import AssociationsResponseHandler + except Exception: + from .associations_response_handler import AssociationsResponseHandler + return handler_instance.api_call(AssociationsResponseHandler.__module__, 'application/json') + + def get_pick_list_value_associations(self, id, param_instance=None): + """ + The method to get pick list value associations + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/pick_list_values_associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + except Exception: + from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + return handler_instance.api_call(PickListValuesAssociationsResponseHandler.__module__, 'application/json') + + +class GetGlobalPicklistsParam(object): + include = Param('include', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistsParam') + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistsParam') + + +class DeleteGlobalPicklistsParam(object): + ids = Param('ids', 'com.zoho.crm.api.GlobalPicklists.DeleteGlobalPicklistsParam') + + +class GetGlobalPicklistParam(object): + include = Param('include', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistParam') + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistParam') + + +class GetAssociationsParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.GlobalPicklists.GetAssociationsParam') + page = Param('page', 'com.zoho.crm.api.GlobalPicklists.GetAssociationsParam') + per_page = Param('per_page', 'com.zoho.crm.api.GlobalPicklists.GetAssociationsParam') + + +class GetPickListValueAssociationsParam(object): + picklist_value_id = Param('picklist_value_id', 'com.zoho.crm.api.GlobalPicklists.GetPickListValueAssociationsParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/layout.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/layout.py new file mode 100644 index 0000000..4c19809 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/layout.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__name = None + self.__id = None + self.__status = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/module.py new file mode 100644 index 0000000..f36b9b9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__plural_label = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values.py new file mode 100644 index 0000000..7085cd1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class PickListValues(object): + def __init__(self): + """Creates an instance of PickListValues""" + + self.__actual_value = None + self.__type = None + self.__id = None + self.__sequence_number = None + self.__display_value = None + self.__key_modified = dict() + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_association.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_association.py new file mode 100644 index 0000000..e1568cb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_association.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PickListValuesAssociation(object): + def __init__(self): + """Creates an instance of PickListValuesAssociation""" + + self.__type = None + self.__resources = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_handler.py new file mode 100644 index 0000000..28310c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class PickListValuesAssociationsResponseHandler(ABC): + def __init__(self): + """Creates an instance of PickListValuesAssociationsResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_wrapper.py new file mode 100644 index 0000000..cf8aa33 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + + +class PickListValuesAssociationsResponseWrapper(PickListValuesAssociationsResponseHandler): + def __init__(self): + """Creates an instance of PickListValuesAssociationsResponseWrapper""" + super().__init__() + + self.__pick_list_values_associations = None + self.__key_modified = dict() + + def get_pick_list_values_associations(self): + """ + The method to get the pick_list_values_associations + + Returns: + list: An instance of list + """ + + return self.__pick_list_values_associations + + def set_pick_list_values_associations(self, pick_list_values_associations): + """ + The method to set the value to pick_list_values_associations + + Parameters: + pick_list_values_associations (list) : An instance of list + """ + + if pick_list_values_associations is not None and not isinstance(pick_list_values_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_associations EXPECTED TYPE: list', None, None) + + self.__pick_list_values_associations = pick_list_values_associations + self.__key_modified['pick_list_values_associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/picklist.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/picklist.py new file mode 100644 index 0000000..fde8548 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/picklist.py @@ -0,0 +1,363 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Picklist(object): + def __init__(self): + """Creates an instance of Picklist""" + + self.__display_label = None + self.__created_time = None + self.__modified_time = None + self.__id = None + self.__api_name = None + self.__actual_label = None + self.__description = None + self.__modified_by = None + self.__created_by = None + self.__presence = None + self.__pick_list_values_sorted_lexically = None + self.__pick_list_values = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_actual_label(self): + """ + The method to get the actual_label + + Returns: + string: A string representing the actual_label + """ + + return self.__actual_label + + def set_actual_label(self, actual_label): + """ + The method to set the value to actual_label + + Parameters: + actual_label (string) : A string representing the actual_label + """ + + if actual_label is not None and not isinstance(actual_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_label EXPECTED TYPE: str', None, None) + + self.__actual_label = actual_label + self.__key_modified['actual_label'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_presence(self): + """ + The method to get the presence + + Returns: + bool: A bool representing the presence + """ + + return self.__presence + + def set_presence(self, presence): + """ + The method to set the value to presence + + Parameters: + presence (bool) : A bool representing the presence + """ + + if presence is not None and not isinstance(presence, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: presence EXPECTED TYPE: bool', None, None) + + self.__presence = presence + self.__key_modified['presence'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_handler.py new file mode 100644 index 0000000..7c7f618 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ReplaceActionHandler(ABC): + def __init__(self): + """Creates an instance of ReplaceActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_response.py new file mode 100644 index 0000000..07120ad --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ReplaceActionResponse(ABC): + def __init__(self): + """Creates an instance of ReplaceActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_wrapper.py new file mode 100644 index 0000000..096190d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_handler import ReplaceActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .replace_action_handler import ReplaceActionHandler + + +class ReplaceActionWrapper(ReplaceActionHandler): + def __init__(self): + """Creates an instance of ReplaceActionWrapper""" + super().__init__() + + self.__replace_picklist_values = None + self.__key_modified = dict() + + def get_replace_picklist_values(self): + """ + The method to get the replace_picklist_values + + Returns: + list: An instance of list + """ + + return self.__replace_picklist_values + + def set_replace_picklist_values(self, replace_picklist_values): + """ + The method to set the value to replace_picklist_values + + Parameters: + replace_picklist_values (list) : An instance of list + """ + + if replace_picklist_values is not None and not isinstance(replace_picklist_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replace_picklist_values EXPECTED TYPE: list', None, None) + + self.__replace_picklist_values = replace_picklist_values + self.__key_modified['replace_picklist_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_body_wrapper.py new file mode 100644 index 0000000..704dd19 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplaceBodyWrapper(object): + def __init__(self): + """Creates an instance of ReplaceBodyWrapper""" + + self.__replace_picklist_values = None + self.__key_modified = dict() + + def get_replace_picklist_values(self): + """ + The method to get the replace_picklist_values + + Returns: + list: An instance of list + """ + + return self.__replace_picklist_values + + def set_replace_picklist_values(self, replace_picklist_values): + """ + The method to set the value to replace_picklist_values + + Parameters: + replace_picklist_values (list) : An instance of list + """ + + if replace_picklist_values is not None and not isinstance(replace_picklist_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replace_picklist_values EXPECTED TYPE: list', None, None) + + self.__replace_picklist_values = replace_picklist_values + self.__key_modified['replace_picklist_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_value.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_value.py new file mode 100644 index 0000000..a537003 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_value.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplacePicklistValue(object): + def __init__(self): + """Creates an instance of ReplacePicklistValue""" + + self.__id = None + self.__display_value = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_values.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_values.py new file mode 100644 index 0000000..0b77197 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_values.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplacePicklistValues(object): + def __init__(self): + """Creates an instance of ReplacePicklistValues""" + + self.__new_value = None + self.__old_value = None + self.__key_modified = dict() + + def get_new_value(self): + """ + The method to get the new_value + + Returns: + ReplacePicklistValue: An instance of ReplacePicklistValue + """ + + return self.__new_value + + def set_new_value(self, new_value): + """ + The method to set the value to new_value + + Parameters: + new_value (ReplacePicklistValue) : An instance of ReplacePicklistValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_picklist_value import ReplacePicklistValue + except Exception: + from .replace_picklist_value import ReplacePicklistValue + + if new_value is not None and not isinstance(new_value, ReplacePicklistValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: new_value EXPECTED TYPE: ReplacePicklistValue', None, None) + + self.__new_value = new_value + self.__key_modified['new_value'] = 1 + + def get_old_value(self): + """ + The method to get the old_value + + Returns: + ReplacePicklistValue: An instance of ReplacePicklistValue + """ + + return self.__old_value + + def set_old_value(self, old_value): + """ + The method to set the value to old_value + + Parameters: + old_value (ReplacePicklistValue) : An instance of ReplacePicklistValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_picklist_value import ReplacePicklistValue + except Exception: + from .replace_picklist_value import ReplacePicklistValue + + if old_value is not None and not isinstance(old_value, ReplacePicklistValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: old_value EXPECTED TYPE: ReplacePicklistValue', None, None) + + self.__old_value = old_value + self.__key_modified['old_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_success_response.py new file mode 100644 index 0000000..a1b62ba --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_response import ReplaceActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .replace_action_response import ReplaceActionResponse + + +class ReplaceSuccessResponse(ReplaceActionResponse): + def __init__(self): + """Creates an instance of ReplaceSuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_handler.py new file mode 100644 index 0000000..754e5ba --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ReplacedResponseHandler(ABC): + def __init__(self): + """Creates an instance of ReplacedResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_wrapper.py new file mode 100644 index 0000000..ea89ceb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replaced_response_handler import ReplacedResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .replaced_response_handler import ReplacedResponseHandler + + +class ReplacedResponseWrapper(ReplacedResponseHandler): + def __init__(self): + """Creates an instance of ReplacedResponseWrapper""" + super().__init__() + + self.__replaced_values = None + self.__key_modified = dict() + + def get_replaced_values(self): + """ + The method to get the replaced_values + + Returns: + list: An instance of list + """ + + return self.__replaced_values + + def set_replaced_values(self, replaced_values): + """ + The method to set the value to replaced_values + + Parameters: + replaced_values (list) : An instance of list + """ + + if replaced_values is not None and not isinstance(replaced_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replaced_values EXPECTED TYPE: list', None, None) + + self.__replaced_values = replaced_values + self.__key_modified['replaced_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_value.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_value.py new file mode 100644 index 0000000..0c8c6a3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_value.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplacedValue(object): + def __init__(self): + """Creates an instance of ReplacedValue""" + + self.__display_value = None + self.__actual_value = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/resource.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/resource.py new file mode 100644 index 0000000..1dc9c7f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/resource.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__details = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + list: An instance of list + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (list) : An instance of list + """ + + if details is not None and not isinstance(details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: list', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_wrapper.py new file mode 100644 index 0000000..29587d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__global_picklists = None + self.__key_modified = dict() + + def get_global_picklists(self): + """ + The method to get the global_picklists + + Returns: + list: An instance of list + """ + + return self.__global_picklists + + def set_global_picklists(self, global_picklists): + """ + The method to set the value to global_picklists + + Parameters: + global_picklists (list) : An instance of list + """ + + if global_picklists is not None and not isinstance(global_picklists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_picklists EXPECTED TYPE: list', None, None) + + self.__global_picklists = global_picklists + self.__key_modified['global_picklists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/success_response.py new file mode 100644 index 0000000..828d114 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/global_picklists/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/header.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/header.py new file mode 100755 index 0000000..ae36490 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/header.py @@ -0,0 +1,19 @@ + +class Header(object): + + """ + This class represents the HTTP header. + """ + + def __init__(self, name, class_name=None): + + """ + Creates an Header class instance with the following parameters + + Parameters: + name (str) : A string containing the header name. + class_name (str) : A string containing the header class name. + """ + + self.name = name + self.class_name = class_name diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/header_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/header_map.py new file mode 100755 index 0000000..534a702 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/header_map.py @@ -0,0 +1,69 @@ +try: + import logging + from zohocrmsdk.src.com.zoho.crm.api.header import Header + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.header_param_validator import HeaderParamValidator +except Exception: + import logging + from .util.constants import Constants + from .util.header_param_validator import HeaderParamValidator + from .util.datatype_converter import DataTypeConverter + from .header import Header + from ..api.exception import SDKException + + +class HeaderMap(object): + + """ + This class represents the HTTP header name and value. + """ + + def __init__(self): + """Creates an instance of HeaderMap Class""" + + self.request_headers = dict() + + def add(self, header, value): + + """ + The method to add the parameter name and value. + + Parameters: + header (Header): A Header class instance. + value (object): An object containing the header value. + """ + + if header is None: + raise SDKException(Constants.HEADER_NONE_ERROR, Constants.HEADER_INSTANCE_NONE_ERROR) + + header_name = header.name + + if header_name is None: + raise SDKException(Constants.HEADER_NAME_NONE_ERROR, Constants.HEADER_NAME_NULL_ERROR_MESSAGE) + + if value is None: + raise SDKException(Constants.HEADER_NONE_ERROR, header_name + Constants.NONE_VALUE_ERROR_MESSAGE) + try: + class_name = header.class_name + parsed_header_value = None + if class_name is not None: + parsed_header_value = HeaderParamValidator().validate(header_name, class_name, value) + else: + try: + parsed_header_value = DataTypeConverter.post_convert(value, value.__class__.__name__) + except Exception as e: + parsed_header_value = str(value) + if header_name not in self.request_headers: + self.request_headers[header_name] = str(parsed_header_value) + else: + header_value = self.request_headers[header_name] + self.request_headers[header_name] = header_value + ',' + str(parsed_header_value) + except SDKException as e: + logging.getLogger('SDKLogger').error(Constants.HEADER_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + logging.getLogger('SDKLogger').error(Constants.HEADER_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/__init__.py new file mode 100644 index 0000000..f8c1736 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/__init__.py @@ -0,0 +1,8 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .hipaa_compliance import HipaaCompliance +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .modules import Modules diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_wrapper.py new file mode 100644 index 0000000..1d5ece0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__hipaa_compliance = None + self.__key_modified = dict() + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: ActionResponse', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/api_exception.py new file mode 100644 index 0000000..70438a3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class APIException(ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/hipaa_compliance.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/hipaa_compliance.py new file mode 100644 index 0000000..8801590 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/hipaa_compliance.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HipaaCompliance(object): + def __init__(self): + """Creates an instance of HipaaCompliance""" + + self.__enabled = None + self.__enabled_for_modules = None + self.__restrict_to_zoho_apps = None + self.__restrict_data_access_through_api = None + self.__restrict_data_in_export = None + self.__restrict_to_third_party_apps = None + self.__key_modified = dict() + + def get_enabled(self): + """ + The method to get the enabled + + Returns: + bool: A bool representing the enabled + """ + + return self.__enabled + + def set_enabled(self, enabled): + """ + The method to set the value to enabled + + Parameters: + enabled (bool) : A bool representing the enabled + """ + + if enabled is not None and not isinstance(enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enabled EXPECTED TYPE: bool', None, None) + + self.__enabled = enabled + self.__key_modified['enabled'] = 1 + + def get_enabled_for_modules(self): + """ + The method to get the enabled_for_modules + + Returns: + list: An instance of list + """ + + return self.__enabled_for_modules + + def set_enabled_for_modules(self, enabled_for_modules): + """ + The method to set the value to enabled_for_modules + + Parameters: + enabled_for_modules (list) : An instance of list + """ + + if enabled_for_modules is not None and not isinstance(enabled_for_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enabled_for_modules EXPECTED TYPE: list', None, None) + + self.__enabled_for_modules = enabled_for_modules + self.__key_modified['enabled_for_modules'] = 1 + + def get_restrict_to_zoho_apps(self): + """ + The method to get the restrict_to_zoho_apps + + Returns: + bool: A bool representing the restrict_to_zoho_apps + """ + + return self.__restrict_to_zoho_apps + + def set_restrict_to_zoho_apps(self, restrict_to_zoho_apps): + """ + The method to set the value to restrict_to_zoho_apps + + Parameters: + restrict_to_zoho_apps (bool) : A bool representing the restrict_to_zoho_apps + """ + + if restrict_to_zoho_apps is not None and not isinstance(restrict_to_zoho_apps, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_to_zoho_apps EXPECTED TYPE: bool', None, None) + + self.__restrict_to_zoho_apps = restrict_to_zoho_apps + self.__key_modified['restrict_to_zoho_apps'] = 1 + + def get_restrict_data_access_through_api(self): + """ + The method to get the restrict_data_access_through_api + + Returns: + bool: A bool representing the restrict_data_access_through_api + """ + + return self.__restrict_data_access_through_api + + def set_restrict_data_access_through_api(self, restrict_data_access_through_api): + """ + The method to set the value to restrict_data_access_through_api + + Parameters: + restrict_data_access_through_api (bool) : A bool representing the restrict_data_access_through_api + """ + + if restrict_data_access_through_api is not None and not isinstance(restrict_data_access_through_api, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_data_access_through_api EXPECTED TYPE: bool', None, None) + + self.__restrict_data_access_through_api = restrict_data_access_through_api + self.__key_modified['restrict_data_access_through_api'] = 1 + + def get_restrict_data_in_export(self): + """ + The method to get the restrict_data_in_export + + Returns: + bool: A bool representing the restrict_data_in_export + """ + + return self.__restrict_data_in_export + + def set_restrict_data_in_export(self, restrict_data_in_export): + """ + The method to set the value to restrict_data_in_export + + Parameters: + restrict_data_in_export (bool) : A bool representing the restrict_data_in_export + """ + + if restrict_data_in_export is not None and not isinstance(restrict_data_in_export, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_data_in_export EXPECTED TYPE: bool', None, None) + + self.__restrict_data_in_export = restrict_data_in_export + self.__key_modified['restrict_data_in_export'] = 1 + + def get_restrict_to_third_party_apps(self): + """ + The method to get the restrict_to_third_party_apps + + Returns: + list: An instance of list + """ + + return self.__restrict_to_third_party_apps + + def set_restrict_to_third_party_apps(self, restrict_to_third_party_apps): + """ + The method to set the value to restrict_to_third_party_apps + + Parameters: + restrict_to_third_party_apps (list) : An instance of list + """ + + if restrict_to_third_party_apps is not None and not isinstance(restrict_to_third_party_apps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_to_third_party_apps EXPECTED TYPE: list', None, None) + + self.__restrict_to_third_party_apps = restrict_to_third_party_apps + self.__key_modified['restrict_to_third_party_apps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/modules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/modules.py new file mode 100644 index 0000000..ef2588f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/modules.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/response_wrapper.py new file mode 100644 index 0000000..7be71e2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/response_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__hipaa_compliance = None + self.__key_modified = dict() + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.hipaa_compliance import HipaaCompliance + except Exception: + from .hipaa_compliance import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/success_response.py new file mode 100644 index 0000000..27c7c19 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class SuccessResponse(ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/__init__.py new file mode 100644 index 0000000..0292164 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .shift_holiday import ShiftHoliday +from .resonse_handler import ResonseHandler +from .body_wrapper import BodyWrapper +from .holiday import Holiday +from .create_shift_holiday import CreateShiftHoliday +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .holidays import Holidays +from .business_holiday import BusinessHoliday +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .create_business_holiday import CreateBusinessHoliday +from .holidays_operations import HolidaysOperations, GetHolidaysHeader, GetHolidaysParam, CreateHolidaysHeader, UpdateHolidaysHeader, UpdateHolidayHeader, GetHolidayHeader, DeleteHolidayHeader +from .shift_hour import ShiftHour +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_wrapper.py new file mode 100644 index 0000000..1aca812 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/api_exception.py new file mode 100644 index 0000000..964cc39 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.holidays.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.holidays.resonse_handler import ResonseHandler + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .resonse_handler import ResonseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse, ResonseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/body_wrapper.py new file mode 100644 index 0000000..2f7bb78 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/body_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class BodyWrapper(ABC): + def __init__(self): + """Creates an instance of BodyWrapper""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/business_holiday.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/business_holiday.py new file mode 100644 index 0000000..faef905 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/business_holiday.py @@ -0,0 +1,126 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BusinessHoliday(object): + def __init__(self): + """Creates an instance of BusinessHoliday""" + + self.__name = None + self.__date = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/create_business_holiday.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/create_business_holiday.py new file mode 100644 index 0000000..ff98146 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/create_business_holiday.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.body_wrapper import BodyWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .body_wrapper import BodyWrapper + + +class CreateBusinessHoliday(BodyWrapper): + def __init__(self): + """Creates an instance of CreateBusinessHoliday""" + super().__init__() + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/create_shift_holiday.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/create_shift_holiday.py new file mode 100644 index 0000000..4b8f84e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/create_shift_holiday.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.body_wrapper import BodyWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .body_wrapper import BodyWrapper + + +class CreateShiftHoliday(BodyWrapper): + def __init__(self): + """Creates an instance of CreateShiftHoliday""" + super().__init__() + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holiday.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holiday.py new file mode 100644 index 0000000..acbd361 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holiday.py @@ -0,0 +1,206 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Holiday(object): + def __init__(self): + """Creates an instance of Holiday""" + + self.__year = None + self.__name = None + self.__date = None + self.__type = None + self.__id = None + self.__shift_hour = None + self.__key_modified = dict() + + def get_year(self): + """ + The method to get the year + + Returns: + int: An int representing the year + """ + + return self.__year + + def set_year(self, year): + """ + The method to set the value to year + + Parameters: + year (int) : An int representing the year + """ + + if year is not None and not isinstance(year, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: year EXPECTED TYPE: int', None, None) + + self.__year = year + self.__key_modified['year'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_shift_hour(self): + """ + The method to get the shift_hour + + Returns: + ShiftHour: An instance of ShiftHour + """ + + return self.__shift_hour + + def set_shift_hour(self, shift_hour): + """ + The method to set the value to shift_hour + + Parameters: + shift_hour (ShiftHour) : An instance of ShiftHour + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.shift_hour import ShiftHour + except Exception: + from .shift_hour import ShiftHour + + if shift_hour is not None and not isinstance(shift_hour, ShiftHour): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hour EXPECTED TYPE: ShiftHour', None, None) + + self.__shift_hour = shift_hour + self.__key_modified['shift_hour'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays.py new file mode 100644 index 0000000..ec79830 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Holidays(object): + def __init__(self): + """Creates an instance of Holidays""" + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays_operations.py new file mode 100644 index 0000000..ae8ad38 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays_operations.py @@ -0,0 +1,273 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class HolidaysOperations(object): + def __init__(self, x_crm_org=None): + """ + Creates an instance of HolidaysOperations with the given parameters + + Parameters: + x_crm_org (string) : A string representing the x_crm_org + """ + + if x_crm_org is not None and not isinstance(x_crm_org, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_crm_org EXPECTED TYPE: str', None, None) + + self.__x_crm_org = x_crm_org + + + def get_holidays(self, param_instance=None): + """ + The method to get holidays + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/holidays' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.GetHolidaysHeader'), self.__x_crm_org) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_holidays(self, request): + """ + The method to create holidays + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/holidays' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.CreateHolidaysHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_holidays(self, request): + """ + The method to update holidays + + Parameters: + request (Holidays) : An instance of Holidays + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.holidays import Holidays + except Exception: + from .holidays import Holidays + + if request is not None and not isinstance(request, Holidays): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: Holidays', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays' + 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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.UpdateHolidaysHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_holiday(self, holiday_id, request): + """ + The method to update holiday + + Parameters: + holiday_id (int) : An int representing the holiday_id + request (Holidays) : An instance of Holidays + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.holidays import Holidays + except Exception: + from .holidays import Holidays + + if not isinstance(holiday_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holiday_id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, Holidays): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: Holidays', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays/' + api_path = api_path + str(holiday_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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.UpdateHolidayHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_holiday(self, holiday_id): + """ + The method to get holiday + + Parameters: + holiday_id (int) : An int representing the holiday_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(holiday_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holiday_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays/' + api_path = api_path + str(holiday_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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.GetHolidayHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.resonse_handler import ResonseHandler + except Exception: + from .resonse_handler import ResonseHandler + return handler_instance.api_call(ResonseHandler.__module__, 'application/json') + + def delete_holiday(self, holiday_id): + """ + The method to delete holiday + + Parameters: + holiday_id (int) : An int representing the holiday_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(holiday_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holiday_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays/' + api_path = api_path + str(holiday_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.DeleteHolidayHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetHolidaysHeader(object): + pass + + +class GetHolidaysParam(object): + year = Param('year', 'com.zoho.crm.api.Holidays.GetHolidaysParam') + type = Param('type', 'com.zoho.crm.api.Holidays.GetHolidaysParam') + shift_id = Param('shift_id', 'com.zoho.crm.api.Holidays.GetHolidaysParam') + + +class CreateHolidaysHeader(object): + pass + + +class UpdateHolidaysHeader(object): + pass + + +class UpdateHolidayHeader(object): + pass + + +class GetHolidayHeader(object): + pass + + +class DeleteHolidayHeader(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/resonse_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/resonse_handler.py new file mode 100644 index 0000000..8bc9286 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/resonse_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResonseHandler(ABC): + def __init__(self): + """Creates an instance of ResonseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/response_wrapper.py new file mode 100644 index 0000000..8d9706b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/response_wrapper.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.holidays.resonse_handler import ResonseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + from .resonse_handler import ResonseHandler + + +class ResponseWrapper(ResponseHandler, ResonseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__holidays = None + self.__info = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_holiday.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_holiday.py new file mode 100644 index 0000000..529dcd3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_holiday.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ShiftHoliday(object): + def __init__(self): + """Creates an instance of ShiftHoliday""" + + self.__name = None + self.__date = None + self.__type = None + self.__shift_hour = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_shift_hour(self): + """ + The method to get the shift_hour + + Returns: + ShiftHour: An instance of ShiftHour + """ + + return self.__shift_hour + + def set_shift_hour(self, shift_hour): + """ + The method to set the value to shift_hour + + Parameters: + shift_hour (ShiftHour) : An instance of ShiftHour + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.shift_hour import ShiftHour + except Exception: + from .shift_hour import ShiftHour + + if shift_hour is not None and not isinstance(shift_hour, ShiftHour): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hour EXPECTED TYPE: ShiftHour', None, None) + + self.__shift_hour = shift_hour + self.__key_modified['shift_hour'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_hour.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_hour.py new file mode 100644 index 0000000..9b67b81 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_hour.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftHour(object): + def __init__(self): + """Creates an instance of ShiftHour""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/success_response.py new file mode 100644 index 0000000..7a62e6c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/holidays/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/initializer.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/initializer.py new file mode 100755 index 0000000..9038042 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/initializer.py @@ -0,0 +1,232 @@ +""" +Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED +All rights reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +""" + +try: + import logging + import os + import json + import threading + from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.api.authenticator.token import Token + from zohocrmsdk.src.com.zoho.api.logger import Logger, SDKLogger + from zohocrmsdk.src.com.zoho.crm.api.request_proxy import RequestProxy + from zohocrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig + +except Exception: + import logging + import os + import json + import threading + from ..api.user_signature import UserSignature + from ...api.authenticator.store.token_store import TokenStore + from ..api.exception import SDKException + from ..api.dc.data_center import DataCenter + from ..api.util.constants import Constants + from ...api.authenticator.token import Token + from ...api.logger import Logger, SDKLogger + from .request_proxy import RequestProxy + from .sdk_config import SDKConfig + + +class Initializer(object): + + """ + The class to initialize Zoho CRM SDK. + """ + + def __init__(self): + self.environment = None + self.store = None + self.token = None + self.sdk_config = None + self.request_proxy = None + self.resource_path = None + + json_details = None + initializer = None + LOCAL = threading.local() + LOCAL.init = None + + @staticmethod + def initialize(environment, token, store=None, sdk_config=None, resource_path=None, logger=None, proxy=None): + + """ + The method to initialize the SDK. + + Parameters: + environment (DataCenter.Environment) : An Environment class instance containing the CRM API base URL and Accounts URL. + token (Token) : A Token class instance containing the OAuth client application information. + store (TokenStore) : A TokenStore class instance containing the token store information. + sdk_config (SDKConfig) : A SDKConfig class instance containing the configuration. + resource_path (str) : A String containing the absolute directory path to store user specific JSON files containing module fields information. + logger (Logger): A Logger class instance containing the log file path and Logger type. + proxy (RequestProxy) : A RequestProxy class instance containing the proxy properties of the user. + """ + + try: + if not isinstance(token, Token): + error = {Constants.FIELD: Constants.TOKEN, Constants.EXPECTED_TYPE: Token.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.TOKEN_ERROR_MESSAGE, details=error) + + if store is not None and not isinstance(store, TokenStore): + error = {Constants.FIELD: Constants.STORE, Constants.EXPECTED_TYPE: TokenStore.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.STORE_ERROR_MESSAGE, details=error) + + if sdk_config is not None and not isinstance(sdk_config, SDKConfig): + error = {Constants.FIELD: Constants.SDK_CONFIG, Constants.EXPECTED_TYPE: SDKConfig.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.SDK_CONFIG_ERROR_MESSAGE, details=error) + + if proxy is not None and not isinstance(proxy, RequestProxy): + error = {Constants.FIELD: Constants.USER_PROXY, Constants.EXPECTED_TYPE: RequestProxy.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.REQUEST_PROXY_ERROR_MESSAGE, details=error) + + if store is None: + try: + from zohocrmsdk.src.com.zoho.api.authenticator.store.file_store import FileStore + except Exception: + from ...api.authenticator.store.file_store import FileStore + + store = FileStore(os.path.join(os.getcwd(), Constants.TOKEN_FILE)) + + if sdk_config is None: + sdk_config = SDKConfig() + + if resource_path is None or len(resource_path) == 0: + resource_path = os.getcwd() + + if logger is None: + logger = Logger(Logger.Levels.NOTSET, None) + + SDKLogger.initialize(logger) + + if not os.path.isdir(resource_path): + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.RESOURCE_PATH_INVALID_ERROR_MESSAGE) + + try: + json_details_path = os.path.join(os.path.dirname(__file__), '..', '..', '..', '..', Constants.JSON_DETAILS_FILE_PATH) + if Initializer.json_details is None or len(Initializer.json_details) == 0: + with open(json_details_path, mode='r') as JSON: + Initializer.json_details = json.load(JSON) + except Exception as e: + raise SDKException(code=Constants.JSON_DETAILS_ERROR, cause=e) + + initializer = Initializer() + + initializer.environment = environment + initializer.store = store + initializer.sdk_config = sdk_config + initializer.resource_path = resource_path + initializer.request_proxy = proxy + Initializer.initializer = initializer + initializer.token = token + if token is not None: + token.generate_token() + initializer.token = token + Initializer.initializer = initializer + Initializer.LOCAL.init = initializer + + logging.getLogger('SDKLogger').info(Constants.INITIALIZATION_SUCCESSFUL + initializer.__str__()) + + except SDKException as e: + raise e + + def __str__(self): + return Constants.IN_ENVIRONMENT + Initializer.get_initializer().environment.url + '.' + + @staticmethod + def get_initializer(): + + """ + The method to get Initializer class instance. + + Returns: + Initializer : An instance of Initializer + """ + + if getattr(Initializer.LOCAL, 'init', None) is not None: + return getattr(Initializer.LOCAL, 'init') + + return Initializer.initializer + + @staticmethod + def get_json(file_path): + with open(file_path, mode="r") as JSON: + file_contents = json.load(JSON) + JSON.close() + + return file_contents + + @staticmethod + def switch_user(environment=None, token=None, sdk_config=None, proxy=None): + + """ + The method to switch the different user in SDK environment. + + Parameters: + environment (DataCenter.Environment) : An Environment class instance containing the CRM API base URL and Accounts URL. + token (Token) : A Token class instance containing the OAuth client application information. + sdk_config (SDKConfig) : A SDKConfig class instance containing the configuration. + proxy (RequestProxy) : A RequestProxy class instance containing the proxy properties of the user. + """ + + if Initializer.initializer is None: + raise SDKException(Constants.SDK_UNINITIALIZATION_ERROR, Constants.SDK_UNINITIALIZATION_MESSAGE) + + if environment is not None and not isinstance(environment, DataCenter.Environment): + error = {Constants.FIELD: Constants.ENVIRONMENT, + Constants.EXPECTED_TYPE: DataCenter.Environment.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.ENVIRONMENT_ERROR_MESSAGE, details=error) + + if token is not None and not isinstance(token, Token): + error = {Constants.FIELD: Constants.TOKEN, Constants.EXPECTED_TYPE: Token.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.TOKEN_ERROR_MESSAGE, details=error) + + if sdk_config is not None and not isinstance(sdk_config, SDKConfig): + error = {Constants.FIELD: Constants.SDK_CONFIG, Constants.EXPECTED_TYPE: SDKConfig.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.SDK_CONFIG_ERROR_MESSAGE, details=error) + + if proxy is not None and not isinstance(proxy, RequestProxy): + error = {Constants.FIELD: Constants.USER_PROXY, Constants.EXPECTED_TYPE: RequestProxy.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.REQUEST_PROXY_ERROR_MESSAGE, details=error) + + previous_initializer = Initializer.get_initializer() + + initializer = Initializer() + initializer.environment = previous_initializer.environment if environment is None else environment + initializer.sdk_config = previous_initializer.sdk_config if sdk_config is None else sdk_config + initializer.store = Initializer.initializer.store + initializer.resource_path = Initializer.initializer.resource_path + initializer.request_proxy = proxy + initializer.token = token + if token is not None: + token.generate_token() + initializer.token = token + Initializer.LOCAL.init = initializer + + logging.getLogger('SDKLogger').info(Constants.INITIALIZATION_SWITCHED + initializer.__str__()) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/__init__.py new file mode 100644 index 0000000..4b20384 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/__init__.py @@ -0,0 +1,6 @@ +from .inventory_converter import InventoryConverter +from .api_exception import APIException +from .success_response import SuccessResponse +from .module import Module +from .record import Record +from .convert_to import ConvertTo diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/api_exception.py new file mode 100644 index 0000000..04d05aa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/convert_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/convert_to.py new file mode 100644 index 0000000..864dabc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/convert_to.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertTo(object): + def __init__(self): + """Creates an instance of ConvertTo""" + + self.__module = None + self.__carry_over_tags = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_convert.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + bool: A bool representing the carry_over_tags + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (bool) : A bool representing the carry_over_tags + """ + + if carry_over_tags is not None and not isinstance(carry_over_tags, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: bool', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/inventory_converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/inventory_converter.py new file mode 100644 index 0000000..d95160f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/inventory_converter.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryConverter(object): + def __init__(self): + """Creates an instance of InventoryConverter""" + + self.__convert_to = None + self.__key_modified = dict() + + def get_convert_to(self): + """ + The method to get the convert_to + + Returns: + list: An instance of list + """ + + return self.__convert_to + + def set_convert_to(self, convert_to): + """ + The method to set the value to convert_to + + Parameters: + convert_to (list) : An instance of list + """ + + if convert_to is not None and not isinstance(convert_to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_to EXPECTED TYPE: list', None, None) + + self.__convert_to = convert_to + self.__key_modified['convert_to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/record.py new file mode 100644 index 0000000..54736b3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/record.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/success_response.py new file mode 100644 index 0000000..2b33f5d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/success_response.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SuccessResponse(object): + def __init__(self): + """Creates an instance of SuccessResponse""" + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/__init__.py new file mode 100644 index 0000000..6ad0723 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/__init__.py @@ -0,0 +1,7 @@ +from .api_exception import APIException +from .success_response import SuccessResponse +from .module import Module +from .related_modules import RelatedModules +from .body_wrapper import BodyWrapper +from .user import User +from .convert_to import ConvertTo diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/api_exception.py new file mode 100644 index 0000000..04d05aa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/body_wrapper.py new file mode 100644 index 0000000..b6a1ec9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/body_wrapper.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__convert_to = None + self.__assign_to = None + self.__related_modules = None + self.__ids = None + self.__key_modified = dict() + + def get_convert_to(self): + """ + The method to get the convert_to + + Returns: + list: An instance of list + """ + + return self.__convert_to + + def set_convert_to(self, convert_to): + """ + The method to set the value to convert_to + + Parameters: + convert_to (list) : An instance of list + """ + + if convert_to is not None and not isinstance(convert_to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_to EXPECTED TYPE: list', None, None) + + self.__convert_to = convert_to + self.__key_modified['convert_to'] = 1 + + def get_assign_to(self): + """ + The method to get the assign_to + + Returns: + User: An instance of User + """ + + return self.__assign_to + + def set_assign_to(self, assign_to): + """ + The method to set the value to assign_to + + Parameters: + assign_to (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.user import User + except Exception: + from .user import User + + if assign_to is not None and not isinstance(assign_to, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assign_to EXPECTED TYPE: User', None, None) + + self.__assign_to = assign_to + self.__key_modified['assign_to'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/convert_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/convert_to.py new file mode 100644 index 0000000..9135f6d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/convert_to.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertTo(object): + def __init__(self): + """Creates an instance of ConvertTo""" + + self.__module = None + self.__carry_over_tags = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + bool: A bool representing the carry_over_tags + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (bool) : A bool representing the carry_over_tags + """ + + if carry_over_tags is not None and not isinstance(carry_over_tags, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: bool', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/related_modules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/related_modules.py new file mode 100644 index 0000000..34c71ee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/related_modules.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedModules(object): + def __init__(self): + """Creates an instance of RelatedModules""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/success_response.py new file mode 100644 index 0000000..2b33f5d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/success_response.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SuccessResponse(object): + def __init__(self): + """Creates an instance of SuccessResponse""" + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/user.py new file mode 100644 index 0000000..b868d16 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/__init__.py new file mode 100644 index 0000000..17c4582 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/__init__.py @@ -0,0 +1,9 @@ +from .api_exception import APIException +from .inventory_templates import InventoryTemplates +from .response_handler import ResponseHandler +from .folder import Folder +from .inventory_templates_operations import InventoryTemplatesOperations, GetInventoryTemplatesParam +from .response_wrapper import ResponseWrapper +from .user import User +from .module_map import ModuleMap +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/api_exception.py new file mode 100644 index 0000000..83f0b23 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/folder.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/folder.py new file mode 100644 index 0000000..03de6e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/folder.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Folder(object): + def __init__(self): + """Creates an instance of Folder""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates.py new file mode 100644 index 0000000..ba98b73 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates.py @@ -0,0 +1,453 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail import Template +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..send_mail import Template + + +class InventoryTemplates(Template): + def __init__(self): + """Creates an instance of InventoryTemplates""" + super().__init__() + + self.__created_time = None + self.__modified_time = None + self.__last_usage_time = None + self.__folder = None + self.__module = None + self.__created_by = None + self.__modified_by = None + self.__name = None + self.__id = None + self.__editor_mode = None + self.__category = None + self.__favorite = None + self.__content = None + self.__active = None + self.__mail_content = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_last_usage_time(self): + """ + The method to get the last_usage_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_usage_time + + def set_last_usage_time(self, last_usage_time): + """ + The method to set the value to last_usage_time + + Parameters: + last_usage_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_usage_time is not None and not isinstance(last_usage_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_usage_time EXPECTED TYPE: datetime', None, None) + + self.__last_usage_time = last_usage_time + self.__key_modified['last_usage_time'] = 1 + + def get_folder(self): + """ + The method to get the folder + + Returns: + Folder: An instance of Folder + """ + + return self.__folder + + def set_folder(self, folder): + """ + The method to set the value to folder + + Parameters: + folder (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.folder import Folder + except Exception: + from .folder import Folder + + if folder is not None and not isinstance(folder, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: Folder', None, None) + + self.__folder = folder + self.__key_modified['folder'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_editor_mode(self): + """ + The method to get the editor_mode + + Returns: + string: A string representing the editor_mode + """ + + return self.__editor_mode + + def set_editor_mode(self, editor_mode): + """ + The method to set the value to editor_mode + + Parameters: + editor_mode (string) : A string representing the editor_mode + """ + + if editor_mode is not None and not isinstance(editor_mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editor_mode EXPECTED TYPE: str', None, None) + + self.__editor_mode = editor_mode + self.__key_modified['editor_mode'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_favorite(self): + """ + The method to get the favorite + + Returns: + bool: A bool representing the favorite + """ + + return self.__favorite + + def set_favorite(self, favorite): + """ + The method to set the value to favorite + + Parameters: + favorite (bool) : A bool representing the favorite + """ + + if favorite is not None and not isinstance(favorite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: bool', None, None) + + self.__favorite = favorite + self.__key_modified['favorite'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_mail_content(self): + """ + The method to get the mail_content + + Returns: + string: A string representing the mail_content + """ + + return self.__mail_content + + def set_mail_content(self, mail_content): + """ + The method to set the value to mail_content + + Parameters: + mail_content (string) : A string representing the mail_content + """ + + if mail_content is not None and not isinstance(mail_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_content EXPECTED TYPE: str', None, None) + + self.__mail_content = mail_content + self.__key_modified['mail_content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.py new file mode 100644 index 0000000..7a10ef6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.py @@ -0,0 +1,86 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class InventoryTemplatesOperations(object): + def __init__(self): + """Creates an instance of InventoryTemplatesOperations""" + pass + + 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 + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/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.set_param(param_instance) + try: + from zohocrmsdk.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_inventory_template(self, template): + """ + The method to get inventory template + + Parameters: + template (int) : An int representing the template + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(template, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/inventory_templates/' + api_path = api_path + str(template) + 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) + try: + from zohocrmsdk.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') + + +class GetInventoryTemplatesParam(object): + module = Param('module', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') + category = Param('category', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/module_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/module_map.py new file mode 100644 index 0000000..cec4563 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/module_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleMap(object): + def __init__(self): + """Creates an instance of ModuleMap""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_wrapper.py new file mode 100644 index 0000000..e8d7358 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__inventory_templates = None + self.__info = None + self.__key_modified = dict() + + def get_inventory_templates(self): + """ + The method to get the inventory_templates + + Returns: + list: An instance of list + """ + + return self.__inventory_templates + + def set_inventory_templates(self, inventory_templates): + """ + The method to set the value to inventory_templates + + Parameters: + inventory_templates (list) : An instance of list + """ + + if inventory_templates is not None and not isinstance(inventory_templates, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_templates EXPECTED TYPE: list', None, None) + + self.__inventory_templates = inventory_templates + self.__key_modified['inventory_templates'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/isc_signature/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/isc_signature/__init__.py new file mode 100644 index 0000000..fac9820 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/isc_signature/__init__.py @@ -0,0 +1 @@ +from .signature import Signature diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/isc_signature/signature.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/isc_signature/signature.py new file mode 100644 index 0000000..6dd6b47 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/isc_signature/signature.py @@ -0,0 +1,71 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Signature(object): + def __init__(self): + """Creates an instance of Signature""" + + self.__isc_signature = None + self.__key_modified = dict() + + def get_isc_signature(self): + """ + The method to get the isc_signature + + Returns: + Object: A Object representing the isc_signature + """ + + return self.__isc_signature + + def set_isc_signature(self, isc_signature): + """ + The method to set the value to isc_signature + + Parameters: + isc_signature (Object) : A Object representing the isc_signature + """ + + self.__isc_signature = isc_signature + self.__key_modified['isc_signature'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/__init__.py new file mode 100644 index 0000000..baf727f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/__init__.py @@ -0,0 +1,24 @@ +from .action_wrapper import ActionWrapper +from .convert_mapping import ConvertMapping +from .layouts_operations import LayoutsOperations, GetLayoutsParam, GetLayoutsHeader, GetLayoutParam, GetLayoutHeader +from .tooltip import Tooltip +from .profiles import Profiles +from .section_subform_field import SectionSubformField +from .deal_field import DealField +from .body_wrapper import BodyWrapper +from .layouts import Layouts +from .sections import Sections +from .subform_property import SubformProperty +from .actions_allowed import ActionsAllowed +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .static_values import StaticValues +from .section_field import SectionField +from .response_wrapper import ResponseWrapper +from .deal_layout_mapping import DealLayoutMapping +from .minified_layout import MinifiedLayout +from .default_view import DefaultView +from .properties import Properties +from .default_assignment_view import DefaultAssignmentView diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/action_wrapper.py new file mode 100644 index 0000000..9cf6e92 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__layouts = None + self.__key_modified = dict() + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/actions_allowed.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/actions_allowed.py new file mode 100644 index 0000000..1a1024e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/actions_allowed.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionsAllowed(object): + def __init__(self): + """Creates an instance of ActionsAllowed""" + + self.__edit = None + self.__rename = None + self.__clone = None + self.__downgrade = None + self.__delete = None + self.__deactivate = None + self.__set_layout_permissions = None + self.__key_modified = dict() + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_rename(self): + """ + The method to get the rename + + Returns: + bool: A bool representing the rename + """ + + return self.__rename + + def set_rename(self, rename): + """ + The method to set the value to rename + + Parameters: + rename (bool) : A bool representing the rename + """ + + if rename is not None and not isinstance(rename, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rename EXPECTED TYPE: bool', None, None) + + self.__rename = rename + self.__key_modified['rename'] = 1 + + def get_clone(self): + """ + The method to get the clone + + Returns: + bool: A bool representing the clone + """ + + return self.__clone + + def set_clone(self, clone): + """ + The method to set the value to clone + + Parameters: + clone (bool) : A bool representing the clone + """ + + if clone is not None and not isinstance(clone, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: clone EXPECTED TYPE: bool', None, None) + + self.__clone = clone + self.__key_modified['clone'] = 1 + + def get_downgrade(self): + """ + The method to get the downgrade + + Returns: + bool: A bool representing the downgrade + """ + + return self.__downgrade + + def set_downgrade(self, downgrade): + """ + The method to set the value to downgrade + + Parameters: + downgrade (bool) : A bool representing the downgrade + """ + + if downgrade is not None and not isinstance(downgrade, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: downgrade EXPECTED TYPE: bool', None, None) + + self.__downgrade = downgrade + self.__key_modified['downgrade'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['delete'] = 1 + + def get_deactivate(self): + """ + The method to get the deactivate + + Returns: + bool: A bool representing the deactivate + """ + + return self.__deactivate + + def set_deactivate(self, deactivate): + """ + The method to set the value to deactivate + + Parameters: + deactivate (bool) : A bool representing the deactivate + """ + + if deactivate is not None and not isinstance(deactivate, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deactivate EXPECTED TYPE: bool', None, None) + + self.__deactivate = deactivate + self.__key_modified['deactivate'] = 1 + + def get_set_layout_permissions(self): + """ + The method to get the set_layout_permissions + + Returns: + bool: A bool representing the set_layout_permissions + """ + + return self.__set_layout_permissions + + def set_set_layout_permissions(self, set_layout_permissions): + """ + The method to set the value to set_layout_permissions + + Parameters: + set_layout_permissions (bool) : A bool representing the set_layout_permissions + """ + + if set_layout_permissions is not None and not isinstance(set_layout_permissions, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: set_layout_permissions EXPECTED TYPE: bool', None, None) + + self.__set_layout_permissions = set_layout_permissions + self.__key_modified['set_layout_permissions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/api_exception.py new file mode 100644 index 0000000..229019b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/body_wrapper.py new file mode 100644 index 0000000..5a896a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__layouts = None + self.__key_modified = dict() + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/convert_mapping.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/convert_mapping.py new file mode 100644 index 0000000..7235dbd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/convert_mapping.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertMapping(object): + def __init__(self): + """Creates an instance of ConvertMapping""" + + self.__contacts = None + self.__deals = None + self.__accounts = None + self.__invoices = None + self.__salesorders = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if contacts is not None and not isinstance(contacts, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: MinifiedLayout', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + DealLayoutMapping: An instance of DealLayoutMapping + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (DealLayoutMapping) : An instance of DealLayoutMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.deal_layout_mapping import DealLayoutMapping + except Exception: + from .deal_layout_mapping import DealLayoutMapping + + if deals is not None and not isinstance(deals, DealLayoutMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: DealLayoutMapping', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if accounts is not None and not isinstance(accounts, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: MinifiedLayout', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_invoices(self): + """ + The method to get the invoices + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__invoices + + def set_invoices(self, invoices): + """ + The method to set the value to invoices + + Parameters: + invoices (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if invoices is not None and not isinstance(invoices, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: invoices EXPECTED TYPE: MinifiedLayout', None, None) + + self.__invoices = invoices + self.__key_modified['Invoices'] = 1 + + def get_salesorders(self): + """ + The method to get the salesorders + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__salesorders + + def set_salesorders(self, salesorders): + """ + The method to set the value to salesorders + + Parameters: + salesorders (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if salesorders is not None and not isinstance(salesorders, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: salesorders EXPECTED TYPE: MinifiedLayout', None, None) + + self.__salesorders = salesorders + self.__key_modified['SalesOrders'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_field.py new file mode 100644 index 0000000..a0dbbda --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_field.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DealField(object): + def __init__(self): + """Creates an instance of DealField""" + + self.__api_name = None + self.__field_label = None + self.__id = None + self.__required = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_layout_mapping.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_layout_mapping.py new file mode 100644 index 0000000..3a3a62b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_layout_mapping.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout +except Exception: + from ..exception import SDKException + from ..util import Constants + from .minified_layout import MinifiedLayout + + +class DealLayoutMapping(MinifiedLayout): + def __init__(self): + """Creates an instance of DealLayoutMapping""" + super().__init__() + + self.__fields = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/default_assignment_view.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/default_assignment_view.py new file mode 100644 index 0000000..6c71818 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/default_assignment_view.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultAssignmentView(object): + def __init__(self): + """Creates an instance of DefaultAssignmentView""" + + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/default_view.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/default_view.py new file mode 100644 index 0000000..49e724a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/default_view.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultView(object): + def __init__(self): + """Creates an instance of DefaultView""" + + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts.py new file mode 100644 index 0000000..e1a1a3d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts.py @@ -0,0 +1,633 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layouts(object): + def __init__(self): + """Creates an instance of Layouts""" + + self.__display_type = None + self.__api_name = None + self.__has_more_profiles = None + self.__created_time = None + self.__modified_time = None + self.__visible = None + self.__source = None + self.__id = None + self.__name = None + self.__display_label = None + self.__mode = None + self.__subform_properties = None + self.__status = None + self.__show_business_card = None + self.__generated_type = None + self.__created_for = None + self.__convert_mapping = None + self.__modified_by = None + self.__profiles = None + self.__created_by = None + self.__sections = None + self.__actions_allowed = None + self.__key_modified = dict() + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_has_more_profiles(self): + """ + The method to get the has_more_profiles + + Returns: + bool: A bool representing the has_more_profiles + """ + + return self.__has_more_profiles + + def set_has_more_profiles(self, has_more_profiles): + """ + The method to set the value to has_more_profiles + + Parameters: + has_more_profiles (bool) : A bool representing the has_more_profiles + """ + + if has_more_profiles is not None and not isinstance(has_more_profiles, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_more_profiles EXPECTED TYPE: bool', None, None) + + self.__has_more_profiles = has_more_profiles + self.__key_modified['has_more_profiles'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_mode(self): + """ + The method to get the mode + + Returns: + string: A string representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (string) : A string representing the mode + """ + + if mode is not None and not isinstance(mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: str', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_subform_properties(self): + """ + The method to get the subform_properties + + Returns: + SubformProperty: An instance of SubformProperty + """ + + return self.__subform_properties + + def set_subform_properties(self, subform_properties): + """ + The method to set the value to subform_properties + + Parameters: + subform_properties (SubformProperty) : An instance of SubformProperty + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.subform_property import SubformProperty + except Exception: + from .subform_property import SubformProperty + + if subform_properties is not None and not isinstance(subform_properties, SubformProperty): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform_properties EXPECTED TYPE: SubformProperty', None, None) + + self.__subform_properties = subform_properties + self.__key_modified['subform_properties'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_show_business_card(self): + """ + The method to get the show_business_card + + Returns: + bool: A bool representing the show_business_card + """ + + return self.__show_business_card + + def set_show_business_card(self, show_business_card): + """ + The method to set the value to show_business_card + + Parameters: + show_business_card (bool) : A bool representing the show_business_card + """ + + if show_business_card is not None and not isinstance(show_business_card, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_business_card EXPECTED TYPE: bool', None, None) + + self.__show_business_card = show_business_card + self.__key_modified['show_business_card'] = 1 + + def get_generated_type(self): + """ + The method to get the generated_type + + Returns: + string: A string representing the generated_type + """ + + return self.__generated_type + + def set_generated_type(self, generated_type): + """ + The method to set the value to generated_type + + Parameters: + generated_type (string) : A string representing the generated_type + """ + + if generated_type is not None and not isinstance(generated_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: str', None, None) + + self.__generated_type = generated_type + self.__key_modified['generated_type'] = 1 + + def get_created_for(self): + """ + The method to get the created_for + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_for + + def set_created_for(self, created_for): + """ + The method to set the value to created_for + + Parameters: + created_for (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_for is not None and not isinstance(created_for, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_for EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_for = created_for + self.__key_modified['created_for'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.convert_mapping import ConvertMapping + except Exception: + from .convert_mapping import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_sections(self): + """ + The method to get the sections + + Returns: + list: An instance of list + """ + + return self.__sections + + def set_sections(self, sections): + """ + The method to set the value to sections + + Parameters: + sections (list) : An instance of list + """ + + if sections is not None and not isinstance(sections, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: list', None, None) + + self.__sections = sections + self.__key_modified['sections'] = 1 + + def get_actions_allowed(self): + """ + The method to get the actions_allowed + + Returns: + ActionsAllowed: An instance of ActionsAllowed + """ + + return self.__actions_allowed + + def set_actions_allowed(self, actions_allowed): + """ + The method to set the value to actions_allowed + + Parameters: + actions_allowed (ActionsAllowed) : An instance of ActionsAllowed + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.actions_allowed import ActionsAllowed + except Exception: + from .actions_allowed import ActionsAllowed + + if actions_allowed is not None and not isinstance(actions_allowed, ActionsAllowed): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actions_allowed EXPECTED TYPE: ActionsAllowed', None, None) + + self.__actions_allowed = actions_allowed + self.__key_modified['actions_allowed'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts_operations.py new file mode 100644 index 0000000..ba76055 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts_operations.py @@ -0,0 +1,105 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class LayoutsOperations(object): + def __init__(self): + """Creates an instance of LayoutsOperations""" + pass + + def get_layouts(self, param_instance=None): + """ + The method to get layouts + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/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.set_param(param_instance) + try: + from zohocrmsdk.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_layout(self, id, param_instance=None): + """ + The method to get layout + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/layouts/' + 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.set_param(param_instance) + try: + from zohocrmsdk.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') + + +class GetLayoutsParam(object): + module = Param('module', 'com.zoho.crm.api.Layouts.GetLayoutsParam') + + +class GetLayoutsHeader(object): + pass + + +class GetLayoutParam(object): + module = Param('module', 'com.zoho.crm.api.Layouts.GetLayoutParam') + + +class GetLayoutHeader(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/minified_layout.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/minified_layout.py new file mode 100644 index 0000000..500963c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/minified_layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedLayout(object): + def __init__(self): + """Creates an instance of MinifiedLayout""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/profiles.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/profiles.py new file mode 100644 index 0000000..87edd0e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/profiles.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profiles(object): + def __init__(self): + """Creates an instance of Profiles""" + + self.__default = None + self.__name = None + self.__id = None + self.__defaultview = None + self.__defaultassignmentview = None + self.__key_modified = dict() + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_defaultview(self): + """ + The method to get the defaultview + + Returns: + DefaultView: An instance of DefaultView + """ + + return self.__defaultview + + def set_defaultview(self, defaultview): + """ + The method to set the value to defaultview + + Parameters: + defaultview (DefaultView) : An instance of DefaultView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.default_view import DefaultView + except Exception: + from .default_view import DefaultView + + if defaultview is not None and not isinstance(defaultview, DefaultView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', None, None) + + self.__defaultview = defaultview + self.__key_modified['_default_view'] = 1 + + def get_defaultassignmentview(self): + """ + The method to get the defaultassignmentview + + Returns: + DefaultAssignmentView: An instance of DefaultAssignmentView + """ + + return self.__defaultassignmentview + + def set_defaultassignmentview(self, defaultassignmentview): + """ + The method to set the value to defaultassignmentview + + Parameters: + defaultassignmentview (DefaultAssignmentView) : An instance of DefaultAssignmentView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.default_assignment_view import DefaultAssignmentView + except Exception: + from .default_assignment_view import DefaultAssignmentView + + if defaultassignmentview is not None and not isinstance(defaultassignmentview, DefaultAssignmentView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultassignmentview EXPECTED TYPE: DefaultAssignmentView', None, None) + + self.__defaultassignmentview = defaultassignmentview + self.__key_modified['_default_assignment_view'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/properties.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/properties.py new file mode 100644 index 0000000..a00dafe --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/properties.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Properties(object): + def __init__(self): + """Creates an instance of Properties""" + + self.__reorder_rows = None + self.__maximum_rows = None + self.__tooltip = None + self.__key_modified = dict() + + def get_reorder_rows(self): + """ + The method to get the reorder_rows + + Returns: + bool: A bool representing the reorder_rows + """ + + return self.__reorder_rows + + def set_reorder_rows(self, reorder_rows): + """ + The method to set the value to reorder_rows + + Parameters: + reorder_rows (bool) : A bool representing the reorder_rows + """ + + if reorder_rows is not None and not isinstance(reorder_rows, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reorder_rows EXPECTED TYPE: bool', None, None) + + self.__reorder_rows = reorder_rows + self.__key_modified['reorder_rows'] = 1 + + def get_maximum_rows(self): + """ + The method to get the maximum_rows + + Returns: + int: An int representing the maximum_rows + """ + + return self.__maximum_rows + + def set_maximum_rows(self, maximum_rows): + """ + The method to set the value to maximum_rows + + Parameters: + maximum_rows (int) : An int representing the maximum_rows + """ + + if maximum_rows is not None and not isinstance(maximum_rows, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maximum_rows EXPECTED TYPE: int', None, None) + + self.__maximum_rows = maximum_rows + self.__key_modified['maximum_rows'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.tooltip import Tooltip + except Exception: + from .tooltip import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/response_wrapper.py new file mode 100644 index 0000000..3d0cdac --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__layouts = None + self.__key_modified = dict() + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/section_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/section_field.py new file mode 100644 index 0000000..c242ac2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/section_field.py @@ -0,0 +1,2238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import Fields + + +class SectionField(Fields): + def __init__(self): + """Creates an instance of SectionField""" + super().__init__() + + self.__required = None + self.__validation_rule = None + self.__default_value = None + self.__sequence_number = None + self.__section_id = None + self.__blueprint_supported = None + self.__json_type = None + self.__length = None + self.__decimal_place = None + self.__multi_module_lookup = None + self.__sharing_properties = None + self.__currency = None + self.__file_upolad_optionlist = None + self.__lookup = None + self.__subform = None + self.__formula = None + self.__multiselectlookup = None + self.__multiuserlookup = None + self.__pick_list_values = None + self.__allowed_modules = None + self.__hipaa_compliance_enabled = None + self.__hipaa_compliance = None + self.__static_values = None + self.__static_field = None + self.__layout_associations = None + self.__associated_module = None + self.__data_type = None + self.__operation_type = None + self.__system_mandatory = None + self.__webhook = None + self.__virtual_field = None + self.__field_read_only = None + self.__customizable_properties = None + self.__read_only = None + self.__custom_field = None + self.__businesscard_supported = None + self.__filterable = None + self.__visible = None + self.__available_in_user_layout = None + self.__display_field = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__separator = None + self.__searchable = None + self.__enable_colour_code = None + self.__mass_update = None + self.__created_source = None + self.__type = None + self.__display_label = None + self.__column_name = None + self.__api_name = None + self.__display_type = None + self.__ui_type = None + self.__colour_code_enabled_by_system = None + self.__quick_sequence_number = None + self.__email_parser = None + self.__rollup_summary = None + self.__refer_from_field = None + self.__created_time = None + self.__modified_time = None + self.__show_type = None + self.__category = None + self.__id = None + self.__profiles = None + self.__view_type = None + self.__unique = None + self.__sub_module = None + self.__external = None + self.__private = None + self.__convert_mapping = None + self.__autonumber = None + self.__auto_number_70 = None + self.__crypt = None + self.__tooltip = None + self.__history_tracking = None + self.__association_details = None + self.__additional_column = None + self.__field_label = None + self.__global_picklist = None + self.__updateexistingrecords = None + self.__number_separator = None + self.__textarea = None + self.__key_modified = dict() + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_validation_rule(self): + """ + The method to get the validation_rule + + Returns: + dict: An instance of dict + """ + + return self.__validation_rule + + def set_validation_rule(self, validation_rule): + """ + The method to set the value to validation_rule + + Parameters: + validation_rule (dict) : An instance of dict + """ + + if validation_rule is not None and not isinstance(validation_rule, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: dict', None, None) + + self.__validation_rule = validation_rule + self.__key_modified['validation_rule'] = 1 + + def get_default_value(self): + """ + The method to get the default_value + + Returns: + string: A string representing the default_value + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (string) : A string representing the default_value + """ + + if default_value is not None and not isinstance(default_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: str', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_section_id(self): + """ + The method to get the section_id + + Returns: + int: An int representing the section_id + """ + + return self.__section_id + + def set_section_id(self, section_id): + """ + The method to set the value to section_id + + Parameters: + section_id (int) : An int representing the section_id + """ + + if section_id is not None and not isinstance(section_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: section_id EXPECTED TYPE: int', None, None) + + self.__section_id = section_id + self.__key_modified['section_id'] = 1 + + def get_blueprint_supported(self): + """ + The method to get the blueprint_supported + + Returns: + bool: A bool representing the blueprint_supported + """ + + return self.__blueprint_supported + + def set_blueprint_supported(self, blueprint_supported): + """ + The method to set the value to blueprint_supported + + Parameters: + blueprint_supported (bool) : A bool representing the blueprint_supported + """ + + if blueprint_supported is not None and not isinstance(blueprint_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: bool', None, None) + + self.__blueprint_supported = blueprint_supported + self.__key_modified['blueprint_supported'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + int: An int representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (int) : An int representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: int', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MultiModuleLookup + except Exception: + from ..fields import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_sharing_properties(self): + """ + The method to get the sharing_properties + + Returns: + SharingProperties: An instance of SharingProperties + """ + + return self.__sharing_properties + + def set_sharing_properties(self, sharing_properties): + """ + The method to set the value to sharing_properties + + Parameters: + sharing_properties (SharingProperties) : An instance of SharingProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import SharingProperties + except Exception: + from ..modules import SharingProperties + + if sharing_properties is not None and not isinstance(sharing_properties, SharingProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_properties EXPECTED TYPE: SharingProperties', None, None) + + self.__sharing_properties = sharing_properties + self.__key_modified['sharing_properties'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Currency + except Exception: + from ..fields import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_file_upolad_optionlist(self): + """ + The method to get the file_upolad_optionlist + + Returns: + list: An instance of list + """ + + return self.__file_upolad_optionlist + + def set_file_upolad_optionlist(self, file_upolad_optionlist): + """ + The method to set the value to file_upolad_optionlist + + Parameters: + file_upolad_optionlist (list) : An instance of list + """ + + if file_upolad_optionlist is not None and not isinstance(file_upolad_optionlist, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_upolad_optionlist EXPECTED TYPE: list', None, None) + + self.__file_upolad_optionlist = file_upolad_optionlist + self.__key_modified['file_upolad_optionlist'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Lookup: An instance of Lookup + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Lookup) : An instance of Lookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Lookup + except Exception: + from ..fields import Lookup + + if lookup is not None and not isinstance(lookup, Lookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Lookup', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_subform(self): + """ + The method to get the subform + + Returns: + Subform: An instance of Subform + """ + + return self.__subform + + def set_subform(self, subform): + """ + The method to set the value to subform + + Parameters: + subform (Subform) : An instance of Subform + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Subform + except Exception: + from ..fields import Subform + + if subform is not None and not isinstance(subform, Subform): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Subform', None, None) + + self.__subform = subform + self.__key_modified['subform'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Formula + except Exception: + from ..fields import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_multiuserlookup(self): + """ + The method to get the multiuserlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiuserlookup + + def set_multiuserlookup(self, multiuserlookup): + """ + The method to set the value to multiuserlookup + + Parameters: + multiuserlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiuserlookup is not None and not isinstance(multiuserlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiuserlookup = multiuserlookup + self.__key_modified['multiuserlookup'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_allowed_modules(self): + """ + The method to get the allowed_modules + + Returns: + list: An instance of list + """ + + return self.__allowed_modules + + def set_allowed_modules(self, allowed_modules): + """ + The method to set the value to allowed_modules + + Parameters: + allowed_modules (list) : An instance of list + """ + + if allowed_modules is not None and not isinstance(allowed_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_modules EXPECTED TYPE: list', None, None) + + self.__allowed_modules = allowed_modules + self.__key_modified['allowed_modules'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HipaaCompliance + except Exception: + from ..fields import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def get_static_values(self): + """ + The method to get the static_values + + Returns: + list: An instance of list + """ + + return self.__static_values + + def set_static_values(self, static_values): + """ + The method to set the value to static_values + + Parameters: + static_values (list) : An instance of list + """ + + if static_values is not None and not isinstance(static_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_values EXPECTED TYPE: list', None, None) + + self.__static_values = static_values + self.__key_modified['static_values'] = 1 + + def get_static_field(self): + """ + The method to get the static_field + + Returns: + bool: A bool representing the static_field + """ + + return self.__static_field + + def set_static_field(self, static_field): + """ + The method to set the value to static_field + + Parameters: + static_field (bool) : A bool representing the static_field + """ + + if static_field is not None and not isinstance(static_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_field EXPECTED TYPE: bool', None, None) + + self.__static_field = static_field + self.__key_modified['static_field'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def get_associated_module(self): + """ + The method to get the associated_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__associated_module + + def set_associated_module(self, associated_module): + """ + The method to set the value to associated_module + + Parameters: + associated_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if associated_module is not None and not isinstance(associated_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__associated_module = associated_module + self.__key_modified['associated_module'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_operation_type(self): + """ + The method to get the operation_type + + Returns: + OperationType: An instance of OperationType + """ + + return self.__operation_type + + def set_operation_type(self, operation_type): + """ + The method to set the value to operation_type + + Parameters: + operation_type (OperationType) : An instance of OperationType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import OperationType + except Exception: + from ..fields import OperationType + + if operation_type is not None and not isinstance(operation_type, OperationType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_type EXPECTED TYPE: OperationType', None, None) + + self.__operation_type = operation_type + self.__key_modified['operation_type'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_virtual_field(self): + """ + The method to get the virtual_field + + Returns: + bool: A bool representing the virtual_field + """ + + return self.__virtual_field + + def set_virtual_field(self, virtual_field): + """ + The method to set the value to virtual_field + + Parameters: + virtual_field (bool) : A bool representing the virtual_field + """ + + if virtual_field is not None and not isinstance(virtual_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: virtual_field EXPECTED TYPE: bool', None, None) + + self.__virtual_field = virtual_field + self.__key_modified['virtual_field'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_customizable_properties(self): + """ + The method to get the customizable_properties + + Returns: + list: An instance of list + """ + + return self.__customizable_properties + + def set_customizable_properties(self, customizable_properties): + """ + The method to set the value to customizable_properties + + Parameters: + customizable_properties (list) : An instance of list + """ + + if customizable_properties is not None and not isinstance(customizable_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable_properties EXPECTED TYPE: list', None, None) + + self.__customizable_properties = customizable_properties + self.__key_modified['customizable_properties'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_businesscard_supported(self): + """ + The method to get the businesscard_supported + + Returns: + bool: A bool representing the businesscard_supported + """ + + return self.__businesscard_supported + + def set_businesscard_supported(self, businesscard_supported): + """ + The method to set the value to businesscard_supported + + Parameters: + businesscard_supported (bool) : A bool representing the businesscard_supported + """ + + if businesscard_supported is not None and not isinstance(businesscard_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: bool', None, None) + + self.__businesscard_supported = businesscard_supported + self.__key_modified['businesscard_supported'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + bool: A bool representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (bool) : A bool representing the display_field + """ + + if display_field is not None and not isinstance(display_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: bool', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_separator(self): + """ + The method to get the separator + + Returns: + bool: A bool representing the separator + """ + + return self.__separator + + def set_separator(self, separator): + """ + The method to set the value to separator + + Parameters: + separator (bool) : A bool representing the separator + """ + + if separator is not None and not isinstance(separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: separator EXPECTED TYPE: bool', None, None) + + self.__separator = separator + self.__key_modified['separator'] = 1 + + def get_searchable(self): + """ + The method to get the searchable + + Returns: + bool: A bool representing the searchable + """ + + return self.__searchable + + def set_searchable(self, searchable): + """ + The method to set the value to searchable + + Parameters: + searchable (bool) : A bool representing the searchable + """ + + if searchable is not None and not isinstance(searchable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: searchable EXPECTED TYPE: bool', None, None) + + self.__searchable = searchable + self.__key_modified['searchable'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_mass_update(self): + """ + The method to get the mass_update + + Returns: + bool: A bool representing the mass_update + """ + + return self.__mass_update + + def set_mass_update(self, mass_update): + """ + The method to set the value to mass_update + + Parameters: + mass_update (bool) : A bool representing the mass_update + """ + + if mass_update is not None and not isinstance(mass_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: bool', None, None) + + self.__mass_update = mass_update + self.__key_modified['mass_update'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_colour_code_enabled_by_system(self): + """ + The method to get the colour_code_enabled_by_system + + Returns: + bool: A bool representing the colour_code_enabled_by_system + """ + + return self.__colour_code_enabled_by_system + + def set_colour_code_enabled_by_system(self, colour_code_enabled_by_system): + """ + The method to set the value to colour_code_enabled_by_system + + Parameters: + colour_code_enabled_by_system (bool) : A bool representing the colour_code_enabled_by_system + """ + + if colour_code_enabled_by_system is not None and not isinstance(colour_code_enabled_by_system, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code_enabled_by_system EXPECTED TYPE: bool', None, None) + + self.__colour_code_enabled_by_system = colour_code_enabled_by_system + self.__key_modified['colour_code_enabled_by_system'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + string: A string representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (string) : A string representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: str', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_email_parser(self): + """ + The method to get the email_parser + + Returns: + EmailParser: An instance of EmailParser + """ + + return self.__email_parser + + def set_email_parser(self, email_parser): + """ + The method to set the value to email_parser + + Parameters: + email_parser (EmailParser) : An instance of EmailParser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import EmailParser + except Exception: + from ..fields import EmailParser + + if email_parser is not None and not isinstance(email_parser, EmailParser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser EXPECTED TYPE: EmailParser', None, None) + + self.__email_parser = email_parser + self.__key_modified['email_parser'] = 1 + + def get_rollup_summary(self): + """ + The method to get the rollup_summary + + Returns: + RollupSummary: An instance of RollupSummary + """ + + return self.__rollup_summary + + def set_rollup_summary(self, rollup_summary): + """ + The method to set the value to rollup_summary + + Parameters: + rollup_summary (RollupSummary) : An instance of RollupSummary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import RollupSummary + except Exception: + from ..fields import RollupSummary + + if rollup_summary is not None and not isinstance(rollup_summary, RollupSummary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_summary EXPECTED TYPE: RollupSummary', None, None) + + self.__rollup_summary = rollup_summary + self.__key_modified['rollup_summary'] = 1 + + def get_refer_from_field(self): + """ + The method to get the refer_from_field + + Returns: + ReferFromField: An instance of ReferFromField + """ + + return self.__refer_from_field + + def set_refer_from_field(self, refer_from_field): + """ + The method to set the value to refer_from_field + + Parameters: + refer_from_field (ReferFromField) : An instance of ReferFromField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ReferFromField + except Exception: + from ..fields import ReferFromField + + if refer_from_field is not None and not isinstance(refer_from_field, ReferFromField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: refer_from_field EXPECTED TYPE: ReferFromField', None, None) + + self.__refer_from_field = refer_from_field + self.__key_modified['refer_from_field'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_show_type(self): + """ + The method to get the show_type + + Returns: + int: An int representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (int) : An int representing the show_type + """ + + if show_type is not None and not isinstance(show_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: int', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ViewType + except Exception: + from ..fields import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Unique + except Exception: + from ..fields import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if sub_module is not None and not isinstance(sub_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import External + except Exception: + from ..fields import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Private + except Exception: + from ..fields import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ConvertMapping + except Exception: + from ..fields import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_autonumber(self): + """ + The method to get the autonumber + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__autonumber + + def set_autonumber(self, autonumber): + """ + The method to set the value to autonumber + + Parameters: + autonumber (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if autonumber is not None and not isinstance(autonumber, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: autonumber EXPECTED TYPE: AutoNumber', None, None) + + self.__autonumber = autonumber + self.__key_modified['autonumber'] = 1 + + def get_auto_number_70(self): + """ + The method to get the auto_number_70 + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number_70 + + def set_auto_number_70(self, auto_number_70): + """ + The method to set the value to auto_number_70 + + Parameters: + auto_number_70 (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if auto_number_70 is not None and not isinstance(auto_number_70, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number_70 EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number_70 = auto_number_70 + self.__key_modified['auto_number'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Crypt + except Exception: + from ..fields import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Tooltip + except Exception: + from ..fields import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + HistoryTracking: An instance of HistoryTracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (HistoryTracking) : An instance of HistoryTracking + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HistoryTracking + except Exception: + from ..fields import HistoryTracking + + if history_tracking is not None and not isinstance(history_tracking, HistoryTracking): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AssociationDetails + except Exception: + from ..fields import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_additional_column(self): + """ + The method to get the additional_column + + Returns: + string: A string representing the additional_column + """ + + return self.__additional_column + + def set_additional_column(self, additional_column): + """ + The method to set the value to additional_column + + Parameters: + additional_column (string) : A string representing the additional_column + """ + + if additional_column is not None and not isinstance(additional_column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: additional_column EXPECTED TYPE: str', None, None) + + self.__additional_column = additional_column + self.__key_modified['additional_column'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_global_picklist(self): + """ + The method to get the global_picklist + + Returns: + Object: A Object representing the global_picklist + """ + + return self.__global_picklist + + def set_global_picklist(self, global_picklist): + """ + The method to set the value to global_picklist + + Parameters: + global_picklist (Object) : A Object representing the global_picklist + """ + + self.__global_picklist = global_picklist + self.__key_modified['global_picklist'] = 1 + + def get_updateexistingrecords(self): + """ + The method to get the updateexistingrecords + + Returns: + bool: A bool representing the updateexistingrecords + """ + + return self.__updateexistingrecords + + def set_updateexistingrecords(self, updateexistingrecords): + """ + The method to set the value to updateexistingrecords + + Parameters: + updateexistingrecords (bool) : A bool representing the updateexistingrecords + """ + + if updateexistingrecords is not None and not isinstance(updateexistingrecords, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updateexistingrecords EXPECTED TYPE: bool', None, None) + + self.__updateexistingrecords = updateexistingrecords + self.__key_modified['_update_existing_records'] = 1 + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + bool: A bool representing the number_separator + """ + + return self.__number_separator + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (bool) : A bool representing the number_separator + """ + + if number_separator is not None and not isinstance(number_separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: bool', None, None) + + self.__number_separator = number_separator + self.__key_modified['number_separator'] = 1 + + def get_textarea(self): + """ + The method to get the textarea + + Returns: + Textarea: An instance of Textarea + """ + + return self.__textarea + + def set_textarea(self, textarea): + """ + The method to set the value to textarea + + Parameters: + textarea (Textarea) : An instance of Textarea + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Textarea + except Exception: + from ..fields import Textarea + + if textarea is not None and not isinstance(textarea, Textarea): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: textarea EXPECTED TYPE: Textarea', None, None) + + self.__textarea = textarea + self.__key_modified['textarea'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/section_subform_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/section_subform_field.py new file mode 100644 index 0000000..2bbf525 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/section_subform_field.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SectionSubformField(object): + def __init__(self): + """Creates an instance of SectionSubformField""" + + self.__module = None + self.__id = None + self.__layout = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if layout is not None and not isinstance(layout, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: MinifiedLayout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/sections.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/sections.py new file mode 100644 index 0000000..1ccb8df --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/sections.py @@ -0,0 +1,354 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Sections(object): + def __init__(self): + """Creates an instance of Sections""" + + self.__display_label = None + self.__sequence_number = None + self.__issubformsection = None + self.__tab_traversal = None + self.__api_name = None + self.__column_count = None + self.__name = None + self.__generated_type = None + self.__id = None + self.__type = None + self.__fields = None + self.__properties = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_issubformsection(self): + """ + The method to get the issubformsection + + Returns: + bool: A bool representing the issubformsection + """ + + return self.__issubformsection + + 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 get_tab_traversal(self): + """ + The method to get the tab_traversal + + Returns: + string: A string representing the tab_traversal + """ + + return self.__tab_traversal + + def set_tab_traversal(self, tab_traversal): + """ + The method to set the value to tab_traversal + + Parameters: + tab_traversal (string) : A string representing the tab_traversal + """ + + if tab_traversal is not None and not isinstance(tab_traversal, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tab_traversal EXPECTED TYPE: str', None, None) + + self.__tab_traversal = tab_traversal + self.__key_modified['tab_traversal'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_column_count(self): + """ + The method to get the column_count + + Returns: + int: An int representing the column_count + """ + + return self.__column_count + + def set_column_count(self, column_count): + """ + The method to set the value to column_count + + Parameters: + column_count (int) : An int representing the column_count + """ + + if column_count is not None and not isinstance(column_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: int', None, None) + + self.__column_count = column_count + self.__key_modified['column_count'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_generated_type(self): + """ + The method to get the generated_type + + Returns: + string: A string representing the generated_type + """ + + return self.__generated_type + + def set_generated_type(self, generated_type): + """ + The method to set the value to generated_type + + Parameters: + generated_type (string) : A string representing the generated_type + """ + + if generated_type is not None and not isinstance(generated_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: str', None, None) + + self.__generated_type = generated_type + self.__key_modified['generated_type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + Properties: An instance of Properties + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (Properties) : An instance of Properties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.properties import Properties + except Exception: + from .properties import Properties + + if properties is not None and not isinstance(properties, Properties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: Properties', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/static_values.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/static_values.py new file mode 100644 index 0000000..eeb75ac --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/static_values.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class StaticValues(object): + def __init__(self): + """Creates an instance of StaticValues""" + + self.__sequence_number = None + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/subform_property.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/subform_property.py new file mode 100644 index 0000000..a841ea6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/subform_property.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SubformProperty(object): + def __init__(self): + """Creates an instance of SubformProperty""" + + self.__pinned_column = None + self.__key_modified = dict() + + def get_pinned_column(self): + """ + The method to get the pinned_column + + Returns: + bool: A bool representing the pinned_column + """ + + return self.__pinned_column + + def set_pinned_column(self, pinned_column): + """ + The method to set the value to pinned_column + + Parameters: + pinned_column (bool) : A bool representing the pinned_column + """ + + if pinned_column is not None and not isinstance(pinned_column, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pinned_column EXPECTED TYPE: bool', None, None) + + self.__pinned_column = pinned_column + self.__key_modified['pinned_column'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/success_response.py new file mode 100644 index 0000000..fd7de58 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/tooltip.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/tooltip.py new file mode 100644 index 0000000..1022c17 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/layouts/tooltip.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Tooltip(object): + def __init__(self): + """Creates an instance of Tooltip""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + Choice: An instance of Choice + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (Choice) : An instance of Choice + """ + + if name is not None and not isinstance(name, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: Choice', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/__init__.py new file mode 100644 index 0000000..f6b10b7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/__init__.py @@ -0,0 +1,20 @@ +from .action_wrapper import ActionWrapper +from .address import Address +from .mail_merge_template import MailMergeTemplate +from .mail_merge import MailMerge +from .sign_mail_merge_wrapper import SignMailMergeWrapper +from .sign_action_handler import SignActionHandler +from .signers import Signers +from .api_exception import APIException +from .action_response import ActionResponse +from .download_mail_merge import DownloadMailMerge +from .download_mail_merge_wrapper import DownloadMailMergeWrapper +from .file_body_wrapper import FileBodyWrapper +from .download_response_handler import DownloadResponseHandler +from .sign_action_response import SignActionResponse +from .success_response import SuccessResponse +from .sign_action_wrapper import SignActionWrapper +from .action_handler import ActionHandler +from .sign_mail_merge import SignMailMerge +from .mail_merge_operations import MailMergeOperations +from .mail_merge_wrapper import MailMergeWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_wrapper.py new file mode 100644 index 0000000..d09068f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__send_mail_merge = None + self.__key_modified = dict() + + def get_send_mail_merge(self): + """ + The method to get the send_mail_merge + + Returns: + list: An instance of list + """ + + return self.__send_mail_merge + + def set_send_mail_merge(self, send_mail_merge): + """ + The method to set the value to send_mail_merge + + Parameters: + send_mail_merge (list) : An instance of list + """ + + if send_mail_merge is not None and not isinstance(send_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: send_mail_merge EXPECTED TYPE: list', None, None) + + self.__send_mail_merge = send_mail_merge + self.__key_modified['send_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/address.py new file mode 100644 index 0000000..b8f70be --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/address.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__type = None + self.__value = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/api_exception.py new file mode 100644 index 0000000..84ecfd9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_response_handler import DownloadResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_response import SignActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_handler import SignActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .download_response_handler import DownloadResponseHandler + from .sign_action_response import SignActionResponse + from .action_handler import ActionHandler + from .sign_action_handler import SignActionHandler + + +class APIException(ActionHandler, ActionResponse, DownloadResponseHandler, SignActionHandler, SignActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge.py new file mode 100644 index 0000000..1b0b854 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class DownloadMailMerge(object): + def __init__(self): + """Creates an instance of DownloadMailMerge""" + + self.__mail_merge_template = None + self.__output_format = None + self.__file_name = None + self.__password = None + self.__key_modified = dict() + + def get_mail_merge_template(self): + """ + The method to get the mail_merge_template + + Returns: + MailMergeTemplate: An instance of MailMergeTemplate + """ + + return self.__mail_merge_template + + def set_mail_merge_template(self, mail_merge_template): + """ + The method to set the value to mail_merge_template + + Parameters: + mail_merge_template (MailMergeTemplate) : An instance of MailMergeTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_template import MailMergeTemplate + except Exception: + from .mail_merge_template import MailMergeTemplate + + if mail_merge_template is not None and not isinstance(mail_merge_template, MailMergeTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_merge_template EXPECTED TYPE: MailMergeTemplate', None, None) + + self.__mail_merge_template = mail_merge_template + self.__key_modified['mail_merge_template'] = 1 + + def get_output_format(self): + """ + The method to get the output_format + + Returns: + Choice: An instance of Choice + """ + + return self.__output_format + + def set_output_format(self, output_format): + """ + The method to set the value to output_format + + Parameters: + output_format (Choice) : An instance of Choice + """ + + if output_format is not None and not isinstance(output_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: output_format EXPECTED TYPE: Choice', None, None) + + self.__output_format = output_format + self.__key_modified['output_format'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_password(self): + """ + The method to get the password + + Returns: + string: A string representing the password + """ + + return self.__password + + def set_password(self, password): + """ + The method to set the value to password + + Parameters: + password (string) : A string representing the password + """ + + if password is not None and not isinstance(password, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: password EXPECTED TYPE: str', None, None) + + self.__password = password + self.__key_modified['password'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge_wrapper.py new file mode 100644 index 0000000..3c8295f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DownloadMailMergeWrapper(object): + def __init__(self): + """Creates an instance of DownloadMailMergeWrapper""" + + self.__download_mail_merge = None + self.__key_modified = dict() + + def get_download_mail_merge(self): + """ + The method to get the download_mail_merge + + Returns: + list: An instance of list + """ + + return self.__download_mail_merge + + def set_download_mail_merge(self, download_mail_merge): + """ + The method to set the value to download_mail_merge + + Parameters: + download_mail_merge (list) : An instance of list + """ + + if download_mail_merge is not None and not isinstance(download_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_mail_merge EXPECTED TYPE: list', None, None) + + self.__download_mail_merge = download_mail_merge + self.__key_modified['download_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_response_handler.py new file mode 100644 index 0000000..3d52e2f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DownloadResponseHandler(ABC): + def __init__(self): + """Creates an instance of DownloadResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/file_body_wrapper.py new file mode 100644 index 0000000..ff904cc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_response_handler import DownloadResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .download_response_handler import DownloadResponseHandler + + +class FileBodyWrapper(DownloadResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge.py new file mode 100644 index 0000000..d7396c9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge.py @@ -0,0 +1,284 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MailMerge(object): + def __init__(self): + """Creates an instance of MailMerge""" + + self.__mail_merge_template = None + self.__from_address = None + self.__to_address = None + self.__cc_email = None + self.__bcc_email = None + self.__subject = None + self.__message = None + self.__type = None + self.__attachment_name = None + self.__key_modified = dict() + + def get_mail_merge_template(self): + """ + The method to get the mail_merge_template + + Returns: + MailMergeTemplate: An instance of MailMergeTemplate + """ + + return self.__mail_merge_template + + def set_mail_merge_template(self, mail_merge_template): + """ + The method to set the value to mail_merge_template + + Parameters: + mail_merge_template (MailMergeTemplate) : An instance of MailMergeTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_template import MailMergeTemplate + except Exception: + from .mail_merge_template import MailMergeTemplate + + if mail_merge_template is not None and not isinstance(mail_merge_template, MailMergeTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_merge_template EXPECTED TYPE: MailMergeTemplate', None, None) + + self.__mail_merge_template = mail_merge_template + self.__key_modified['mail_merge_template'] = 1 + + def get_from_address(self): + """ + The method to get the from_address + + Returns: + Address: An instance of Address + """ + + return self.__from_address + + def set_from_address(self, from_address): + """ + The method to set the value to from_address + + Parameters: + from_address (Address) : An instance of Address + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.address import Address + except Exception: + from .address import Address + + if from_address is not None and not isinstance(from_address, Address): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_address EXPECTED TYPE: Address', None, None) + + self.__from_address = from_address + self.__key_modified['from_address'] = 1 + + def get_to_address(self): + """ + The method to get the to_address + + Returns: + list: An instance of list + """ + + return self.__to_address + + def set_to_address(self, to_address): + """ + The method to set the value to to_address + + Parameters: + to_address (list) : An instance of list + """ + + if to_address is not None and not isinstance(to_address, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to_address EXPECTED TYPE: list', None, None) + + self.__to_address = to_address + self.__key_modified['to_address'] = 1 + + def get_cc_email(self): + """ + The method to get the cc_email + + Returns: + list: An instance of list + """ + + return self.__cc_email + + def set_cc_email(self, cc_email): + """ + The method to set the value to cc_email + + Parameters: + cc_email (list) : An instance of list + """ + + if cc_email is not None and not isinstance(cc_email, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc_email EXPECTED TYPE: list', None, None) + + self.__cc_email = cc_email + self.__key_modified['cc_email'] = 1 + + def get_bcc_email(self): + """ + The method to get the bcc_email + + Returns: + list: An instance of list + """ + + return self.__bcc_email + + def set_bcc_email(self, bcc_email): + """ + The method to set the value to bcc_email + + Parameters: + bcc_email (list) : An instance of list + """ + + if bcc_email is not None and not isinstance(bcc_email, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc_email EXPECTED TYPE: list', None, None) + + self.__bcc_email = bcc_email + self.__key_modified['bcc_email'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_attachment_name(self): + """ + The method to get the attachment_name + + Returns: + string: A string representing the attachment_name + """ + + return self.__attachment_name + + def set_attachment_name(self, attachment_name): + """ + The method to set the value to attachment_name + + Parameters: + attachment_name (string) : A string representing the attachment_name + """ + + if attachment_name is not None and not isinstance(attachment_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_name EXPECTED TYPE: str', None, None) + + self.__attachment_name = attachment_name + self.__key_modified['attachment_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_operations.py new file mode 100644 index 0000000..e7857fa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_operations.py @@ -0,0 +1,150 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class MailMergeOperations(object): + def __init__(self, module, id): + """ + Creates an instance of MailMergeOperations with the given parameters + + Parameters: + module (string) : A string representing the module + id (string) : A string representing the id + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__module = module + self.__id = id + + + def send_mail_merge(self, request): + """ + The method to send mail merge + + Parameters: + request (MailMergeWrapper) : An instance of MailMergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_wrapper import MailMergeWrapper + except Exception: + from .mail_merge_wrapper import MailMergeWrapper + + if request is not None and not isinstance(request, MailMergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MailMergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/send_mail_merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def download_mail_merge(self, request): + """ + The method to download mail merge + + Parameters: + request (DownloadMailMergeWrapper) : An instance of DownloadMailMergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_mail_merge_wrapper import DownloadMailMergeWrapper + except Exception: + from .download_mail_merge_wrapper import DownloadMailMergeWrapper + + if request is not None and not isinstance(request, DownloadMailMergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: DownloadMailMergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/download_mail_merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_response_handler import DownloadResponseHandler + except Exception: + from .download_response_handler import DownloadResponseHandler + return handler_instance.api_call(DownloadResponseHandler.__module__, 'application/json') + + def sign_mail_merge(self, request): + """ + The method to sign mail merge + + Parameters: + request (SignMailMergeWrapper) : An instance of SignMailMergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_mail_merge_wrapper import SignMailMergeWrapper + except Exception: + from .sign_mail_merge_wrapper import SignMailMergeWrapper + + if request is not None and not isinstance(request, SignMailMergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: SignMailMergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/sign_mail_merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_handler import SignActionHandler + except Exception: + from .sign_action_handler import SignActionHandler + return handler_instance.api_call(SignActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_template.py new file mode 100644 index 0000000..92bbfcd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MailMergeTemplate(object): + def __init__(self): + """Creates an instance of MailMergeTemplate""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_wrapper.py new file mode 100644 index 0000000..77957b5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MailMergeWrapper(object): + def __init__(self): + """Creates an instance of MailMergeWrapper""" + + self.__send_mail_merge = None + self.__key_modified = dict() + + def get_send_mail_merge(self): + """ + The method to get the send_mail_merge + + Returns: + list: An instance of list + """ + + return self.__send_mail_merge + + def set_send_mail_merge(self, send_mail_merge): + """ + The method to set the value to send_mail_merge + + Parameters: + send_mail_merge (list) : An instance of list + """ + + if send_mail_merge is not None and not isinstance(send_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: send_mail_merge EXPECTED TYPE: list', None, None) + + self.__send_mail_merge = send_mail_merge + self.__key_modified['send_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_handler.py new file mode 100644 index 0000000..7cf25a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class SignActionHandler(ABC): + def __init__(self): + """Creates an instance of SignActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_response.py new file mode 100644 index 0000000..071ebfa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class SignActionResponse(ABC): + def __init__(self): + """Creates an instance of SignActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.py new file mode 100644 index 0000000..23a9220 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_handler import SignActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .sign_action_handler import SignActionHandler + + +class SignActionWrapper(SignActionHandler): + def __init__(self): + """Creates an instance of SignActionWrapper""" + super().__init__() + + self.__sign_mail_merge = None + self.__key_modified = dict() + + def get_sign_mail_merge(self): + """ + The method to get the sign_mail_merge + + Returns: + list: An instance of list + """ + + return self.__sign_mail_merge + + def set_sign_mail_merge(self, sign_mail_merge): + """ + The method to set the value to sign_mail_merge + + Parameters: + sign_mail_merge (list) : An instance of list + """ + + if sign_mail_merge is not None and not isinstance(sign_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_mail_merge EXPECTED TYPE: list', None, None) + + self.__sign_mail_merge = sign_mail_merge + self.__key_modified['sign_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge.py new file mode 100644 index 0000000..80d9c31 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SignMailMerge(object): + def __init__(self): + """Creates an instance of SignMailMerge""" + + self.__mail_merge_template = None + self.__sign_in_order = None + self.__file_name = None + self.__signers = None + self.__key_modified = dict() + + def get_mail_merge_template(self): + """ + The method to get the mail_merge_template + + Returns: + MailMergeTemplate: An instance of MailMergeTemplate + """ + + return self.__mail_merge_template + + def set_mail_merge_template(self, mail_merge_template): + """ + The method to set the value to mail_merge_template + + Parameters: + mail_merge_template (MailMergeTemplate) : An instance of MailMergeTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_template import MailMergeTemplate + except Exception: + from .mail_merge_template import MailMergeTemplate + + if mail_merge_template is not None and not isinstance(mail_merge_template, MailMergeTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_merge_template EXPECTED TYPE: MailMergeTemplate', None, None) + + self.__mail_merge_template = mail_merge_template + self.__key_modified['mail_merge_template'] = 1 + + def get_sign_in_order(self): + """ + The method to get the sign_in_order + + Returns: + bool: A bool representing the sign_in_order + """ + + return self.__sign_in_order + + def set_sign_in_order(self, sign_in_order): + """ + The method to set the value to sign_in_order + + Parameters: + sign_in_order (bool) : A bool representing the sign_in_order + """ + + if sign_in_order is not None and not isinstance(sign_in_order, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_in_order EXPECTED TYPE: bool', None, None) + + self.__sign_in_order = sign_in_order + self.__key_modified['sign_in_order'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_signers(self): + """ + The method to get the signers + + Returns: + list: An instance of list + """ + + return self.__signers + + def set_signers(self, signers): + """ + The method to set the value to signers + + Parameters: + signers (list) : An instance of list + """ + + if signers is not None and not isinstance(signers, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signers EXPECTED TYPE: list', None, None) + + self.__signers = signers + self.__key_modified['signers'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge_wrapper.py new file mode 100644 index 0000000..2f21a4d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SignMailMergeWrapper(object): + def __init__(self): + """Creates an instance of SignMailMergeWrapper""" + + self.__sign_mail_merge = None + self.__key_modified = dict() + + def get_sign_mail_merge(self): + """ + The method to get the sign_mail_merge + + Returns: + list: An instance of list + """ + + return self.__sign_mail_merge + + def set_sign_mail_merge(self, sign_mail_merge): + """ + The method to set the value to sign_mail_merge + + Parameters: + sign_mail_merge (list) : An instance of list + """ + + if sign_mail_merge is not None and not isinstance(sign_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_mail_merge EXPECTED TYPE: list', None, None) + + self.__sign_mail_merge = sign_mail_merge + self.__key_modified['sign_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/signers.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/signers.py new file mode 100644 index 0000000..e447421 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/signers.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Signers(object): + def __init__(self): + """Creates an instance of Signers""" + + self.__recipient_name = None + self.__action_type = None + self.__recipient = None + self.__key_modified = dict() + + def get_recipient_name(self): + """ + The method to get the recipient_name + + Returns: + string: A string representing the recipient_name + """ + + return self.__recipient_name + + def set_recipient_name(self, recipient_name): + """ + The method to set the value to recipient_name + + Parameters: + recipient_name (string) : A string representing the recipient_name + """ + + if recipient_name is not None and not isinstance(recipient_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recipient_name EXPECTED TYPE: str', None, None) + + self.__recipient_name = recipient_name + self.__key_modified['recipient_name'] = 1 + + def get_action_type(self): + """ + The method to get the action_type + + Returns: + Choice: An instance of Choice + """ + + return self.__action_type + + def set_action_type(self, action_type): + """ + The method to set the value to action_type + + Parameters: + action_type (Choice) : An instance of Choice + """ + + if action_type is not None and not isinstance(action_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_type EXPECTED TYPE: Choice', None, None) + + self.__action_type = action_type + self.__key_modified['action_type'] = 1 + + def get_recipient(self): + """ + The method to get the recipient + + Returns: + Address: An instance of Address + """ + + return self.__recipient + + def set_recipient(self, recipient): + """ + The method to set the value to recipient + + Parameters: + recipient (Address) : An instance of Address + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.address import Address + except Exception: + from .address import Address + + if recipient is not None and not isinstance(recipient, Address): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recipient EXPECTED TYPE: Address', None, None) + + self.__recipient = recipient + self.__key_modified['recipient'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/success_response.py new file mode 100644 index 0000000..81c4fb3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mail_merge/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_response import SignActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .sign_action_response import SignActionResponse + + +class SuccessResponse(SignActionResponse, ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/__init__.py new file mode 100644 index 0000000..314b0de --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/__init__.py @@ -0,0 +1,14 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .mass_change_owner_operations import MassChangeOwnerOperations, CheckStatusParam +from .criteria import Criteria +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .field import Field +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .status import Status +from .territory import Territory diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_wrapper.py new file mode 100644 index 0000000..231ae5a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/api_exception.py new file mode 100644 index 0000000..d25a43d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/body_wrapper.py new file mode 100644 index 0000000..0410e8e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/body_wrapper.py @@ -0,0 +1,164 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__cvid = None + self.__owner = None + self.__criteria = None + self.__territory = None + self.__key_modified = dict() + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + int: An int representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (int) : An int representing the cvid + """ + + if cvid is not None and not isinstance(cvid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: int', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/criteria.py new file mode 100644 index 0000000..ebc1a77 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/mass_change_owner_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/mass_change_owner_operations.py new file mode 100644 index 0000000..84a85de --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/mass_change_owner_operations.py @@ -0,0 +1,103 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class MassChangeOwnerOperations(object): + def __init__(self, module): + """ + Creates an instance of MassChangeOwnerOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def change_owner(self, request): + """ + The method to change owner + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def check_status(self, param_instance=None): + """ + The method to check status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class CheckStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassChangeOwner.CheckStatusParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/owner.py new file mode 100644 index 0000000..3a97231 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_wrapper.py new file mode 100644 index 0000000..b045dc4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/status.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/status.py new file mode 100644 index 0000000..ecc33dc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/status.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__failed_count = None + self.__not_updated_count = None + self.__updated_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_not_updated_count(self): + """ + The method to get the not_updated_count + + Returns: + int: An int representing the not_updated_count + """ + + return self.__not_updated_count + + 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 + + def get_updated_count(self): + """ + The method to get the updated_count + + Returns: + int: An int representing the updated_count + """ + + return self.__updated_count + + def set_updated_count(self, updated_count): + """ + The method to set the value to updated_count + + Parameters: + updated_count (int) : An int representing the updated_count + """ + + if updated_count is not None and not isinstance(updated_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updated_count EXPECTED TYPE: int', None, None) + + self.__updated_count = updated_count + self.__key_modified['Updated_Count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/success_response.py new file mode 100644 index 0000000..f24aa51 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/territory.py new file mode 100644 index 0000000..ea24586 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/territory.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__id = None + self.__include_child = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_include_child(self): + """ + The method to get the include_child + + Returns: + bool: A bool representing the include_child + """ + + return self.__include_child + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/__init__.py new file mode 100644 index 0000000..b65ae3e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/__init__.py @@ -0,0 +1,13 @@ +from .portal_user_type import PortalUserType +from .mass_convert_operations import MassConvertOperations, GetJobStatusParam +from .assign_to import AssignTo +from .related_module import RelatedModule +from .body_wrapper import BodyWrapper +from .move_attachments_to import MoveAttachmentsTo +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .status import Status diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/api_exception.py new file mode 100644 index 0000000..8a80bad --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + + +class APIException(ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__details = None + self.__code = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/assign_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/assign_to.py new file mode 100644 index 0000000..d09ecab --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/assign_to.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignTo(object): + def __init__(self): + """Creates an instance of AssignTo""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/body_wrapper.py new file mode 100644 index 0000000..09fdd4c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/body_wrapper.py @@ -0,0 +1,269 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__deals = None + self.__move_attachments_to = None + self.__assign_to = None + self.__carry_over_tags = None + self.__related_modules = None + self.__portal_user_type = None + self.__ids = None + self.__apply_assignment_threshold = None + self.__key_modified = dict() + + def get_deals(self): + """ + The method to get the deals + + Returns: + Record: An instance of Record + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if deals is not None and not isinstance(deals, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: Record', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_move_attachments_to(self): + """ + The method to get the move_attachments_to + + Returns: + MoveAttachmentsTo: An instance of MoveAttachmentsTo + """ + + return self.__move_attachments_to + + def set_move_attachments_to(self, move_attachments_to): + """ + The method to set the value to move_attachments_to + + Parameters: + move_attachments_to (MoveAttachmentsTo) : An instance of MoveAttachmentsTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.move_attachments_to import MoveAttachmentsTo + except Exception: + from .move_attachments_to import MoveAttachmentsTo + + if move_attachments_to is not None and not isinstance(move_attachments_to, MoveAttachmentsTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_attachments_to EXPECTED TYPE: MoveAttachmentsTo', None, None) + + self.__move_attachments_to = move_attachments_to + self.__key_modified['move_attachments_to'] = 1 + + def get_assign_to(self): + """ + The method to get the assign_to + + Returns: + AssignTo: An instance of AssignTo + """ + + return self.__assign_to + + def set_assign_to(self, assign_to): + """ + The method to set the value to assign_to + + Parameters: + assign_to (AssignTo) : An instance of AssignTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.assign_to import AssignTo + except Exception: + from .assign_to import AssignTo + + if assign_to is not None and not isinstance(assign_to, AssignTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assign_to EXPECTED TYPE: AssignTo', None, None) + + self.__assign_to = assign_to + self.__key_modified['assign_to'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + list: An instance of list + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (list) : An instance of list + """ + + if carry_over_tags is not None and not isinstance(carry_over_tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: list', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def get_portal_user_type(self): + """ + The method to get the portal_user_type + + Returns: + PortalUserType: An instance of PortalUserType + """ + + return self.__portal_user_type + + def set_portal_user_type(self, portal_user_type): + """ + The method to set the value to portal_user_type + + Parameters: + portal_user_type (PortalUserType) : An instance of PortalUserType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.portal_user_type import PortalUserType + except Exception: + from .portal_user_type import PortalUserType + + if portal_user_type is not None and not isinstance(portal_user_type, PortalUserType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_user_type EXPECTED TYPE: PortalUserType', None, None) + + self.__portal_user_type = portal_user_type + self.__key_modified['portal_user_type'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_apply_assignment_threshold(self): + """ + The method to get the apply_assignment_threshold + + Returns: + bool: A bool representing the apply_assignment_threshold + """ + + return self.__apply_assignment_threshold + + def set_apply_assignment_threshold(self, apply_assignment_threshold): + """ + The method to set the value to apply_assignment_threshold + + Parameters: + apply_assignment_threshold (bool) : A bool representing the apply_assignment_threshold + """ + + if apply_assignment_threshold is not None and not isinstance(apply_assignment_threshold, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: apply_assignment_threshold EXPECTED TYPE: bool', None, None) + + self.__apply_assignment_threshold = apply_assignment_threshold + self.__key_modified['apply_assignment_threshold'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/error_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/mass_convert_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/mass_convert_operations.py new file mode 100644 index 0000000..bc8ae57 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/mass_convert_operations.py @@ -0,0 +1,92 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + + +class MassConvertOperations(object): + def __init__(self): + """Creates an instance of MassConvertOperations""" + pass + + def mass_convert(self, request): + """ + The method to mass convert + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Leads/actions/mass_convert' + 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.set_module_api_name("Deals") + Utility.get_fields("Deals", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def get_job_status(self, param_instance=None): + """ + The method to get job status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Leads/actions/mass_convert' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetJobStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassConvert.GetJobStatusParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/move_attachments_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/move_attachments_to.py new file mode 100644 index 0000000..8bd9065 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/move_attachments_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MoveAttachmentsTo(object): + def __init__(self): + """Creates an instance of MoveAttachmentsTo""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/portal_user_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/portal_user_type.py new file mode 100644 index 0000000..6ffe1b1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/portal_user_type.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PortalUserType(object): + def __init__(self): + """Creates an instance of PortalUserType""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/related_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/related_module.py new file mode 100644 index 0000000..d57a90c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/related_module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedModule(object): + def __init__(self): + """Creates an instance of RelatedModule""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_wrapper.py new file mode 100644 index 0000000..f5571d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/status.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/status.py new file mode 100644 index 0000000..74b244a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/status.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__failed_count = None + self.__not_converted_count = None + self.__total_count = None + self.__converted_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_not_converted_count(self): + """ + The method to get the not_converted_count + + Returns: + int: An int representing the not_converted_count + """ + + return self.__not_converted_count + + def set_not_converted_count(self, not_converted_count): + """ + The method to set the value to not_converted_count + + Parameters: + not_converted_count (int) : An int representing the not_converted_count + """ + + if not_converted_count is not None and not isinstance(not_converted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: not_converted_count EXPECTED TYPE: int', None, None) + + self.__not_converted_count = not_converted_count + self.__key_modified['Not_Converted_Count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def get_converted_count(self): + """ + The method to get the converted_count + + Returns: + int: An int representing the converted_count + """ + + return self.__converted_count + + def set_converted_count(self, converted_count): + """ + The method to set the value to converted_count + + Parameters: + converted_count (int) : An int representing the converted_count + """ + + if converted_count is not None and not isinstance(converted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: converted_count EXPECTED TYPE: int', None, None) + + self.__converted_count = converted_count + self.__key_modified['Converted_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/success_response.py new file mode 100644 index 0000000..07ff851 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_convert/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/__init__.py new file mode 100644 index 0000000..d51e735 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/__init__.py @@ -0,0 +1,12 @@ +from .mass_delete_cvid_operations import MassDeleteCvidOperations, GetMassDeleteStatusParam +from .record_id_body_wrapper import RecordIdBodyWrapper +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .cvid_body_wrapper import CvidBodyWrapper +from .territory import Territory +from .status import Status diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_wrapper.py new file mode 100644 index 0000000..211b3cb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/api_exception.py new file mode 100644 index 0000000..45376e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/cvid_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/cvid_body_wrapper.py new file mode 100644 index 0000000..71c4704 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/cvid_body_wrapper.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CvidBodyWrapper(object): + def __init__(self): + """Creates an instance of CvidBodyWrapper""" + + self.__cvid = None + self.__territory = None + self.__key_modified = dict() + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + int: An int representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (int) : An int representing the cvid + """ + + if cvid is not None and not isinstance(cvid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: int', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/mass_delete_cvid_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/mass_delete_cvid_operations.py new file mode 100644 index 0000000..4888766 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/mass_delete_cvid_operations.py @@ -0,0 +1,141 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class MassDeleteCvidOperations(object): + def __init__(self, module): + """ + Creates an instance of MassDeleteCvidOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def mass_delete_by_cvid(self, request): + """ + The method to mass delete by cvid + + Parameters: + request (CvidBodyWrapper) : An instance of CvidBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.cvid_body_wrapper import CvidBodyWrapper + except Exception: + from .cvid_body_wrapper import CvidBodyWrapper + + if request is not None and not isinstance(request, CvidBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: CvidBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def mass_delete_by_record_id(self, request): + """ + The method to mass delete by record id + + Parameters: + request (RecordIdBodyWrapper) : An instance of RecordIdBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.record_id_body_wrapper import RecordIdBodyWrapper + except Exception: + from .record_id_body_wrapper import RecordIdBodyWrapper + + if request is not None and not isinstance(request, RecordIdBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RecordIdBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_mass_delete_status(self, param_instance=None): + """ + The method to get mass delete status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_delete' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetMassDeleteStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassDeleteCvid.GetMassDeleteStatusParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/record_id_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/record_id_body_wrapper.py new file mode 100644 index 0000000..462c3a4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/record_id_body_wrapper.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RecordIdBodyWrapper(object): + def __init__(self): + """Creates an instance of RecordIdBodyWrapper""" + + self.__ids = None + self.__territory = None + self.__key_modified = dict() + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_wrapper.py new file mode 100644 index 0000000..a746abb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/status.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/status.py new file mode 100644 index 0000000..8cc718d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/status.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__failed_count = None + self.__deleted_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_deleted_count(self): + """ + The method to get the deleted_count + + Returns: + int: An int representing the deleted_count + """ + + return self.__deleted_count + + def set_deleted_count(self, deleted_count): + """ + The method to set the value to deleted_count + + Parameters: + deleted_count (int) : An int representing the deleted_count + """ + + if deleted_count is not None and not isinstance(deleted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_count EXPECTED TYPE: int', None, None) + + self.__deleted_count = deleted_count + self.__key_modified['Deleted_Count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/success_response.py new file mode 100644 index 0000000..7c44889 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/territory.py new file mode 100644 index 0000000..ea24586 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/territory.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__id = None + self.__include_child = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_include_child(self): + """ + The method to get the include_child + + Returns: + bool: A bool representing the include_child + """ + + return self.__include_child + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/__init__.py new file mode 100644 index 0000000..fd769ab --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/__init__.py @@ -0,0 +1,12 @@ +from .status_action_response import StatusActionResponse +from .status_response_handler import StatusResponseHandler +from .mass_delete_tags_operations import MassDeleteTagsOperations, GetStatusParam +from .api_exception import APIException +from .action_response import ActionResponse +from .status_response_wrapper import StatusResponseWrapper +from .success_response import SuccessResponse +from .module import Module +from .mass_delete import MassDelete +from .body_wrapper import BodyWrapper +from .tag import Tag +from .mass_delete_details import MassDeleteDetails diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/api_exception.py new file mode 100644 index 0000000..39732db --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_action_response import StatusActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_response_handler import StatusResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + from .status_response_handler import StatusResponseHandler + from .action_response import ActionResponse + + +class APIException(StatusActionResponse, ActionResponse, StatusResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__details = None + self.__message = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/body_wrapper.py new file mode 100644 index 0000000..44382be --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__mass_delete = None + self.__key_modified = dict() + + def get_mass_delete(self): + """ + The method to get the mass_delete + + Returns: + list: An instance of list + """ + + return self.__mass_delete + + def set_mass_delete(self, mass_delete): + """ + The method to set the value to mass_delete + + Parameters: + mass_delete (list) : An instance of list + """ + + if mass_delete is not None and not isinstance(mass_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_delete EXPECTED TYPE: list', None, None) + + self.__mass_delete = mass_delete + self.__key_modified['mass_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete.py new file mode 100644 index 0000000..a92389c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MassDelete(object): + def __init__(self): + """Creates an instance of MassDelete""" + + self.__module = None + self.__tags = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_details.py new file mode 100644 index 0000000..94ff497 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_details.py @@ -0,0 +1,177 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_action_response import StatusActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + + +class MassDeleteDetails(StatusActionResponse): + def __init__(self): + """Creates an instance of MassDeleteDetails""" + super().__init__() + + self.__job_id = None + self.__total_count = None + self.__failed_count = None + self.__deleted_count = None + self.__status = None + self.__key_modified = dict() + + def get_job_id(self): + """ + The method to get the job_id + + Returns: + int: An int representing the job_id + """ + + return self.__job_id + + def set_job_id(self, job_id): + """ + The method to set the value to job_id + + Parameters: + job_id (int) : An int representing the job_id + """ + + if job_id is not None and not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + self.__job_id = job_id + self.__key_modified['job_id'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['total_count'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['failed_count'] = 1 + + def get_deleted_count(self): + """ + The method to get the deleted_count + + Returns: + int: An int representing the deleted_count + """ + + return self.__deleted_count + + def set_deleted_count(self, deleted_count): + """ + The method to set the value to deleted_count + + Parameters: + deleted_count (int) : An int representing the deleted_count + """ + + if deleted_count is not None and not isinstance(deleted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_count EXPECTED TYPE: int', None, None) + + self.__deleted_count = deleted_count + self.__key_modified['deleted_count'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_tags_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_tags_operations.py new file mode 100644 index 0000000..4264aa1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_tags_operations.py @@ -0,0 +1,89 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class MassDeleteTagsOperations(object): + def __init__(self): + """Creates an instance of MassDeleteTagsOperations""" + pass + + def mass_delete_tags(self, request): + """ + The method to mass delete tags + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/tags/actions/mass_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def get_status(self, param_instance=None): + """ + The method to get status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/tags/actions/mass_delete' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_response_handler import StatusResponseHandler + except Exception: + from .status_response_handler import StatusResponseHandler + return handler_instance.api_call(StatusResponseHandler.__module__, 'application/json') + + +class GetStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassDeleteTags.GetStatusParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/module.py new file mode 100644 index 0000000..93604c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_action_response.py new file mode 100644 index 0000000..ff1c58b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusActionResponse(ABC): + def __init__(self): + """Creates an instance of StatusActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_handler.py new file mode 100644 index 0000000..5291de4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusResponseHandler(ABC): + def __init__(self): + """Creates an instance of StatusResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_wrapper.py new file mode 100644 index 0000000..8e03dfd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_response_handler import StatusResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .status_response_handler import StatusResponseHandler + + +class StatusResponseWrapper(StatusResponseHandler): + def __init__(self): + """Creates an instance of StatusResponseWrapper""" + super().__init__() + + self.__mass_delete = None + self.__key_modified = dict() + + def get_mass_delete(self): + """ + The method to get the mass_delete + + Returns: + list: An instance of list + """ + + return self.__mass_delete + + def set_mass_delete(self, mass_delete): + """ + The method to set the value to mass_delete + + Parameters: + mass_delete (list) : An instance of list + """ + + if mass_delete is not None and not isinstance(mass_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_delete EXPECTED TYPE: list', None, None) + + self.__mass_delete = mass_delete + self.__key_modified['mass_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/success_response.py new file mode 100644 index 0000000..5ca5f05 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/tag.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/tag.py new file mode 100644 index 0000000..8a0eba0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/tag.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tag(object): + def __init__(self): + """Creates an instance of Tag""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/__init__.py new file mode 100644 index 0000000..bea9ffe --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/__init__.py @@ -0,0 +1,21 @@ +from .action_wrapper import ActionWrapper +from .related_list_properties import RelatedListProperties +from .argument import Argument +from .module_field_lookup import ModuleFieldLookup +from .static_subform_properties import StaticSubformProperties +from .lookup_field import LookupField +from .body_wrapper import BodyWrapper +from .static_subform_field import StaticSubformField +from .modules import Modules +from .module_fields import ModuleFields +from .minified_module import MinifiedModule +from .modules_operations import ModulesOperations, GetModulesHeader +from .api_exception import APIException +from .action_response import ActionResponse +from .lookup_field_properties import LookupFieldProperties +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .sharing_properties import SharingProperties +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .territory import Territory diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_wrapper.py new file mode 100644 index 0000000..7c62dbd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__modules = None + self.__key_modified = dict() + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/api_exception.py new file mode 100644 index 0000000..fcff132 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/argument.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/argument.py new file mode 100644 index 0000000..ed6a83b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/argument.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Argument(object): + def __init__(self): + """Creates an instance of Argument""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/body_wrapper.py new file mode 100644 index 0000000..f756561 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__modules = None + self.__key_modified = dict() + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field.py new file mode 100644 index 0000000..a34e516 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import MinifiedField +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import MinifiedField + + +class LookupField(MinifiedField): + def __init__(self): + """Creates an instance of LookupField""" + super().__init__() + + self.__sequence_number = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field_properties.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field_properties.py new file mode 100644 index 0000000..4497648 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field_properties.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LookupFieldProperties(object): + def __init__(self): + """Creates an instance of LookupFieldProperties""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/minified_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/minified_module.py new file mode 100644 index 0000000..61a8777 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/minified_module.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedModule(object): + def __init__(self): + """Creates an instance of MinifiedModule""" + + self.__api_name = None + self.__id = None + self.__module_name = None + self.__module = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/module_field_lookup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/module_field_lookup.py new file mode 100644 index 0000000..df1ff17 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/module_field_lookup.py @@ -0,0 +1,237 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import Lookup +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import Lookup + + +class ModuleFieldLookup(Lookup): + def __init__(self): + """Creates an instance of ModuleFieldLookup""" + super().__init__() + + self.__query_details = None + self.__module = None + self.__display_label = None + self.__api_name = None + self.__id = None + self.__revalidate_filter_during_edit = None + self.__show_fields = None + self.__key_modified = dict() + + def get_query_details(self): + """ + The method to get the query_details + + Returns: + QueryDetails: An instance of QueryDetails + """ + + return self.__query_details + + def set_query_details(self, query_details): + """ + The method to set the value to query_details + + Parameters: + query_details (QueryDetails) : An instance of QueryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import QueryDetails + except Exception: + from ..fields import QueryDetails + + if query_details is not None and not isinstance(query_details, QueryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_details EXPECTED TYPE: QueryDetails', None, None) + + self.__query_details = query_details + self.__key_modified['query_details'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_revalidate_filter_during_edit(self): + """ + The method to get the revalidate_filter_during_edit + + Returns: + bool: A bool representing the revalidate_filter_during_edit + """ + + return self.__revalidate_filter_during_edit + + def set_revalidate_filter_during_edit(self, revalidate_filter_during_edit): + """ + The method to set the value to revalidate_filter_during_edit + + Parameters: + revalidate_filter_during_edit (bool) : A bool representing the revalidate_filter_during_edit + """ + + if revalidate_filter_during_edit is not None and not isinstance(revalidate_filter_during_edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: revalidate_filter_during_edit EXPECTED TYPE: bool', None, None) + + self.__revalidate_filter_during_edit = revalidate_filter_during_edit + self.__key_modified['revalidate_filter_during_edit'] = 1 + + def get_show_fields(self): + """ + The method to get the show_fields + + Returns: + list: An instance of list + """ + + return self.__show_fields + + def set_show_fields(self, show_fields): + """ + The method to set the value to show_fields + + Parameters: + show_fields (list) : An instance of list + """ + + if show_fields is not None and not isinstance(show_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_fields EXPECTED TYPE: list', None, None) + + self.__show_fields = show_fields + self.__key_modified['show_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/module_fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/module_fields.py new file mode 100644 index 0000000..e398061 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/module_fields.py @@ -0,0 +1,2138 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import Fields + + +class ModuleFields(Fields): + def __init__(self): + """Creates an instance of ModuleFields""" + super().__init__() + + self.__blueprint_supported = None + self.__json_type = None + self.__length = None + self.__decimal_place = None + self.__multi_module_lookup = None + self.__sharing_properties = None + self.__currency = None + self.__file_upolad_optionlist = None + self.__lookup = None + self.__subform = None + self.__formula = None + self.__multiselectlookup = None + self.__multiuserlookup = None + self.__pick_list_values = None + self.__allowed_modules = None + self.__hipaa_compliance_enabled = None + self.__hipaa_compliance = None + self.__associated_module = None + self.__data_type = None + self.__operation_type = None + self.__system_mandatory = None + self.__webhook = None + self.__sequence_number = None + self.__default_value = None + self.__virtual_field = None + self.__field_read_only = None + self.__customizable_properties = None + self.__read_only = None + self.__custom_field = None + self.__businesscard_supported = None + self.__filterable = None + self.__visible = None + self.__available_in_user_layout = None + self.__display_field = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__layout_associations = None + self.__separator = None + self.__searchable = None + self.__enable_colour_code = None + self.__mass_update = None + self.__created_source = None + self.__type = None + self.__display_label = None + self.__column_name = None + self.__api_name = None + self.__display_type = None + self.__ui_type = None + self.__colour_code_enabled_by_system = None + self.__quick_sequence_number = None + self.__email_parser = None + self.__rollup_summary = None + self.__refer_from_field = None + self.__created_time = None + self.__modified_time = None + self.__show_type = None + self.__category = None + self.__id = None + self.__profiles = None + self.__view_type = None + self.__unique = None + self.__sub_module = None + self.__external = None + self.__private = None + self.__convert_mapping = None + self.__autonumber = None + self.__auto_number_65 = None + self.__crypt = None + self.__tooltip = None + self.__history_tracking = None + self.__association_details = None + self.__additional_column = None + self.__field_label = None + self.__global_picklist = None + self.__updateexistingrecords = None + self.__number_separator = None + self.__textarea = None + self.__static_field = None + self.__key_modified = dict() + + def get_blueprint_supported(self): + """ + The method to get the blueprint_supported + + Returns: + bool: A bool representing the blueprint_supported + """ + + return self.__blueprint_supported + + def set_blueprint_supported(self, blueprint_supported): + """ + The method to set the value to blueprint_supported + + Parameters: + blueprint_supported (bool) : A bool representing the blueprint_supported + """ + + if blueprint_supported is not None and not isinstance(blueprint_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: bool', None, None) + + self.__blueprint_supported = blueprint_supported + self.__key_modified['blueprint_supported'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + int: An int representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (int) : An int representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: int', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MultiModuleLookup + except Exception: + from ..fields import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_sharing_properties(self): + """ + The method to get the sharing_properties + + Returns: + SharingProperties: An instance of SharingProperties + """ + + return self.__sharing_properties + + def set_sharing_properties(self, sharing_properties): + """ + The method to set the value to sharing_properties + + Parameters: + sharing_properties (SharingProperties) : An instance of SharingProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.sharing_properties import SharingProperties + except Exception: + from .sharing_properties import SharingProperties + + if sharing_properties is not None and not isinstance(sharing_properties, SharingProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_properties EXPECTED TYPE: SharingProperties', None, None) + + self.__sharing_properties = sharing_properties + self.__key_modified['sharing_properties'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Currency + except Exception: + from ..fields import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_file_upolad_optionlist(self): + """ + The method to get the file_upolad_optionlist + + Returns: + list: An instance of list + """ + + return self.__file_upolad_optionlist + + def set_file_upolad_optionlist(self, file_upolad_optionlist): + """ + The method to set the value to file_upolad_optionlist + + Parameters: + file_upolad_optionlist (list) : An instance of list + """ + + if file_upolad_optionlist is not None and not isinstance(file_upolad_optionlist, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_upolad_optionlist EXPECTED TYPE: list', None, None) + + self.__file_upolad_optionlist = file_upolad_optionlist + self.__key_modified['file_upolad_optionlist'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Lookup: An instance of Lookup + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Lookup) : An instance of Lookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Lookup + except Exception: + from ..fields import Lookup + + if lookup is not None and not isinstance(lookup, Lookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Lookup', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_subform(self): + """ + The method to get the subform + + Returns: + Subform: An instance of Subform + """ + + return self.__subform + + def set_subform(self, subform): + """ + The method to set the value to subform + + Parameters: + subform (Subform) : An instance of Subform + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Subform + except Exception: + from ..fields import Subform + + if subform is not None and not isinstance(subform, Subform): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Subform', None, None) + + self.__subform = subform + self.__key_modified['subform'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Formula + except Exception: + from ..fields import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_multiuserlookup(self): + """ + The method to get the multiuserlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiuserlookup + + def set_multiuserlookup(self, multiuserlookup): + """ + The method to set the value to multiuserlookup + + Parameters: + multiuserlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiuserlookup is not None and not isinstance(multiuserlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiuserlookup = multiuserlookup + self.__key_modified['multiuserlookup'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_allowed_modules(self): + """ + The method to get the allowed_modules + + Returns: + list: An instance of list + """ + + return self.__allowed_modules + + def set_allowed_modules(self, allowed_modules): + """ + The method to set the value to allowed_modules + + Parameters: + allowed_modules (list) : An instance of list + """ + + if allowed_modules is not None and not isinstance(allowed_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_modules EXPECTED TYPE: list', None, None) + + self.__allowed_modules = allowed_modules + self.__key_modified['allowed_modules'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HipaaCompliance + except Exception: + from ..fields import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def get_associated_module(self): + """ + The method to get the associated_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__associated_module + + def set_associated_module(self, associated_module): + """ + The method to set the value to associated_module + + Parameters: + associated_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if associated_module is not None and not isinstance(associated_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__associated_module = associated_module + self.__key_modified['associated_module'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_operation_type(self): + """ + The method to get the operation_type + + Returns: + OperationType: An instance of OperationType + """ + + return self.__operation_type + + def set_operation_type(self, operation_type): + """ + The method to set the value to operation_type + + Parameters: + operation_type (OperationType) : An instance of OperationType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import OperationType + except Exception: + from ..fields import OperationType + + if operation_type is not None and not isinstance(operation_type, OperationType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_type EXPECTED TYPE: OperationType', None, None) + + self.__operation_type = operation_type + self.__key_modified['operation_type'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_default_value(self): + """ + The method to get the default_value + + Returns: + string: A string representing the default_value + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (string) : A string representing the default_value + """ + + if default_value is not None and not isinstance(default_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: str', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_virtual_field(self): + """ + The method to get the virtual_field + + Returns: + bool: A bool representing the virtual_field + """ + + return self.__virtual_field + + def set_virtual_field(self, virtual_field): + """ + The method to set the value to virtual_field + + Parameters: + virtual_field (bool) : A bool representing the virtual_field + """ + + if virtual_field is not None and not isinstance(virtual_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: virtual_field EXPECTED TYPE: bool', None, None) + + self.__virtual_field = virtual_field + self.__key_modified['virtual_field'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_customizable_properties(self): + """ + The method to get the customizable_properties + + Returns: + list: An instance of list + """ + + return self.__customizable_properties + + def set_customizable_properties(self, customizable_properties): + """ + The method to set the value to customizable_properties + + Parameters: + customizable_properties (list) : An instance of list + """ + + if customizable_properties is not None and not isinstance(customizable_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable_properties EXPECTED TYPE: list', None, None) + + self.__customizable_properties = customizable_properties + self.__key_modified['customizable_properties'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_businesscard_supported(self): + """ + The method to get the businesscard_supported + + Returns: + bool: A bool representing the businesscard_supported + """ + + return self.__businesscard_supported + + def set_businesscard_supported(self, businesscard_supported): + """ + The method to set the value to businesscard_supported + + Parameters: + businesscard_supported (bool) : A bool representing the businesscard_supported + """ + + if businesscard_supported is not None and not isinstance(businesscard_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: bool', None, None) + + self.__businesscard_supported = businesscard_supported + self.__key_modified['businesscard_supported'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + bool: A bool representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (bool) : A bool representing the display_field + """ + + if display_field is not None and not isinstance(display_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: bool', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def get_separator(self): + """ + The method to get the separator + + Returns: + bool: A bool representing the separator + """ + + return self.__separator + + def set_separator(self, separator): + """ + The method to set the value to separator + + Parameters: + separator (bool) : A bool representing the separator + """ + + if separator is not None and not isinstance(separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: separator EXPECTED TYPE: bool', None, None) + + self.__separator = separator + self.__key_modified['separator'] = 1 + + def get_searchable(self): + """ + The method to get the searchable + + Returns: + bool: A bool representing the searchable + """ + + return self.__searchable + + def set_searchable(self, searchable): + """ + The method to set the value to searchable + + Parameters: + searchable (bool) : A bool representing the searchable + """ + + if searchable is not None and not isinstance(searchable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: searchable EXPECTED TYPE: bool', None, None) + + self.__searchable = searchable + self.__key_modified['searchable'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_mass_update(self): + """ + The method to get the mass_update + + Returns: + bool: A bool representing the mass_update + """ + + return self.__mass_update + + def set_mass_update(self, mass_update): + """ + The method to set the value to mass_update + + Parameters: + mass_update (bool) : A bool representing the mass_update + """ + + if mass_update is not None and not isinstance(mass_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: bool', None, None) + + self.__mass_update = mass_update + self.__key_modified['mass_update'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_colour_code_enabled_by_system(self): + """ + The method to get the colour_code_enabled_by_system + + Returns: + bool: A bool representing the colour_code_enabled_by_system + """ + + return self.__colour_code_enabled_by_system + + def set_colour_code_enabled_by_system(self, colour_code_enabled_by_system): + """ + The method to set the value to colour_code_enabled_by_system + + Parameters: + colour_code_enabled_by_system (bool) : A bool representing the colour_code_enabled_by_system + """ + + if colour_code_enabled_by_system is not None and not isinstance(colour_code_enabled_by_system, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code_enabled_by_system EXPECTED TYPE: bool', None, None) + + self.__colour_code_enabled_by_system = colour_code_enabled_by_system + self.__key_modified['colour_code_enabled_by_system'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + string: A string representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (string) : A string representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: str', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_email_parser(self): + """ + The method to get the email_parser + + Returns: + EmailParser: An instance of EmailParser + """ + + return self.__email_parser + + def set_email_parser(self, email_parser): + """ + The method to set the value to email_parser + + Parameters: + email_parser (EmailParser) : An instance of EmailParser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import EmailParser + except Exception: + from ..fields import EmailParser + + if email_parser is not None and not isinstance(email_parser, EmailParser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser EXPECTED TYPE: EmailParser', None, None) + + self.__email_parser = email_parser + self.__key_modified['email_parser'] = 1 + + def get_rollup_summary(self): + """ + The method to get the rollup_summary + + Returns: + RollupSummary: An instance of RollupSummary + """ + + return self.__rollup_summary + + def set_rollup_summary(self, rollup_summary): + """ + The method to set the value to rollup_summary + + Parameters: + rollup_summary (RollupSummary) : An instance of RollupSummary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import RollupSummary + except Exception: + from ..fields import RollupSummary + + if rollup_summary is not None and not isinstance(rollup_summary, RollupSummary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_summary EXPECTED TYPE: RollupSummary', None, None) + + self.__rollup_summary = rollup_summary + self.__key_modified['rollup_summary'] = 1 + + def get_refer_from_field(self): + """ + The method to get the refer_from_field + + Returns: + ReferFromField: An instance of ReferFromField + """ + + return self.__refer_from_field + + def set_refer_from_field(self, refer_from_field): + """ + The method to set the value to refer_from_field + + Parameters: + refer_from_field (ReferFromField) : An instance of ReferFromField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ReferFromField + except Exception: + from ..fields import ReferFromField + + if refer_from_field is not None and not isinstance(refer_from_field, ReferFromField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: refer_from_field EXPECTED TYPE: ReferFromField', None, None) + + self.__refer_from_field = refer_from_field + self.__key_modified['refer_from_field'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_show_type(self): + """ + The method to get the show_type + + Returns: + int: An int representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (int) : An int representing the show_type + """ + + if show_type is not None and not isinstance(show_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: int', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ViewType + except Exception: + from ..fields import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Unique + except Exception: + from ..fields import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if sub_module is not None and not isinstance(sub_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import External + except Exception: + from ..fields import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Private + except Exception: + from ..fields import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ConvertMapping + except Exception: + from ..fields import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_autonumber(self): + """ + The method to get the autonumber + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__autonumber + + def set_autonumber(self, autonumber): + """ + The method to set the value to autonumber + + Parameters: + autonumber (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if autonumber is not None and not isinstance(autonumber, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: autonumber EXPECTED TYPE: AutoNumber', None, None) + + self.__autonumber = autonumber + self.__key_modified['autonumber'] = 1 + + def get_auto_number_65(self): + """ + The method to get the auto_number_65 + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number_65 + + def set_auto_number_65(self, auto_number_65): + """ + The method to set the value to auto_number_65 + + Parameters: + auto_number_65 (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if auto_number_65 is not None and not isinstance(auto_number_65, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number_65 EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number_65 = auto_number_65 + self.__key_modified['auto_number'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Crypt + except Exception: + from ..fields import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Tooltip + except Exception: + from ..fields import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + HistoryTracking: An instance of HistoryTracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (HistoryTracking) : An instance of HistoryTracking + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HistoryTracking + except Exception: + from ..fields import HistoryTracking + + if history_tracking is not None and not isinstance(history_tracking, HistoryTracking): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AssociationDetails + except Exception: + from ..fields import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_additional_column(self): + """ + The method to get the additional_column + + Returns: + string: A string representing the additional_column + """ + + return self.__additional_column + + def set_additional_column(self, additional_column): + """ + The method to set the value to additional_column + + Parameters: + additional_column (string) : A string representing the additional_column + """ + + if additional_column is not None and not isinstance(additional_column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: additional_column EXPECTED TYPE: str', None, None) + + self.__additional_column = additional_column + self.__key_modified['additional_column'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_global_picklist(self): + """ + The method to get the global_picklist + + Returns: + Object: A Object representing the global_picklist + """ + + return self.__global_picklist + + def set_global_picklist(self, global_picklist): + """ + The method to set the value to global_picklist + + Parameters: + global_picklist (Object) : A Object representing the global_picklist + """ + + self.__global_picklist = global_picklist + self.__key_modified['global_picklist'] = 1 + + def get_updateexistingrecords(self): + """ + The method to get the updateexistingrecords + + Returns: + bool: A bool representing the updateexistingrecords + """ + + return self.__updateexistingrecords + + def set_updateexistingrecords(self, updateexistingrecords): + """ + The method to set the value to updateexistingrecords + + Parameters: + updateexistingrecords (bool) : A bool representing the updateexistingrecords + """ + + if updateexistingrecords is not None and not isinstance(updateexistingrecords, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updateexistingrecords EXPECTED TYPE: bool', None, None) + + self.__updateexistingrecords = updateexistingrecords + self.__key_modified['_update_existing_records'] = 1 + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + bool: A bool representing the number_separator + """ + + return self.__number_separator + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (bool) : A bool representing the number_separator + """ + + if number_separator is not None and not isinstance(number_separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: bool', None, None) + + self.__number_separator = number_separator + self.__key_modified['number_separator'] = 1 + + def get_textarea(self): + """ + The method to get the textarea + + Returns: + Textarea: An instance of Textarea + """ + + return self.__textarea + + def set_textarea(self, textarea): + """ + The method to set the value to textarea + + Parameters: + textarea (Textarea) : An instance of Textarea + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Textarea + except Exception: + from ..fields import Textarea + + if textarea is not None and not isinstance(textarea, Textarea): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: textarea EXPECTED TYPE: Textarea', None, None) + + self.__textarea = textarea + self.__key_modified['textarea'] = 1 + + def get_static_field(self): + """ + The method to get the static_field + + Returns: + bool: A bool representing the static_field + """ + + return self.__static_field + + def set_static_field(self, static_field): + """ + The method to set the value to static_field + + Parameters: + static_field (bool) : A bool representing the static_field + """ + + if static_field is not None and not isinstance(static_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_field EXPECTED TYPE: bool', None, None) + + self.__static_field = static_field + self.__key_modified['static_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/modules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/modules.py new file mode 100644 index 0000000..3b6badc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/modules.py @@ -0,0 +1,1736 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__has_more_profiles = None + self.__sub_menu_available = None + self.__global_search_supported = None + self.__deletable = None + self.__description = None + self.__creatable = None + self.__recycle_bin_on_delete = None + self.__inventory_template_supported = None + self.__modified_time = None + self.__plural_label = None + self.__presence_sub_menu = None + self.__triggers_supported = None + self.__id = None + self.__chart_view = None + self.__isblueprintsupported = None + self.__visibility = None + self.__visible = None + self.__convertable = None + self.__editable = None + self.__emailtemplate_support = None + self.__email_parser_supported = None + self.__filter_supported = None + self.__show_as_tab = None + self.__web_link = None + self.__sequence_number = None + self.__singular_label = None + self.__viewable = None + self.__api_supported = None + self.__api_name = None + self.__quick_create = None + self.__generated_type = None + self.__feeds_required = None + self.__scoring_supported = None + self.__webform_supported = None + self.__territory = None + self.__arguments = None + self.__module_name = None + self.__chart_view_supported = None + self.__profile_count = None + self.__business_card_field_limit = None + self.__track_current_data = None + self.__modified_by = None + self.__profiles = None + self.__parent_module = None + self.__activity_badge = None + self.__field_states = None + self.__business_card_fields = None + self.__per_page = None + self.__properties = None + self.__on_demand_properties = None + self.__search_layout_fields = None + self.__kanban_view_supported = None + self.__lookup_field_properties = None + self.__kanban_view = None + self.__related_lists = None + self.__filter_status = None + self.__related_list_properties = None + self.__display_field = None + self.__layouts = None + self.__fields = None + self.__custom_view = None + self.__zia_view = None + self.__default_mapping_fields = None + self.__status = None + self.__static_subform_properties = None + self.__layout_associations = None + self.__key_modified = dict() + + def get_has_more_profiles(self): + """ + The method to get the has_more_profiles + + Returns: + bool: A bool representing the has_more_profiles + """ + + return self.__has_more_profiles + + def set_has_more_profiles(self, has_more_profiles): + """ + The method to set the value to has_more_profiles + + Parameters: + has_more_profiles (bool) : A bool representing the has_more_profiles + """ + + if has_more_profiles is not None and not isinstance(has_more_profiles, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_more_profiles EXPECTED TYPE: bool', None, None) + + self.__has_more_profiles = has_more_profiles + self.__key_modified['has_more_profiles'] = 1 + + def get_sub_menu_available(self): + """ + The method to get the sub_menu_available + + Returns: + bool: A bool representing the sub_menu_available + """ + + return self.__sub_menu_available + + def set_sub_menu_available(self, sub_menu_available): + """ + The method to set the value to sub_menu_available + + Parameters: + sub_menu_available (bool) : A bool representing the sub_menu_available + """ + + if sub_menu_available is not None and not isinstance(sub_menu_available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_menu_available EXPECTED TYPE: bool', None, None) + + self.__sub_menu_available = sub_menu_available + self.__key_modified['sub_menu_available'] = 1 + + def get_global_search_supported(self): + """ + The method to get the global_search_supported + + Returns: + bool: A bool representing the global_search_supported + """ + + return self.__global_search_supported + + def set_global_search_supported(self, global_search_supported): + """ + The method to set the value to global_search_supported + + Parameters: + global_search_supported (bool) : A bool representing the global_search_supported + """ + + if global_search_supported is not None and not isinstance(global_search_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_search_supported EXPECTED TYPE: bool', None, None) + + self.__global_search_supported = global_search_supported + self.__key_modified['global_search_supported'] = 1 + + def get_deletable(self): + """ + The method to get the deletable + + Returns: + bool: A bool representing the deletable + """ + + return self.__deletable + + def set_deletable(self, deletable): + """ + The method to set the value to deletable + + Parameters: + deletable (bool) : A bool representing the deletable + """ + + if deletable is not None and not isinstance(deletable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deletable EXPECTED TYPE: bool', None, None) + + self.__deletable = deletable + self.__key_modified['deletable'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_creatable(self): + """ + The method to get the creatable + + Returns: + bool: A bool representing the creatable + """ + + return self.__creatable + + def set_creatable(self, creatable): + """ + The method to set the value to creatable + + Parameters: + creatable (bool) : A bool representing the creatable + """ + + if creatable is not None and not isinstance(creatable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: creatable EXPECTED TYPE: bool', None, None) + + self.__creatable = creatable + self.__key_modified['creatable'] = 1 + + def get_recycle_bin_on_delete(self): + """ + The method to get the recycle_bin_on_delete + + Returns: + bool: A bool representing the recycle_bin_on_delete + """ + + return self.__recycle_bin_on_delete + + def set_recycle_bin_on_delete(self, recycle_bin_on_delete): + """ + The method to set the value to recycle_bin_on_delete + + Parameters: + recycle_bin_on_delete (bool) : A bool representing the recycle_bin_on_delete + """ + + if recycle_bin_on_delete is not None and not isinstance(recycle_bin_on_delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recycle_bin_on_delete EXPECTED TYPE: bool', None, None) + + self.__recycle_bin_on_delete = recycle_bin_on_delete + self.__key_modified['recycle_bin_on_delete'] = 1 + + def get_inventory_template_supported(self): + """ + The method to get the inventory_template_supported + + Returns: + bool: A bool representing the inventory_template_supported + """ + + return self.__inventory_template_supported + + def set_inventory_template_supported(self, inventory_template_supported): + """ + The method to set the value to inventory_template_supported + + Parameters: + inventory_template_supported (bool) : A bool representing the inventory_template_supported + """ + + if inventory_template_supported is not None and not isinstance(inventory_template_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_template_supported EXPECTED TYPE: bool', None, None) + + self.__inventory_template_supported = inventory_template_supported + self.__key_modified['inventory_template_supported'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_presence_sub_menu(self): + """ + The method to get the presence_sub_menu + + Returns: + bool: A bool representing the presence_sub_menu + """ + + return self.__presence_sub_menu + + def set_presence_sub_menu(self, presence_sub_menu): + """ + The method to set the value to presence_sub_menu + + Parameters: + presence_sub_menu (bool) : A bool representing the presence_sub_menu + """ + + if presence_sub_menu is not None and not isinstance(presence_sub_menu, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: presence_sub_menu EXPECTED TYPE: bool', None, None) + + self.__presence_sub_menu = presence_sub_menu + self.__key_modified['presence_sub_menu'] = 1 + + def get_triggers_supported(self): + """ + The method to get the triggers_supported + + Returns: + bool: A bool representing the triggers_supported + """ + + return self.__triggers_supported + + def set_triggers_supported(self, triggers_supported): + """ + The method to set the value to triggers_supported + + Parameters: + triggers_supported (bool) : A bool representing the triggers_supported + """ + + if triggers_supported is not None and not isinstance(triggers_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: triggers_supported EXPECTED TYPE: bool', None, None) + + self.__triggers_supported = triggers_supported + self.__key_modified['triggers_supported'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_chart_view(self): + """ + The method to get the chart_view + + Returns: + bool: A bool representing the chart_view + """ + + return self.__chart_view + + def set_chart_view(self, chart_view): + """ + The method to set the value to chart_view + + Parameters: + chart_view (bool) : A bool representing the chart_view + """ + + if chart_view is not None and not isinstance(chart_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_view EXPECTED TYPE: bool', None, None) + + self.__chart_view = chart_view + self.__key_modified['chart_view'] = 1 + + def get_isblueprintsupported(self): + """ + The method to get the isblueprintsupported + + Returns: + bool: A bool representing the isblueprintsupported + """ + + return self.__isblueprintsupported + + def set_isblueprintsupported(self, isblueprintsupported): + """ + The method to set the value to isblueprintsupported + + Parameters: + isblueprintsupported (bool) : A bool representing the isblueprintsupported + """ + + if isblueprintsupported is not None and not isinstance(isblueprintsupported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isblueprintsupported EXPECTED TYPE: bool', None, None) + + self.__isblueprintsupported = isblueprintsupported + self.__key_modified['isBlueprintSupported'] = 1 + + def get_visibility(self): + """ + The method to get the visibility + + Returns: + int: An int representing the visibility + """ + + return self.__visibility + + def set_visibility(self, visibility): + """ + The method to set the value to visibility + + Parameters: + visibility (int) : An int representing the visibility + """ + + if visibility is not None and not isinstance(visibility, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visibility EXPECTED TYPE: int', None, None) + + self.__visibility = visibility + self.__key_modified['visibility'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_convertable(self): + """ + The method to get the convertable + + Returns: + bool: A bool representing the convertable + """ + + return self.__convertable + + def set_convertable(self, convertable): + """ + The method to set the value to convertable + + Parameters: + convertable (bool) : A bool representing the convertable + """ + + if convertable is not None and not isinstance(convertable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convertable EXPECTED TYPE: bool', None, None) + + self.__convertable = convertable + self.__key_modified['convertable'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['editable'] = 1 + + def get_emailtemplate_support(self): + """ + The method to get the emailtemplate_support + + Returns: + bool: A bool representing the emailtemplate_support + """ + + return self.__emailtemplate_support + + def set_emailtemplate_support(self, emailtemplate_support): + """ + The method to set the value to emailtemplate_support + + Parameters: + emailtemplate_support (bool) : A bool representing the emailtemplate_support + """ + + if emailtemplate_support is not None and not isinstance(emailtemplate_support, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emailtemplate_support EXPECTED TYPE: bool', None, None) + + self.__emailtemplate_support = emailtemplate_support + self.__key_modified['emailTemplate_support'] = 1 + + def get_email_parser_supported(self): + """ + The method to get the email_parser_supported + + Returns: + bool: A bool representing the email_parser_supported + """ + + return self.__email_parser_supported + + def set_email_parser_supported(self, email_parser_supported): + """ + The method to set the value to email_parser_supported + + Parameters: + email_parser_supported (bool) : A bool representing the email_parser_supported + """ + + if email_parser_supported is not None and not isinstance(email_parser_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser_supported EXPECTED TYPE: bool', None, None) + + self.__email_parser_supported = email_parser_supported + self.__key_modified['email_parser_supported'] = 1 + + def get_filter_supported(self): + """ + The method to get the filter_supported + + Returns: + bool: A bool representing the filter_supported + """ + + return self.__filter_supported + + def set_filter_supported(self, filter_supported): + """ + The method to set the value to filter_supported + + Parameters: + filter_supported (bool) : A bool representing the filter_supported + """ + + if filter_supported is not None and not isinstance(filter_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filter_supported EXPECTED TYPE: bool', None, None) + + self.__filter_supported = filter_supported + self.__key_modified['filter_supported'] = 1 + + def get_show_as_tab(self): + """ + The method to get the show_as_tab + + Returns: + bool: A bool representing the show_as_tab + """ + + return self.__show_as_tab + + def set_show_as_tab(self, show_as_tab): + """ + The method to set the value to show_as_tab + + Parameters: + show_as_tab (bool) : A bool representing the show_as_tab + """ + + if show_as_tab is not None and not isinstance(show_as_tab, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_as_tab EXPECTED TYPE: bool', None, None) + + self.__show_as_tab = show_as_tab + self.__key_modified['show_as_tab'] = 1 + + def get_web_link(self): + """ + The method to get the web_link + + Returns: + string: A string representing the web_link + """ + + return self.__web_link + + def set_web_link(self, web_link): + """ + The method to set the value to web_link + + Parameters: + web_link (string) : A string representing the web_link + """ + + if web_link is not None and not isinstance(web_link, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: web_link EXPECTED TYPE: str', None, None) + + self.__web_link = web_link + self.__key_modified['web_link'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_singular_label(self): + """ + The method to get the singular_label + + Returns: + string: A string representing the singular_label + """ + + return self.__singular_label + + def set_singular_label(self, singular_label): + """ + The method to set the value to singular_label + + Parameters: + singular_label (string) : A string representing the singular_label + """ + + if singular_label is not None and not isinstance(singular_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: singular_label EXPECTED TYPE: str', None, None) + + self.__singular_label = singular_label + self.__key_modified['singular_label'] = 1 + + def get_viewable(self): + """ + The method to get the viewable + + Returns: + bool: A bool representing the viewable + """ + + return self.__viewable + + def set_viewable(self, viewable): + """ + The method to set the value to viewable + + Parameters: + viewable (bool) : A bool representing the viewable + """ + + if viewable is not None and not isinstance(viewable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: viewable EXPECTED TYPE: bool', None, None) + + self.__viewable = viewable + self.__key_modified['viewable'] = 1 + + def get_api_supported(self): + """ + The method to get the api_supported + + Returns: + bool: A bool representing the api_supported + """ + + return self.__api_supported + + def set_api_supported(self, api_supported): + """ + The method to set the value to api_supported + + Parameters: + api_supported (bool) : A bool representing the api_supported + """ + + if api_supported is not None and not isinstance(api_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_supported EXPECTED TYPE: bool', None, None) + + self.__api_supported = api_supported + self.__key_modified['api_supported'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_quick_create(self): + """ + The method to get the quick_create + + Returns: + bool: A bool representing the quick_create + """ + + return self.__quick_create + + def set_quick_create(self, quick_create): + """ + The method to set the value to quick_create + + Parameters: + quick_create (bool) : A bool representing the quick_create + """ + + if quick_create is not None and not isinstance(quick_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_create EXPECTED TYPE: bool', None, None) + + self.__quick_create = quick_create + self.__key_modified['quick_create'] = 1 + + def get_generated_type(self): + """ + The method to get the generated_type + + Returns: + Choice: An instance of Choice + """ + + return self.__generated_type + + def set_generated_type(self, generated_type): + """ + The method to set the value to generated_type + + Parameters: + generated_type (Choice) : An instance of Choice + """ + + if generated_type is not None and not isinstance(generated_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: Choice', None, None) + + self.__generated_type = generated_type + self.__key_modified['generated_type'] = 1 + + def get_feeds_required(self): + """ + The method to get the feeds_required + + Returns: + bool: A bool representing the feeds_required + """ + + return self.__feeds_required + + def set_feeds_required(self, feeds_required): + """ + The method to set the value to feeds_required + + Parameters: + feeds_required (bool) : A bool representing the feeds_required + """ + + if feeds_required is not None and not isinstance(feeds_required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feeds_required EXPECTED TYPE: bool', None, None) + + self.__feeds_required = feeds_required + self.__key_modified['feeds_required'] = 1 + + def get_scoring_supported(self): + """ + The method to get the scoring_supported + + Returns: + bool: A bool representing the scoring_supported + """ + + return self.__scoring_supported + + def set_scoring_supported(self, scoring_supported): + """ + The method to set the value to scoring_supported + + Parameters: + scoring_supported (bool) : A bool representing the scoring_supported + """ + + if scoring_supported is not None and not isinstance(scoring_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_supported EXPECTED TYPE: bool', None, None) + + self.__scoring_supported = scoring_supported + self.__key_modified['scoring_supported'] = 1 + + def get_webform_supported(self): + """ + The method to get the webform_supported + + Returns: + bool: A bool representing the webform_supported + """ + + return self.__webform_supported + + def set_webform_supported(self, webform_supported): + """ + The method to set the value to webform_supported + + Parameters: + webform_supported (bool) : A bool representing the webform_supported + """ + + if webform_supported is not None and not isinstance(webform_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webform_supported EXPECTED TYPE: bool', None, None) + + self.__webform_supported = webform_supported + self.__key_modified['webform_supported'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def get_arguments(self): + """ + The method to get the arguments + + Returns: + list: An instance of list + """ + + return self.__arguments + + def set_arguments(self, arguments): + """ + The method to set the value to arguments + + Parameters: + arguments (list) : An instance of list + """ + + if arguments is not None and not isinstance(arguments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: arguments EXPECTED TYPE: list', None, None) + + self.__arguments = arguments + self.__key_modified['arguments'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def get_chart_view_supported(self): + """ + The method to get the chart_view_supported + + Returns: + bool: A bool representing the chart_view_supported + """ + + return self.__chart_view_supported + + def set_chart_view_supported(self, chart_view_supported): + """ + The method to set the value to chart_view_supported + + Parameters: + chart_view_supported (bool) : A bool representing the chart_view_supported + """ + + if chart_view_supported is not None and not isinstance(chart_view_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_view_supported EXPECTED TYPE: bool', None, None) + + self.__chart_view_supported = chart_view_supported + self.__key_modified['chart_view_supported'] = 1 + + def get_profile_count(self): + """ + The method to get the profile_count + + Returns: + int: An int representing the profile_count + """ + + return self.__profile_count + + def set_profile_count(self, profile_count): + """ + The method to set the value to profile_count + + Parameters: + profile_count (int) : An int representing the profile_count + """ + + if profile_count is not None and not isinstance(profile_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profile_count EXPECTED TYPE: int', None, None) + + self.__profile_count = profile_count + self.__key_modified['profile_count'] = 1 + + def get_business_card_field_limit(self): + """ + The method to get the business_card_field_limit + + Returns: + int: An int representing the business_card_field_limit + """ + + return self.__business_card_field_limit + + def set_business_card_field_limit(self, business_card_field_limit): + """ + The method to set the value to business_card_field_limit + + Parameters: + business_card_field_limit (int) : An int representing the business_card_field_limit + """ + + if business_card_field_limit is not None and not isinstance(business_card_field_limit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_card_field_limit EXPECTED TYPE: int', None, None) + + self.__business_card_field_limit = business_card_field_limit + self.__key_modified['business_card_field_limit'] = 1 + + def get_track_current_data(self): + """ + The method to get the track_current_data + + Returns: + bool: A bool representing the track_current_data + """ + + return self.__track_current_data + + def set_track_current_data(self, track_current_data): + """ + The method to set the value to track_current_data + + Parameters: + track_current_data (bool) : A bool representing the track_current_data + """ + + if track_current_data is not None and not isinstance(track_current_data, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: track_current_data EXPECTED TYPE: bool', None, None) + + self.__track_current_data = track_current_data + self.__key_modified['track_current_data'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_parent_module(self): + """ + The method to get the parent_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__parent_module + + def set_parent_module(self, parent_module): + """ + The method to set the value to parent_module + + Parameters: + parent_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if parent_module is not None and not isinstance(parent_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__parent_module = parent_module + self.__key_modified['parent_module'] = 1 + + def get_activity_badge(self): + """ + The method to get the activity_badge + + Returns: + Choice: An instance of Choice + """ + + return self.__activity_badge + + def set_activity_badge(self, activity_badge): + """ + The method to set the value to activity_badge + + Parameters: + activity_badge (Choice) : An instance of Choice + """ + + if activity_badge is not None and not isinstance(activity_badge, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: activity_badge EXPECTED TYPE: Choice', None, None) + + self.__activity_badge = activity_badge + self.__key_modified['activity_badge'] = 1 + + def get_field_states(self): + """ + The method to get the field_states + + Returns: + list: An instance of list + """ + + return self.__field_states + + def set_field_states(self, field_states): + """ + The method to set the value to field_states + + Parameters: + field_states (list) : An instance of list + """ + + if field_states is not None and not isinstance(field_states, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_states EXPECTED TYPE: list', None, None) + + self.__field_states = field_states + self.__key_modified['$field_states'] = 1 + + def get_business_card_fields(self): + """ + The method to get the business_card_fields + + Returns: + list: An instance of list + """ + + return self.__business_card_fields + + def set_business_card_fields(self, business_card_fields): + """ + The method to set the value to business_card_fields + + Parameters: + business_card_fields (list) : An instance of list + """ + + if business_card_fields is not None and not isinstance(business_card_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_card_fields EXPECTED TYPE: list', None, None) + + self.__business_card_fields = business_card_fields + self.__key_modified['business_card_fields'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['$properties'] = 1 + + def get_on_demand_properties(self): + """ + The method to get the on_demand_properties + + Returns: + list: An instance of list + """ + + return self.__on_demand_properties + + def set_on_demand_properties(self, on_demand_properties): + """ + The method to set the value to on_demand_properties + + Parameters: + on_demand_properties (list) : An instance of list + """ + + if on_demand_properties is not None and not isinstance(on_demand_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: on_demand_properties EXPECTED TYPE: list', None, None) + + self.__on_demand_properties = on_demand_properties + self.__key_modified['$on_demand_properties'] = 1 + + def get_search_layout_fields(self): + """ + The method to get the search_layout_fields + + Returns: + list: An instance of list + """ + + return self.__search_layout_fields + + def set_search_layout_fields(self, search_layout_fields): + """ + The method to set the value to search_layout_fields + + Parameters: + search_layout_fields (list) : An instance of list + """ + + if search_layout_fields is not None and not isinstance(search_layout_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: search_layout_fields EXPECTED TYPE: list', None, None) + + self.__search_layout_fields = search_layout_fields + self.__key_modified['search_layout_fields'] = 1 + + def get_kanban_view_supported(self): + """ + The method to get the kanban_view_supported + + Returns: + bool: A bool representing the kanban_view_supported + """ + + return self.__kanban_view_supported + + def set_kanban_view_supported(self, kanban_view_supported): + """ + The method to set the value to kanban_view_supported + + Parameters: + kanban_view_supported (bool) : A bool representing the kanban_view_supported + """ + + if kanban_view_supported is not None and not isinstance(kanban_view_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: kanban_view_supported EXPECTED TYPE: bool', None, None) + + self.__kanban_view_supported = kanban_view_supported + self.__key_modified['kanban_view_supported'] = 1 + + def get_lookup_field_properties(self): + """ + The method to get the lookup_field_properties + + Returns: + LookupFieldProperties: An instance of LookupFieldProperties + """ + + return self.__lookup_field_properties + + def set_lookup_field_properties(self, lookup_field_properties): + """ + The method to set the value to lookup_field_properties + + Parameters: + lookup_field_properties (LookupFieldProperties) : An instance of LookupFieldProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.lookup_field_properties import LookupFieldProperties + except Exception: + from .lookup_field_properties import LookupFieldProperties + + if lookup_field_properties is not None and not isinstance(lookup_field_properties, LookupFieldProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_field_properties EXPECTED TYPE: LookupFieldProperties', None, None) + + self.__lookup_field_properties = lookup_field_properties + self.__key_modified['lookup_field_properties'] = 1 + + def get_kanban_view(self): + """ + The method to get the kanban_view + + Returns: + bool: A bool representing the kanban_view + """ + + return self.__kanban_view + + def set_kanban_view(self, kanban_view): + """ + The method to set the value to kanban_view + + Parameters: + kanban_view (bool) : A bool representing the kanban_view + """ + + if kanban_view is not None and not isinstance(kanban_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: kanban_view EXPECTED TYPE: bool', None, None) + + self.__kanban_view = kanban_view + self.__key_modified['kanban_view'] = 1 + + def get_related_lists(self): + """ + The method to get the related_lists + + Returns: + list: An instance of list + """ + + return self.__related_lists + + def set_related_lists(self, related_lists): + """ + The method to set the value to related_lists + + Parameters: + related_lists (list) : An instance of list + """ + + if related_lists is not None and not isinstance(related_lists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_lists EXPECTED TYPE: list', None, None) + + self.__related_lists = related_lists + self.__key_modified['related_lists'] = 1 + + def get_filter_status(self): + """ + The method to get the filter_status + + Returns: + bool: A bool representing the filter_status + """ + + return self.__filter_status + + def set_filter_status(self, filter_status): + """ + The method to set the value to filter_status + + Parameters: + filter_status (bool) : A bool representing the filter_status + """ + + if filter_status is not None and not isinstance(filter_status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filter_status EXPECTED TYPE: bool', None, None) + + self.__filter_status = filter_status + self.__key_modified['filter_status'] = 1 + + def get_related_list_properties(self): + """ + The method to get the related_list_properties + + Returns: + RelatedListProperties: An instance of RelatedListProperties + """ + + return self.__related_list_properties + + def set_related_list_properties(self, related_list_properties): + """ + The method to set the value to related_list_properties + + Parameters: + related_list_properties (RelatedListProperties) : An instance of RelatedListProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.related_list_properties import RelatedListProperties + except Exception: + from .related_list_properties import RelatedListProperties + + if related_list_properties is not None and not isinstance(related_list_properties, RelatedListProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_list_properties EXPECTED TYPE: RelatedListProperties', None, None) + + self.__related_list_properties = related_list_properties + self.__key_modified['related_list_properties'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + string: A string representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (string) : A string representing the display_field + """ + + if display_field is not None and not isinstance(display_field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: str', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_custom_view(self): + """ + The method to get the custom_view + + Returns: + CustomViews: An instance of CustomViews + """ + + return self.__custom_view + + def set_custom_view(self, custom_view): + """ + The method to set the value to custom_view + + Parameters: + custom_view (CustomViews) : An instance of CustomViews + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views import CustomViews + except Exception: + from ..custom_views import CustomViews + + if custom_view is not None and not isinstance(custom_view, CustomViews): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_view EXPECTED TYPE: CustomViews', None, None) + + self.__custom_view = custom_view + self.__key_modified['custom_view'] = 1 + + def get_zia_view(self): + """ + The method to get the zia_view + + Returns: + bool: A bool representing the zia_view + """ + + return self.__zia_view + + def set_zia_view(self, zia_view): + """ + The method to set the value to zia_view + + Parameters: + zia_view (bool) : A bool representing the zia_view + """ + + if zia_view is not None and not isinstance(zia_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_view EXPECTED TYPE: bool', None, None) + + self.__zia_view = zia_view + self.__key_modified['zia_view'] = 1 + + def get_default_mapping_fields(self): + """ + The method to get the default_mapping_fields + + Returns: + list: An instance of list + """ + + return self.__default_mapping_fields + + def set_default_mapping_fields(self, default_mapping_fields): + """ + The method to set the value to default_mapping_fields + + Parameters: + default_mapping_fields (list) : An instance of list + """ + + if default_mapping_fields is not None and not isinstance(default_mapping_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_mapping_fields EXPECTED TYPE: list', None, None) + + self.__default_mapping_fields = default_mapping_fields + self.__key_modified['default_mapping_fields'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_static_subform_properties(self): + """ + The method to get the static_subform_properties + + Returns: + StaticSubformProperties: An instance of StaticSubformProperties + """ + + return self.__static_subform_properties + + def set_static_subform_properties(self, static_subform_properties): + """ + The method to set the value to static_subform_properties + + Parameters: + static_subform_properties (StaticSubformProperties) : An instance of StaticSubformProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.static_subform_properties import StaticSubformProperties + except Exception: + from .static_subform_properties import StaticSubformProperties + + if static_subform_properties is not None and not isinstance(static_subform_properties, StaticSubformProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_subform_properties EXPECTED TYPE: StaticSubformProperties', None, None) + + self.__static_subform_properties = static_subform_properties + self.__key_modified['static_subform_properties'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/modules_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/modules_operations.py new file mode 100644 index 0000000..f64d3b7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/modules_operations.py @@ -0,0 +1,196 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class ModulesOperations(object): + def __init__(self): + """Creates an instance of ModulesOperations""" + pass + + def get_modules(self, header_instance=None): + """ + The method to get modules + + Parameters: + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/modules' + 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.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_module_by_api_name(self, api_name): + """ + The method to get module by api name + + Parameters: + api_name (string) : A string representing the api_name + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/modules/' + api_path = api_path + str(api_name) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_module_by_api_name(self, api_name, request): + """ + The method to update module by api name + + Parameters: + api_name (string) : A string representing the api_name + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', 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/v7/settings/modules/' + api_path = api_path + str(api_name) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_module(self, id): + """ + The method to get module + + 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/v7/settings/modules/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_module(self, id, request): + """ + The method to update module + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/modules/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetModulesHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Modules.GetModulesHeader') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/related_list_properties.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/related_list_properties.py new file mode 100644 index 0000000..3a8d66f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/related_list_properties.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedListProperties(object): + def __init__(self): + """Creates an instance of RelatedListProperties""" + + self.__sort_by = None + self.__fields = None + self.__sort_order = None + self.__key_modified = dict() + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MinifiedField + except Exception: + from ..fields import MinifiedField + + if sort_by is not None and not isinstance(sort_by, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: MinifiedField', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/response_wrapper.py new file mode 100644 index 0000000..e4f6217 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__modules = None + self.__key_modified = dict() + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/sharing_properties.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/sharing_properties.py new file mode 100644 index 0000000..aeb4540 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/sharing_properties.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SharingProperties(object): + def __init__(self): + """Creates an instance of SharingProperties""" + + self.__scheduler_status = None + self.__share_preference_enabled = None + self.__share_permission = None + self.__key_modified = dict() + + def get_scheduler_status(self): + """ + The method to get the scheduler_status + + Returns: + string: A string representing the scheduler_status + """ + + return self.__scheduler_status + + def set_scheduler_status(self, scheduler_status): + """ + The method to set the value to scheduler_status + + Parameters: + scheduler_status (string) : A string representing the scheduler_status + """ + + if scheduler_status is not None and not isinstance(scheduler_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduler_status EXPECTED TYPE: str', None, None) + + self.__scheduler_status = scheduler_status + self.__key_modified['scheduler_status'] = 1 + + def get_share_preference_enabled(self): + """ + The method to get the share_preference_enabled + + Returns: + bool: A bool representing the share_preference_enabled + """ + + return self.__share_preference_enabled + + def set_share_preference_enabled(self, share_preference_enabled): + """ + The method to set the value to share_preference_enabled + + Parameters: + share_preference_enabled (bool) : A bool representing the share_preference_enabled + """ + + if share_preference_enabled is not None and not isinstance(share_preference_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_preference_enabled EXPECTED TYPE: bool', None, None) + + self.__share_preference_enabled = share_preference_enabled + self.__key_modified['share_preference_enabled'] = 1 + + def get_share_permission(self): + """ + The method to get the share_permission + + Returns: + Choice: An instance of Choice + """ + + return self.__share_permission + + def set_share_permission(self, share_permission): + """ + The method to set the value to share_permission + + Parameters: + share_permission (Choice) : An instance of Choice + """ + + if share_permission is not None and not isinstance(share_permission, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_permission EXPECTED TYPE: Choice', None, None) + + self.__share_permission = share_permission + self.__key_modified['share_permission'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_field.py new file mode 100644 index 0000000..0872276 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class StaticSubformField(object): + def __init__(self): + """Creates an instance of StaticSubformField""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_properties.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_properties.py new file mode 100644 index 0000000..8914085 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_properties.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class StaticSubformProperties(object): + def __init__(self): + """Creates an instance of StaticSubformProperties""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/success_response.py new file mode 100644 index 0000000..18ceaa6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/territory.py new file mode 100644 index 0000000..3c74f4f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/modules/territory.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__name = None + self.__id = None + self.__subordinates = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/__init__.py new file mode 100644 index 0000000..5dcffb8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/__init__.py @@ -0,0 +1,12 @@ +from .action_wrapper import ActionWrapper +from .note import Note +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .notes_operations import NotesOperations, GetNotesParam, GetNotesHeader, DeleteNotesParam, GetNoteParam, GetNoteHeader +from .success_response import SuccessResponse +from .parent_id import ParentId +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_wrapper.py new file mode 100644 index 0000000..3079ec3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/api_exception.py new file mode 100644 index 0000000..f9735b2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/info.py new file mode 100644 index 0000000..0f34975 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/info.py @@ -0,0 +1,276 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__sort_by = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__sort_order = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/note.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/note.py new file mode 100644 index 0000000..bfbd7d4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/note.py @@ -0,0 +1,473 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Note(object): + def __init__(self): + """Creates an instance of Note""" + + self.__modified_time = None + self.__attachments = None + self.__owner = None + self.__created_time = None + self.__parent_id = None + self.__editable = None + self.__is_shared_to_client = None + self.__sharing_permission = None + self.__modified_by = None + self.__size = None + self.__state = None + self.__voice_note = None + self.__id = None + self.__created_by = None + self.__note_title = None + self.__note_content = None + self.__key_modified = dict() + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['$attachments'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['Owner'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['Created_Time'] = 1 + + def get_parent_id(self): + """ + The method to get the parent_id + + Returns: + ParentId: An instance of ParentId + """ + + return self.__parent_id + + def set_parent_id(self, parent_id): + """ + The method to set the value to parent_id + + Parameters: + parent_id (ParentId) : An instance of ParentId + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.parent_id import ParentId + except Exception: + from .parent_id import ParentId + + if parent_id is not None and not isinstance(parent_id, ParentId): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: ParentId', None, None) + + self.__parent_id = parent_id + self.__key_modified['Parent_Id'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['$editable'] = 1 + + def get_is_shared_to_client(self): + """ + The method to get the is_shared_to_client + + Returns: + bool: A bool representing the is_shared_to_client + """ + + return self.__is_shared_to_client + + def set_is_shared_to_client(self, is_shared_to_client): + """ + The method to set the value to is_shared_to_client + + Parameters: + is_shared_to_client (bool) : A bool representing the is_shared_to_client + """ + + if is_shared_to_client is not None and not isinstance(is_shared_to_client, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_shared_to_client EXPECTED TYPE: bool', None, None) + + self.__is_shared_to_client = is_shared_to_client + self.__key_modified['$is_shared_to_client'] = 1 + + def get_sharing_permission(self): + """ + The method to get the sharing_permission + + Returns: + string: A string representing the sharing_permission + """ + + return self.__sharing_permission + + def set_sharing_permission(self, sharing_permission): + """ + The method to set the value to sharing_permission + + Parameters: + sharing_permission (string) : A string representing the sharing_permission + """ + + if sharing_permission is not None and not isinstance(sharing_permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: str', None, None) + + self.__sharing_permission = sharing_permission + self.__key_modified['$sharing_permission'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['Modified_By'] = 1 + + def get_size(self): + """ + The method to get the size + + Returns: + string: A string representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (string) : A string representing the size + """ + + if size is not None and not isinstance(size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: str', None, None) + + self.__size = size + self.__key_modified['$size'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['$state'] = 1 + + def get_voice_note(self): + """ + The method to get the voice_note + + Returns: + bool: A bool representing the voice_note + """ + + return self.__voice_note + + def set_voice_note(self, voice_note): + """ + The method to set the value to voice_note + + Parameters: + voice_note (bool) : A bool representing the voice_note + """ + + if voice_note is not None and not isinstance(voice_note, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: voice_note EXPECTED TYPE: bool', None, None) + + self.__voice_note = voice_note + self.__key_modified['$voice_note'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['Created_By'] = 1 + + def get_note_title(self): + """ + The method to get the note_title + + Returns: + string: A string representing the note_title + """ + + return self.__note_title + + def set_note_title(self, note_title): + """ + The method to set the value to note_title + + Parameters: + note_title (string) : A string representing the note_title + """ + + if note_title is not None and not isinstance(note_title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: note_title EXPECTED TYPE: str', None, None) + + self.__note_title = note_title + self.__key_modified['Note_Title'] = 1 + + def get_note_content(self): + """ + The method to get the note_content + + Returns: + string: A string representing the note_content + """ + + return self.__note_content + + def set_note_content(self, note_content): + """ + The method to set the value to note_content + + Parameters: + note_content (string) : A string representing the note_content + """ + + if note_content is not None and not isinstance(note_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: note_content EXPECTED TYPE: str', None, None) + + self.__note_content = note_content + self.__key_modified['Note_Content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/notes_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/notes_operations.py new file mode 100644 index 0000000..7024659 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/notes_operations.py @@ -0,0 +1,316 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class NotesOperations(object): + def __init__(self): + """Creates an instance of NotesOperations""" + pass + + def get_notes(self, param_instance=None, header_instance=None): + """ + The method to get notes + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Notes' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_notes(self, request): + """ + The method to create notes + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Notes' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_notes(self, request): + """ + The method to update notes + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Notes' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_notes(self, param_instance=None): + """ + The method to delete notes + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Notes' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_note(self, id, param_instance=None, header_instance=None): + """ + The method to get note + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Notes/' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_note(self, id, request): + """ + The method to update note + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/Notes/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_note(self, id): + """ + The method to delete note + + 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/v7/Notes/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetNotesParam(object): + page = Param('page', 'com.zoho.crm.api.Notes.GetNotesParam') + per_page = Param('per_page', 'com.zoho.crm.api.Notes.GetNotesParam') + fields = Param('fields', 'com.zoho.crm.api.Notes.GetNotesParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.Notes.GetNotesParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.Notes.GetNotesParam') + ids = Param('ids', 'com.zoho.crm.api.Notes.GetNotesParam') + + +class GetNotesHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Notes.GetNotesHeader') + + +class DeleteNotesParam(object): + ids = Param('ids', 'com.zoho.crm.api.Notes.DeleteNotesParam') + + +class GetNoteParam(object): + fields = Param('fields', 'com.zoho.crm.api.Notes.GetNoteParam') + + +class GetNoteHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Notes.GetNoteHeader') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/parent_id.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/parent_id.py new file mode 100644 index 0000000..e546117 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/parent_id.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ParentId(object): + def __init__(self): + """Creates an instance of ParentId""" + + self.__module = None + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/response_wrapper.py new file mode 100644 index 0000000..b3a5be8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/success_response.py new file mode 100644 index 0000000..e96d791 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notes/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/__init__.py new file mode 100644 index 0000000..b299543 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .notifications_operations import NotificationsOperations, GetNotificationsParam, DeleteNotificationParam +from .criteria import Criteria +from .module import Module +from .body_wrapper import BodyWrapper +from .notification_condition import NotificationCondition +from .notification import Notification +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .field import Field +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .event import Event +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_wrapper.py new file mode 100644 index 0000000..a1d86e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__watch = None + self.__key_modified = dict() + + def get_watch(self): + """ + The method to get the watch + + Returns: + list: An instance of list + """ + + return self.__watch + + def set_watch(self, watch): + """ + The method to set the value to watch + + Parameters: + watch (list) : An instance of list + """ + + if watch is not None and not isinstance(watch, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: list', None, None) + + self.__watch = watch + self.__key_modified['watch'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/api_exception.py new file mode 100644 index 0000000..4d11572 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.notifications.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/body_wrapper.py new file mode 100644 index 0000000..7979836 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__watch = None + self.__key_modified = dict() + + def get_watch(self): + """ + The method to get the watch + + Returns: + list: An instance of list + """ + + return self.__watch + + def set_watch(self, watch): + """ + The method to set the value to watch + + Parameters: + watch (list) : An instance of list + """ + + if watch is not None and not isinstance(watch, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: list', None, None) + + self.__watch = watch + self.__key_modified['watch'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/criteria.py new file mode 100644 index 0000000..f1c146d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/event.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/event.py new file mode 100644 index 0000000..6e90a88 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/event.py @@ -0,0 +1,201 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Event(object): + def __init__(self): + """Creates an instance of Event""" + + self.__resource_name = None + self.__channel_expiry = None + self.__resource_id = None + self.__resource_uri = None + self.__channel_id = None + self.__notification_condition = None + self.__key_modified = dict() + + def get_resource_name(self): + """ + The method to get the resource_name + + Returns: + string: A string representing the resource_name + """ + + return self.__resource_name + + def set_resource_name(self, resource_name): + """ + The method to set the value to resource_name + + Parameters: + resource_name (string) : A string representing the resource_name + """ + + if resource_name is not None and not isinstance(resource_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_name EXPECTED TYPE: str', None, None) + + self.__resource_name = resource_name + self.__key_modified['resource_name'] = 1 + + def get_channel_expiry(self): + """ + The method to get the channel_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__channel_expiry + + 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 get_resource_id(self): + """ + The method to get the resource_id + + Returns: + int: An int representing the resource_id + """ + + return self.__resource_id + + def set_resource_id(self, resource_id): + """ + The method to set the value to resource_id + + Parameters: + resource_id (int) : An int representing the resource_id + """ + + if resource_id is not None and not isinstance(resource_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_id EXPECTED TYPE: int', None, None) + + self.__resource_id = resource_id + self.__key_modified['resource_id'] = 1 + + def get_resource_uri(self): + """ + The method to get the resource_uri + + Returns: + string: A string representing the resource_uri + """ + + return self.__resource_uri + + def set_resource_uri(self, resource_uri): + """ + The method to set the value to resource_uri + + Parameters: + resource_uri (string) : A string representing the resource_uri + """ + + if resource_uri is not None and not isinstance(resource_uri, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_uri EXPECTED TYPE: str', None, None) + + self.__resource_uri = resource_uri + self.__key_modified['resource_uri'] = 1 + + def get_channel_id(self): + """ + The method to get the channel_id + + Returns: + string: A string representing the channel_id + """ + + return self.__channel_id + + def set_channel_id(self, channel_id): + """ + The method to set the value to channel_id + + Parameters: + channel_id (string) : A string representing the channel_id + """ + + if channel_id is not None and not isinstance(channel_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: channel_id EXPECTED TYPE: str', None, None) + + self.__channel_id = channel_id + self.__key_modified['channel_id'] = 1 + + def get_notification_condition(self): + """ + The method to get the notification_condition + + Returns: + list: An instance of list + """ + + return self.__notification_condition + + def set_notification_condition(self, notification_condition): + """ + The method to set the value to notification_condition + + Parameters: + notification_condition (list) : An instance of list + """ + + if notification_condition is not None and not isinstance(notification_condition, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notification_condition EXPECTED TYPE: list', None, None) + + self.__notification_condition = notification_condition + self.__key_modified['notification_condition'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notification.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notification.py new file mode 100644 index 0000000..4985b67 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notification.py @@ -0,0 +1,379 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.event import Event +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .event import Event + + +class Notification(Event): + def __init__(self): + """Creates an instance of Notification""" + super().__init__() + + self.__channel_id = None + self.__notify_url = None + self.__events = None + self.__token = None + self.__fields = None + self.__notify_on_related_action = None + self.__return_affected_field_values = None + self.__deleteevents = None + self.__resource_name = None + self.__channel_expiry = None + self.__resource_id = None + self.__resource_uri = None + self.__notification_condition = None + self.__key_modified = dict() + + def get_channel_id(self): + """ + The method to get the channel_id + + Returns: + string: A string representing the channel_id + """ + + return self.__channel_id + + def set_channel_id(self, channel_id): + """ + The method to set the value to channel_id + + Parameters: + channel_id (string) : A string representing the channel_id + """ + + if channel_id is not None and not isinstance(channel_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: channel_id EXPECTED TYPE: str', None, None) + + self.__channel_id = channel_id + self.__key_modified['channel_id'] = 1 + + def get_notify_url(self): + """ + The method to get the notify_url + + Returns: + string: A string representing the notify_url + """ + + return self.__notify_url + + def set_notify_url(self, notify_url): + """ + The method to set the value to notify_url + + Parameters: + notify_url (string) : A string representing the notify_url + """ + + if notify_url is not None and not isinstance(notify_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_url EXPECTED TYPE: str', None, None) + + self.__notify_url = notify_url + self.__key_modified['notify_url'] = 1 + + def get_events(self): + """ + The method to get the events + + Returns: + list: An instance of list + """ + + return self.__events + + def set_events(self, events): + """ + The method to set the value to events + + Parameters: + events (list) : An instance of list + """ + + if events is not None and not isinstance(events, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: events EXPECTED TYPE: list', None, None) + + self.__events = events + self.__key_modified['events'] = 1 + + def get_token(self): + """ + The method to get the token + + Returns: + string: A string representing the token + """ + + return self.__token + + def set_token(self, token): + """ + The method to set the value to token + + Parameters: + token (string) : A string representing the token + """ + + if token is not None and not isinstance(token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: token EXPECTED TYPE: str', None, None) + + self.__token = token + self.__key_modified['token'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + dict: An instance of dict + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (dict) : An instance of dict + """ + + if fields is not None and not isinstance(fields, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: dict', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_notify_on_related_action(self): + """ + The method to get the notify_on_related_action + + Returns: + bool: A bool representing the notify_on_related_action + """ + + return self.__notify_on_related_action + + def set_notify_on_related_action(self, notify_on_related_action): + """ + The method to set the value to notify_on_related_action + + Parameters: + notify_on_related_action (bool) : A bool representing the notify_on_related_action + """ + + if notify_on_related_action is not None and not isinstance(notify_on_related_action, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_on_related_action EXPECTED TYPE: bool', None, None) + + self.__notify_on_related_action = notify_on_related_action + self.__key_modified['notify_on_related_action'] = 1 + + def get_return_affected_field_values(self): + """ + The method to get the return_affected_field_values + + Returns: + bool: A bool representing the return_affected_field_values + """ + + return self.__return_affected_field_values + + def set_return_affected_field_values(self, return_affected_field_values): + """ + The method to set the value to return_affected_field_values + + Parameters: + return_affected_field_values (bool) : A bool representing the return_affected_field_values + """ + + if return_affected_field_values is not None and not isinstance(return_affected_field_values, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_affected_field_values EXPECTED TYPE: bool', None, None) + + self.__return_affected_field_values = return_affected_field_values + self.__key_modified['return_affected_field_values'] = 1 + + def get_deleteevents(self): + """ + The method to get the deleteevents + + Returns: + Choice: An instance of Choice + """ + + return self.__deleteevents + + def set_deleteevents(self, deleteevents): + """ + The method to set the value to deleteevents + + Parameters: + deleteevents (Choice) : An instance of Choice + """ + + if deleteevents is not None and not isinstance(deleteevents, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleteevents EXPECTED TYPE: Choice', None, None) + + self.__deleteevents = deleteevents + self.__key_modified['_delete_events'] = 1 + + def get_resource_name(self): + """ + The method to get the resource_name + + Returns: + string: A string representing the resource_name + """ + + return self.__resource_name + + def set_resource_name(self, resource_name): + """ + The method to set the value to resource_name + + Parameters: + resource_name (string) : A string representing the resource_name + """ + + if resource_name is not None and not isinstance(resource_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_name EXPECTED TYPE: str', None, None) + + self.__resource_name = resource_name + self.__key_modified['resource_name'] = 1 + + def get_channel_expiry(self): + """ + The method to get the channel_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__channel_expiry + + 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 get_resource_id(self): + """ + The method to get the resource_id + + Returns: + int: An int representing the resource_id + """ + + return self.__resource_id + + def set_resource_id(self, resource_id): + """ + The method to set the value to resource_id + + Parameters: + resource_id (int) : An int representing the resource_id + """ + + if resource_id is not None and not isinstance(resource_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_id EXPECTED TYPE: int', None, None) + + self.__resource_id = resource_id + self.__key_modified['resource_id'] = 1 + + def get_resource_uri(self): + """ + The method to get the resource_uri + + Returns: + string: A string representing the resource_uri + """ + + return self.__resource_uri + + def set_resource_uri(self, resource_uri): + """ + The method to set the value to resource_uri + + Parameters: + resource_uri (string) : A string representing the resource_uri + """ + + if resource_uri is not None and not isinstance(resource_uri, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_uri EXPECTED TYPE: str', None, None) + + self.__resource_uri = resource_uri + self.__key_modified['resource_uri'] = 1 + + def get_notification_condition(self): + """ + The method to get the notification_condition + + Returns: + list: An instance of list + """ + + return self.__notification_condition + + def set_notification_condition(self, notification_condition): + """ + The method to set the value to notification_condition + + Parameters: + notification_condition (list) : An instance of list + """ + + if notification_condition is not None and not isinstance(notification_condition, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notification_condition EXPECTED TYPE: list', None, None) + + self.__notification_condition = notification_condition + self.__key_modified['notification_condition'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notification_condition.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notification_condition.py new file mode 100644 index 0000000..cadb891 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notification_condition.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NotificationCondition(object): + def __init__(self): + """Creates an instance of NotificationCondition""" + + self.__type = None + self.__module = None + self.__field_selection = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_field_selection(self): + """ + The method to get the field_selection + + Returns: + Criteria: An instance of Criteria + """ + + return self.__field_selection + + def set_field_selection(self, field_selection): + """ + The method to set the value to field_selection + + Parameters: + field_selection (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.criteria import Criteria + except Exception: + from .criteria import Criteria + + if field_selection is not None and not isinstance(field_selection, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_selection EXPECTED TYPE: Criteria', None, None) + + self.__field_selection = field_selection + self.__key_modified['field_selection'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notifications_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notifications_operations.py new file mode 100644 index 0000000..6a77ed6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/notifications_operations.py @@ -0,0 +1,242 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class NotificationsOperations(object): + def __init__(self): + """Creates an instance of NotificationsOperations""" + pass + + def get_notifications(self, param_instance=None): + """ + The method to get notifications + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/actions/watch' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def enable_notifications(self, request): + """ + The method to enable notifications + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_notifications(self, request): + """ + The method to update notifications + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_notification(self, request): + """ + The method to update notification + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def disable_notification(self, request): + """ + The method to disable notification + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_notification(self, param_instance=None): + """ + The method to delete notification + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/actions/watch' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetNotificationsParam(object): + page = Param('page', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + per_page = Param('per_page', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + channel_id = Param('channel_id', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + module = Param('module', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + + +class DeleteNotificationParam(object): + channel_ids = Param('channel_ids', 'com.zoho.crm.api.Notifications.DeleteNotificationParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/response_wrapper.py new file mode 100644 index 0000000..c8d87d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__watch = None + self.__info = None + self.__key_modified = dict() + + def get_watch(self): + """ + The method to get the watch + + Returns: + list: An instance of list + """ + + return self.__watch + + def set_watch(self, watch): + """ + The method to set the value to watch + + Parameters: + watch (list) : An instance of list + """ + + if watch is not None and not isinstance(watch, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: list', None, None) + + self.__watch = watch + self.__key_modified['watch'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/success_response.py new file mode 100644 index 0000000..7544ce9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/notifications/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/__init__.py new file mode 100644 index 0000000..883c2f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .hierarchy_preferences import HierarchyPreferences +from .resource import Resource +from .org import Org +from .checkin_preferences import CheckinPreferences +from .license_details import LicenseDetails +from .api_exception import APIException +from .response_handler import ResponseHandler +from .feature import Feature +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .org_operations import OrgOperations, GetOrganizationHeader diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/action_wrapper.py new file mode 100644 index 0000000..d4c66be --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__org = None + self.__key_modified = dict() + + def get_org(self): + """ + The method to get the org + + Returns: + list: An instance of list + """ + + return self.__org + + def set_org(self, org): + """ + The method to set the value to org + + Parameters: + org (list) : An instance of list + """ + + if org is not None and not isinstance(org, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org EXPECTED TYPE: list', None, None) + + self.__org = org + self.__key_modified['org'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/api_exception.py new file mode 100644 index 0000000..c88828c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/api_exception.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + self.__api_name = None + self.__json_path = None + self.__features = None + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def get_features(self): + """ + The method to get the features + + Returns: + list: An instance of list + """ + + return self.__features + + def set_features(self, features): + """ + The method to set the value to features + + Parameters: + features (list) : An instance of list + """ + + if features is not None and not isinstance(features, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: features EXPECTED TYPE: list', None, None) + + self.__features = features + self.__key_modified['features'] = 1 diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/checkin_preferences.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/checkin_preferences.py new file mode 100644 index 0000000..b76db6b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/checkin_preferences.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CheckinPreferences(object): + def __init__(self): + """Creates an instance of CheckinPreferences""" + + self.__restricted_event_types = None + self.__key_modified = dict() + + def get_restricted_event_types(self): + """ + The method to get the restricted_event_types + + Returns: + string: A string representing the restricted_event_types + """ + + return self.__restricted_event_types + + def set_restricted_event_types(self, restricted_event_types): + """ + The method to set the value to restricted_event_types + + Parameters: + restricted_event_types (string) : A string representing the restricted_event_types + """ + + if restricted_event_types is not None and not isinstance(restricted_event_types, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_event_types EXPECTED TYPE: str', None, None) + + self.__restricted_event_types = restricted_event_types + self.__key_modified['restricted_event_types'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/feature.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/feature.py new file mode 100644 index 0000000..5830e65 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/feature.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Feature(object): + def __init__(self): + """Creates an instance of Feature""" + + self.__name = None + self.__resources = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/file_body_wrapper.py new file mode 100644 index 0000000..4c06736 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/hierarchy_preferences.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/hierarchy_preferences.py new file mode 100644 index 0000000..a75b4e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/hierarchy_preferences.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class HierarchyPreferences(object): + def __init__(self): + """Creates an instance of HierarchyPreferences""" + + self.__type = None + self.__strictly_reporting = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_strictly_reporting(self): + """ + The method to get the strictly_reporting + + Returns: + bool: A bool representing the strictly_reporting + """ + + return self.__strictly_reporting + + def set_strictly_reporting(self, strictly_reporting): + """ + The method to set the value to strictly_reporting + + Parameters: + strictly_reporting (bool) : A bool representing the strictly_reporting + """ + + if strictly_reporting is not None and not isinstance(strictly_reporting, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: strictly_reporting EXPECTED TYPE: bool', None, None) + + self.__strictly_reporting = strictly_reporting + self.__key_modified['strictly_reporting'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/license_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/license_details.py new file mode 100644 index 0000000..40bcf25 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/license_details.py @@ -0,0 +1,226 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LicenseDetails(object): + def __init__(self): + """Creates an instance of LicenseDetails""" + + self.__paid_expiry = None + self.__users_license_purchased = None + self.__trial_type = None + self.__trial_expiry = None + self.__paid = None + self.__paid_type = None + self.__trial_action = None + self.__key_modified = dict() + + def get_paid_expiry(self): + """ + The method to get the paid_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__paid_expiry + + def set_paid_expiry(self, paid_expiry): + """ + The method to set the value to paid_expiry + + Parameters: + paid_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if paid_expiry is not None and not isinstance(paid_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paid_expiry EXPECTED TYPE: datetime', None, None) + + self.__paid_expiry = paid_expiry + self.__key_modified['paid_expiry'] = 1 + + def get_users_license_purchased(self): + """ + The method to get the users_license_purchased + + Returns: + int: An int representing the users_license_purchased + """ + + return self.__users_license_purchased + + def set_users_license_purchased(self, users_license_purchased): + """ + The method to set the value to users_license_purchased + + Parameters: + users_license_purchased (int) : An int representing the users_license_purchased + """ + + if users_license_purchased is not None and not isinstance(users_license_purchased, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_license_purchased EXPECTED TYPE: int', None, None) + + self.__users_license_purchased = users_license_purchased + self.__key_modified['users_license_purchased'] = 1 + + def get_trial_type(self): + """ + The method to get the trial_type + + Returns: + string: A string representing the trial_type + """ + + return self.__trial_type + + def set_trial_type(self, trial_type): + """ + The method to set the value to trial_type + + Parameters: + trial_type (string) : A string representing the trial_type + """ + + if trial_type is not None and not isinstance(trial_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trial_type EXPECTED TYPE: str', None, None) + + self.__trial_type = trial_type + self.__key_modified['trial_type'] = 1 + + def get_trial_expiry(self): + """ + The method to get the trial_expiry + + Returns: + string: A string representing the trial_expiry + """ + + return self.__trial_expiry + + def set_trial_expiry(self, trial_expiry): + """ + The method to set the value to trial_expiry + + Parameters: + trial_expiry (string) : A string representing the trial_expiry + """ + + if trial_expiry is not None and not isinstance(trial_expiry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trial_expiry EXPECTED TYPE: str', None, None) + + self.__trial_expiry = trial_expiry + self.__key_modified['trial_expiry'] = 1 + + def get_paid(self): + """ + The method to get the paid + + Returns: + bool: A bool representing the paid + """ + + return self.__paid + + def set_paid(self, paid): + """ + The method to set the value to paid + + Parameters: + paid (bool) : A bool representing the paid + """ + + if paid is not None and not isinstance(paid, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paid EXPECTED TYPE: bool', None, None) + + self.__paid = paid + self.__key_modified['paid'] = 1 + + def get_paid_type(self): + """ + The method to get the paid_type + + Returns: + string: A string representing the paid_type + """ + + return self.__paid_type + + def set_paid_type(self, paid_type): + """ + The method to set the value to paid_type + + Parameters: + paid_type (string) : A string representing the paid_type + """ + + if paid_type is not None and not isinstance(paid_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paid_type EXPECTED TYPE: str', None, None) + + self.__paid_type = paid_type + self.__key_modified['paid_type'] = 1 + + def get_trial_action(self): + """ + The method to get the trial_action + + Returns: + string: A string representing the trial_action + """ + + return self.__trial_action + + def set_trial_action(self, trial_action): + """ + The method to set the value to trial_action + + Parameters: + trial_action (string) : A string representing the trial_action + """ + + if trial_action is not None and not isinstance(trial_action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trial_action EXPECTED TYPE: str', None, None) + + self.__trial_action = trial_action + self.__key_modified['trial_action'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/org.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/org.py new file mode 100644 index 0000000..d7a3de1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/org.py @@ -0,0 +1,1138 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Org(object): + def __init__(self): + """Creates an instance of Org""" + + self.__country = None + self.__photo_id = None + self.__city = None + self.__description = None + self.__mc_status = None + self.__gapps_enabled = None + self.__translation_enabled = None + self.__street = None + self.__domain_name = None + self.__alias = None + self.__currency = None + self.__id = None + self.__state = None + self.__fax = None + self.__zip = None + self.__employee_count = None + self.__website = None + self.__currency_symbol = None + self.__mobile = None + self.__currency_locale = None + self.__primary_zuid = None + self.__zia_portal_id = None + self.__time_zone = None + self.__zgid = None + self.__country_code = None + self.__deletable_org_account = None + self.__license_details = None + self.__hierarchy_preferences = None + self.__phone = None + self.__company_name = None + self.__privacy_settings = None + self.__primary_email = None + self.__iso_code = None + self.__hipaa_compliance_enabled = None + self.__lite_users_enabled = None + self.__max_per_page = None + self.__ezgid = None + self.__call_icon = None + self.__oauth_presence = None + self.__zia_zgid = None + self.__checkin_preferences = None + self.__type = None + self.__created_time = None + self.__key_modified = dict() + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.__country + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.__country = country + self.__key_modified['country'] = 1 + + def get_photo_id(self): + """ + The method to get the photo_id + + Returns: + string: A string representing the photo_id + """ + + return self.__photo_id + + def set_photo_id(self, photo_id): + """ + The method to set the value to photo_id + + Parameters: + photo_id (string) : A string representing the photo_id + """ + + if photo_id is not None and not isinstance(photo_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: photo_id EXPECTED TYPE: str', None, None) + + self.__photo_id = photo_id + self.__key_modified['photo_id'] = 1 + + def get_city(self): + """ + The method to get the city + + Returns: + string: A string representing the city + """ + + return self.__city + + def set_city(self, city): + """ + The method to set the value to city + + Parameters: + city (string) : A string representing the city + """ + + if city is not None and not isinstance(city, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: city EXPECTED TYPE: str', None, None) + + self.__city = city + self.__key_modified['city'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_mc_status(self): + """ + The method to get the mc_status + + Returns: + bool: A bool representing the mc_status + """ + + return self.__mc_status + + def set_mc_status(self, mc_status): + """ + The method to set the value to mc_status + + Parameters: + mc_status (bool) : A bool representing the mc_status + """ + + if mc_status is not None and not isinstance(mc_status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mc_status EXPECTED TYPE: bool', None, None) + + self.__mc_status = mc_status + self.__key_modified['mc_status'] = 1 + + def get_gapps_enabled(self): + """ + The method to get the gapps_enabled + + Returns: + bool: A bool representing the gapps_enabled + """ + + return self.__gapps_enabled + + def set_gapps_enabled(self, gapps_enabled): + """ + The method to set the value to gapps_enabled + + Parameters: + gapps_enabled (bool) : A bool representing the gapps_enabled + """ + + if gapps_enabled is not None and not isinstance(gapps_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: gapps_enabled EXPECTED TYPE: bool', None, None) + + self.__gapps_enabled = gapps_enabled + self.__key_modified['gapps_enabled'] = 1 + + def get_translation_enabled(self): + """ + The method to get the translation_enabled + + Returns: + bool: A bool representing the translation_enabled + """ + + return self.__translation_enabled + + def set_translation_enabled(self, translation_enabled): + """ + The method to set the value to translation_enabled + + Parameters: + translation_enabled (bool) : A bool representing the translation_enabled + """ + + if translation_enabled is not None and not isinstance(translation_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: translation_enabled EXPECTED TYPE: bool', None, None) + + self.__translation_enabled = translation_enabled + self.__key_modified['translation_enabled'] = 1 + + def get_street(self): + """ + The method to get the street + + Returns: + string: A string representing the street + """ + + return self.__street + + def set_street(self, street): + """ + The method to set the value to street + + Parameters: + street (string) : A string representing the street + """ + + if street is not None and not isinstance(street, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: street EXPECTED TYPE: str', None, None) + + self.__street = street + self.__key_modified['street'] = 1 + + def get_domain_name(self): + """ + The method to get the domain_name + + Returns: + string: A string representing the domain_name + """ + + return self.__domain_name + + def set_domain_name(self, domain_name): + """ + The method to set the value to domain_name + + Parameters: + domain_name (string) : A string representing the domain_name + """ + + if domain_name is not None and not isinstance(domain_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: domain_name EXPECTED TYPE: str', None, None) + + self.__domain_name = domain_name + self.__key_modified['domain_name'] = 1 + + def get_alias(self): + """ + The method to get the alias + + Returns: + string: A string representing the alias + """ + + return self.__alias + + def set_alias(self, alias): + """ + The method to set the value to alias + + Parameters: + alias (string) : A string representing the alias + """ + + if alias is not None and not isinstance(alias, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alias EXPECTED TYPE: str', None, None) + + self.__alias = alias + self.__key_modified['alias'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + string: A string representing the currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (string) : A string representing the currency + """ + + if currency is not None and not isinstance(currency, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: str', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_fax(self): + """ + The method to get the fax + + Returns: + string: A string representing the fax + """ + + return self.__fax + + def set_fax(self, fax): + """ + The method to set the value to fax + + Parameters: + fax (string) : A string representing the fax + """ + + if fax is not None and not isinstance(fax, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fax EXPECTED TYPE: str', None, None) + + self.__fax = fax + self.__key_modified['fax'] = 1 + + def get_zip(self): + """ + The method to get the zip + + Returns: + string: A string representing the zip + """ + + return self.__zip + + def set_zip(self, zip): + """ + The method to set the value to zip + + Parameters: + zip (string) : A string representing the zip + """ + + if zip is not None and not isinstance(zip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zip EXPECTED TYPE: str', None, None) + + self.__zip = zip + self.__key_modified['zip'] = 1 + + def get_employee_count(self): + """ + The method to get the employee_count + + Returns: + string: A string representing the employee_count + """ + + return self.__employee_count + + def set_employee_count(self, employee_count): + """ + The method to set the value to employee_count + + Parameters: + employee_count (string) : A string representing the employee_count + """ + + if employee_count is not None and not isinstance(employee_count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: employee_count EXPECTED TYPE: str', None, None) + + self.__employee_count = employee_count + self.__key_modified['employee_count'] = 1 + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_currency_symbol(self): + """ + The method to get the currency_symbol + + Returns: + string: A string representing the currency_symbol + """ + + return self.__currency_symbol + + def set_currency_symbol(self, currency_symbol): + """ + The method to set the value to currency_symbol + + Parameters: + currency_symbol (string) : A string representing the currency_symbol + """ + + if currency_symbol is not None and not isinstance(currency_symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency_symbol EXPECTED TYPE: str', None, None) + + self.__currency_symbol = currency_symbol + self.__key_modified['currency_symbol'] = 1 + + def get_mobile(self): + """ + The method to get the mobile + + Returns: + string: A string representing the mobile + """ + + return self.__mobile + + def set_mobile(self, mobile): + """ + The method to set the value to mobile + + Parameters: + mobile (string) : A string representing the mobile + """ + + if mobile is not None and not isinstance(mobile, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mobile EXPECTED TYPE: str', None, None) + + self.__mobile = mobile + self.__key_modified['mobile'] = 1 + + def get_currency_locale(self): + """ + The method to get the currency_locale + + Returns: + string: A string representing the currency_locale + """ + + return self.__currency_locale + + def set_currency_locale(self, currency_locale): + """ + The method to set the value to currency_locale + + Parameters: + currency_locale (string) : A string representing the currency_locale + """ + + if currency_locale is not None and not isinstance(currency_locale, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency_locale EXPECTED TYPE: str', None, None) + + self.__currency_locale = currency_locale + self.__key_modified['currency_locale'] = 1 + + def get_primary_zuid(self): + """ + The method to get the primary_zuid + + Returns: + string: A string representing the primary_zuid + """ + + return self.__primary_zuid + + def set_primary_zuid(self, primary_zuid): + """ + The method to set the value to primary_zuid + + Parameters: + primary_zuid (string) : A string representing the primary_zuid + """ + + if primary_zuid is not None and not isinstance(primary_zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_zuid EXPECTED TYPE: str', None, None) + + self.__primary_zuid = primary_zuid + self.__key_modified['primary_zuid'] = 1 + + def get_zia_portal_id(self): + """ + The method to get the zia_portal_id + + Returns: + string: A string representing the zia_portal_id + """ + + return self.__zia_portal_id + + def set_zia_portal_id(self, zia_portal_id): + """ + The method to set the value to zia_portal_id + + Parameters: + zia_portal_id (string) : A string representing the zia_portal_id + """ + + if zia_portal_id is not None and not isinstance(zia_portal_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_portal_id EXPECTED TYPE: str', None, None) + + self.__zia_portal_id = zia_portal_id + self.__key_modified['zia_portal_id'] = 1 + + def get_time_zone(self): + """ + The method to get the time_zone + + Returns: + string: A string representing the time_zone + """ + + return self.__time_zone + + def set_time_zone(self, time_zone): + """ + The method to set the value to time_zone + + Parameters: + time_zone (string) : A string representing the time_zone + """ + + self.__time_zone = time_zone + self.__key_modified['time_zone'] = 1 + + def get_zgid(self): + """ + The method to get the zgid + + Returns: + string: A string representing the zgid + """ + + return self.__zgid + + def set_zgid(self, zgid): + """ + The method to set the value to zgid + + Parameters: + zgid (string) : A string representing the zgid + """ + + if zgid is not None and not isinstance(zgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zgid EXPECTED TYPE: str', None, None) + + self.__zgid = zgid + self.__key_modified['zgid'] = 1 + + def get_country_code(self): + """ + The method to get the country_code + + Returns: + string: A string representing the country_code + """ + + return self.__country_code + + def set_country_code(self, country_code): + """ + The method to set the value to country_code + + Parameters: + country_code (string) : A string representing the country_code + """ + + if country_code is not None and not isinstance(country_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country_code EXPECTED TYPE: str', None, None) + + self.__country_code = country_code + self.__key_modified['country_code'] = 1 + + def get_deletable_org_account(self): + """ + The method to get the deletable_org_account + + Returns: + bool: A bool representing the deletable_org_account + """ + + return self.__deletable_org_account + + def set_deletable_org_account(self, deletable_org_account): + """ + The method to set the value to deletable_org_account + + Parameters: + deletable_org_account (bool) : A bool representing the deletable_org_account + """ + + if deletable_org_account is not None and not isinstance(deletable_org_account, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deletable_org_account EXPECTED TYPE: bool', None, None) + + self.__deletable_org_account = deletable_org_account + self.__key_modified['deletable_org_account'] = 1 + + def get_license_details(self): + """ + The method to get the license_details + + Returns: + LicenseDetails: An instance of LicenseDetails + """ + + return self.__license_details + + def set_license_details(self, license_details): + """ + The method to set the value to license_details + + Parameters: + license_details (LicenseDetails) : An instance of LicenseDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.license_details import LicenseDetails + except Exception: + from .license_details import LicenseDetails + + if license_details is not None and not isinstance(license_details, LicenseDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: license_details EXPECTED TYPE: LicenseDetails', None, None) + + self.__license_details = license_details + self.__key_modified['license_details'] = 1 + + def get_hierarchy_preferences(self): + """ + The method to get the hierarchy_preferences + + Returns: + HierarchyPreferences: An instance of HierarchyPreferences + """ + + return self.__hierarchy_preferences + + def set_hierarchy_preferences(self, hierarchy_preferences): + """ + The method to set the value to hierarchy_preferences + + Parameters: + hierarchy_preferences (HierarchyPreferences) : An instance of HierarchyPreferences + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.hierarchy_preferences import HierarchyPreferences + except Exception: + from .hierarchy_preferences import HierarchyPreferences + + if hierarchy_preferences is not None and not isinstance(hierarchy_preferences, HierarchyPreferences): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hierarchy_preferences EXPECTED TYPE: HierarchyPreferences', None, None) + + self.__hierarchy_preferences = hierarchy_preferences + self.__key_modified['hierarchy_preferences'] = 1 + + def get_phone(self): + """ + The method to get the phone + + Returns: + string: A string representing the phone + """ + + return self.__phone + + def set_phone(self, phone): + """ + The method to set the value to phone + + Parameters: + phone (string) : A string representing the phone + """ + + if phone is not None and not isinstance(phone, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: phone EXPECTED TYPE: str', None, None) + + self.__phone = phone + self.__key_modified['phone'] = 1 + + def get_company_name(self): + """ + The method to get the company_name + + Returns: + string: A string representing the company_name + """ + + return self.__company_name + + def set_company_name(self, company_name): + """ + The method to set the value to company_name + + Parameters: + company_name (string) : A string representing the company_name + """ + + if company_name is not None and not isinstance(company_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company_name EXPECTED TYPE: str', None, None) + + self.__company_name = company_name + self.__key_modified['company_name'] = 1 + + def get_privacy_settings(self): + """ + The method to get the privacy_settings + + Returns: + bool: A bool representing the privacy_settings + """ + + return self.__privacy_settings + + def set_privacy_settings(self, privacy_settings): + """ + The method to set the value to privacy_settings + + Parameters: + privacy_settings (bool) : A bool representing the privacy_settings + """ + + if privacy_settings is not None and not isinstance(privacy_settings, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacy_settings EXPECTED TYPE: bool', None, None) + + self.__privacy_settings = privacy_settings + self.__key_modified['privacy_settings'] = 1 + + def get_primary_email(self): + """ + The method to get the primary_email + + Returns: + string: A string representing the primary_email + """ + + return self.__primary_email + + def set_primary_email(self, primary_email): + """ + The method to set the value to primary_email + + Parameters: + primary_email (string) : A string representing the primary_email + """ + + if primary_email is not None and not isinstance(primary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_email EXPECTED TYPE: str', None, None) + + self.__primary_email = primary_email + self.__key_modified['primary_email'] = 1 + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_lite_users_enabled(self): + """ + The method to get the lite_users_enabled + + Returns: + bool: A bool representing the lite_users_enabled + """ + + return self.__lite_users_enabled + + def set_lite_users_enabled(self, lite_users_enabled): + """ + The method to set the value to lite_users_enabled + + Parameters: + lite_users_enabled (bool) : A bool representing the lite_users_enabled + """ + + if lite_users_enabled is not None and not isinstance(lite_users_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lite_users_enabled EXPECTED TYPE: bool', None, None) + + self.__lite_users_enabled = lite_users_enabled + self.__key_modified['lite_users_enabled'] = 1 + + def get_max_per_page(self): + """ + The method to get the max_per_page + + Returns: + int: An int representing the max_per_page + """ + + return self.__max_per_page + + def set_max_per_page(self, max_per_page): + """ + The method to set the value to max_per_page + + Parameters: + max_per_page (int) : An int representing the max_per_page + """ + + if max_per_page is not None and not isinstance(max_per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: max_per_page EXPECTED TYPE: int', None, None) + + self.__max_per_page = max_per_page + self.__key_modified['max_per_page'] = 1 + + def get_ezgid(self): + """ + The method to get the ezgid + + Returns: + string: A string representing the ezgid + """ + + return self.__ezgid + + def set_ezgid(self, ezgid): + """ + The method to set the value to ezgid + + Parameters: + ezgid (string) : A string representing the ezgid + """ + + if ezgid is not None and not isinstance(ezgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ezgid EXPECTED TYPE: str', None, None) + + self.__ezgid = ezgid + self.__key_modified['ezgid'] = 1 + + def get_call_icon(self): + """ + The method to get the call_icon + + Returns: + string: A string representing the call_icon + """ + + return self.__call_icon + + def set_call_icon(self, call_icon): + """ + The method to set the value to call_icon + + Parameters: + call_icon (string) : A string representing the call_icon + """ + + if call_icon is not None and not isinstance(call_icon, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call_icon EXPECTED TYPE: str', None, None) + + self.__call_icon = call_icon + self.__key_modified['call_icon'] = 1 + + def get_oauth_presence(self): + """ + The method to get the oauth_presence + + Returns: + bool: A bool representing the oauth_presence + """ + + return self.__oauth_presence + + def set_oauth_presence(self, oauth_presence): + """ + The method to set the value to oauth_presence + + Parameters: + oauth_presence (bool) : A bool representing the oauth_presence + """ + + if oauth_presence is not None and not isinstance(oauth_presence, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: oauth_presence EXPECTED TYPE: bool', None, None) + + self.__oauth_presence = oauth_presence + self.__key_modified['oauth_presence'] = 1 + + def get_zia_zgid(self): + """ + The method to get the zia_zgid + + Returns: + int: An int representing the zia_zgid + """ + + return self.__zia_zgid + + def set_zia_zgid(self, zia_zgid): + """ + The method to set the value to zia_zgid + + Parameters: + zia_zgid (int) : An int representing the zia_zgid + """ + + if zia_zgid is not None and not isinstance(zia_zgid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_zgid EXPECTED TYPE: int', None, None) + + self.__zia_zgid = zia_zgid + self.__key_modified['zia_zgid'] = 1 + + def get_checkin_preferences(self): + """ + The method to get the checkin_preferences + + Returns: + CheckinPreferences: An instance of CheckinPreferences + """ + + return self.__checkin_preferences + + def set_checkin_preferences(self, checkin_preferences): + """ + The method to set the value to checkin_preferences + + Parameters: + checkin_preferences (CheckinPreferences) : An instance of CheckinPreferences + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.checkin_preferences import CheckinPreferences + except Exception: + from .checkin_preferences import CheckinPreferences + + if checkin_preferences is not None and not isinstance(checkin_preferences, CheckinPreferences): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: checkin_preferences EXPECTED TYPE: CheckinPreferences', None, None) + + self.__checkin_preferences = checkin_preferences + self.__key_modified['checkin_preferences'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/org_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/org_operations.py new file mode 100644 index 0000000..6616c90 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/org_operations.py @@ -0,0 +1,122 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class OrgOperations(object): + def __init__(self): + """Creates an instance of OrgOperations""" + pass + + def get_organization(self): + """ + The method to get organization + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_org_photo(self): + """ + The method to get org photo + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/photo' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'image/png') + + def upload_organization_photo(self, request): + """ + The method to upload organization photo + + Parameters: + request (FileBodyWrapper) : An instance of FileBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/photo' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_organization_photo(self): + """ + The method to delete organization photo + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/photo' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetOrganizationHeader(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/resource.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/resource.py new file mode 100644 index 0000000..503885e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/response_wrapper.py new file mode 100644 index 0000000..4e2482e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__org = None + self.__key_modified = dict() + + def get_org(self): + """ + The method to get the org + + Returns: + list: An instance of list + """ + + return self.__org + + def set_org(self, org): + """ + The method to set the value to org + + Parameters: + org (list) : An instance of list + """ + + if org is not None and not isinstance(org, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org EXPECTED TYPE: list', None, None) + + self.__org = org + self.__key_modified['org'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/success_response.py new file mode 100644 index 0000000..ff16ce4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/org/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class SuccessResponse(ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/param.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/param.py new file mode 100755 index 0000000..0356b81 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/param.py @@ -0,0 +1,19 @@ + +class Param(object): + + """ + This class represents the HTTP parameter. + """ + + def __init__(self, name, class_name=None): + + """ + Creates an Param class instance with the following parameters + + Parameters: + name (str) : A string containing the parameter name. + class_name (str) : A string containing the parameter class name. + """ + + self.name = name + self.class_name = class_name diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/parameter_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/parameter_map.py new file mode 100755 index 0000000..616d88b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/parameter_map.py @@ -0,0 +1,69 @@ +try: + import logging + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.header_param_validator import HeaderParamValidator +except Exception: + import logging + from .util.constants import Constants + from .util.header_param_validator import HeaderParamValidator + from .util.datatype_converter import DataTypeConverter + from .param import Param + from ..api.exception import SDKException + + +class ParameterMap(object): + """ + This class represents the HTTP parameter name and value. + """ + + def __init__(self): + """Creates an instance of ParameterMap Class""" + + self.request_parameters = dict() + + def add(self, param, value): + + """ + The method to add parameter name and value. + + Parameters: + param (Param): A Param class instance. + value (object): An object containing the parameter value. + """ + + if param is None: + raise SDKException(Constants.PARAMETER_NONE_ERROR, Constants.PARAM_INSTANCE_NONE_ERROR) + + param_name = param.name + + if param_name is None: + raise SDKException(Constants.PARAM_NAME_NONE_ERROR, Constants.PARAM_NAME_NONE_ERROR_MESSAGE) + + if value is None: + raise SDKException(Constants.PARAMETER_NONE_ERROR, param_name + Constants.NONE_VALUE_ERROR_MESSAGE) + + try: + class_name = param.class_name + parsed_param_value = None + if class_name is not None: + parsed_param_value = HeaderParamValidator().validate(param_name, class_name, value) + else: + try: + parsed_param_value = DataTypeConverter.post_convert(value, value.__class__.__name__) + except Exception as e: + parsed_param_value = str(value) + if param_name not in self.request_parameters: + self.request_parameters[param_name] = str(parsed_param_value) + else: + param_value = self.request_parameters[param_name] + self.request_parameters[param_name] = param_value + ',' + str(parsed_param_value) + except SDKException as e: + logging.getLogger('SDKLogger').error(Constants.PARAM_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + logging.getLogger('SDKLogger').error(Constants.PARAM_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/__init__.py new file mode 100644 index 0000000..f86ff39 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .layout_association import LayoutAssociation +from .pick_list_values_operations import PickListValuesOperations, GetPickListValuesParam +from .response_wrapper import ResponseWrapper +from .pick_list_values import PickListValues diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/api_exception.py new file mode 100644 index 0000000..cacfa0c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pick_list_values.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/layout_association.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/layout_association.py new file mode 100644 index 0000000..b7df3da --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/layout_association.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LayoutAssociation(object): + def __init__(self): + """Creates an instance of LayoutAssociation""" + + self.__api_name = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values.py new file mode 100644 index 0000000..dda52a0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values.py @@ -0,0 +1,249 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PickListValues(object): + def __init__(self): + """Creates an instance of PickListValues""" + + self.__sequence_number = None + self.__display_value = None + self.__reference_value = None + self.__colour_code = None + self.__actual_value = None + self.__id = None + self.__type = None + self.__layout_associations = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_reference_value(self): + """ + The method to get the reference_value + + Returns: + string: A string representing the reference_value + """ + + return self.__reference_value + + def set_reference_value(self, reference_value): + """ + The method to set the value to reference_value + + Parameters: + reference_value (string) : A string representing the reference_value + """ + + if reference_value is not None and not isinstance(reference_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reference_value EXPECTED TYPE: str', None, None) + + self.__reference_value = reference_value + self.__key_modified['reference_value'] = 1 + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values_operations.py new file mode 100644 index 0000000..6576c0f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values_operations.py @@ -0,0 +1,59 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class PickListValuesOperations(object): + def __init__(self, field_id, module=None): + """ + Creates an instance of PickListValuesOperations with the given parameters + + Parameters: + field_id (int) : An int representing the field_id + module (string) : A string representing the module + """ + + if not isinstance(field_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_id EXPECTED TYPE: int', None, None) + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__field_id = field_id + self.__module = module + + + def get_pick_list_values(self): + """ + The method to get pick list values + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/fields/' + api_path = api_path + str(self.__field_id) + api_path = api_path + '/pick_list_values' + 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.PickListValues.GetPickListValuesParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.pick_list_values.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetPickListValuesParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_wrapper.py new file mode 100644 index 0000000..8c18ba8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pick_list_values.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__pick_list_values = None + self.__key_modified = dict() + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/__init__.py new file mode 100644 index 0000000..cc946de --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/__init__.py @@ -0,0 +1,24 @@ +from .action_wrapper import ActionWrapper +from .transfer_pipeline_action_handler import TransferPipelineActionHandler +from .maps import Maps +from .transfer_pipeline_action_wrapper import TransferPipelineActionWrapper +from .forecast_category import ForecastCategory +from .body_wrapper import BodyWrapper +from .transfer_pipeline_wrapper import TransferPipelineWrapper +from .delete import Delete +from .pipeline_operations import PipelineOperations, GetPipelinesParam, CreatePipelineParam, UpdatePipelinesParam, GetPipelineParam, UpdatePipelineParam, DeletePipelineParam, TransferPipelinesParam +from .pipeline import Pipeline +from .api_exception import APIException +from .transfer_pipeline import TransferPipeline +from .t_pipeline import TPipeline +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .transfer_pipeline_action_response import TransferPipelineActionResponse +from .d_pipeline_wrapper import DPipelineWrapper +from .d_pipeline import DPipeline +from .success_response import SuccessResponse +from .transfer_pipeline_success_response import TransferPipelineSuccessResponse +from .stages import Stages +from .json_details import JsonDetails +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_wrapper.py new file mode 100644 index 0000000..8a37be4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/api_exception.py new file mode 100644 index 0000000..7d87b11 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_handler import TransferPipelineActionHandler + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_response import TransferPipelineActionResponse + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .transfer_pipeline_action_handler import TransferPipelineActionHandler + from .transfer_pipeline_action_response import TransferPipelineActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, TransferPipelineActionResponse, ResponseHandler, ActionHandler, TransferPipelineActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/body_wrapper.py new file mode 100644 index 0000000..8223940 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline.py new file mode 100644 index 0000000..4d9b656 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DPipeline(object): + def __init__(self): + """Creates an instance of DPipeline""" + + self.__delete = None + self.__key_modified = dict() + + def get_delete(self): + """ + The method to get the delete + + Returns: + Delete: An instance of Delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (Delete) : An instance of Delete + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.delete import Delete + except Exception: + from .delete import Delete + + if delete is not None and not isinstance(delete, Delete): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: Delete', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline_wrapper.py new file mode 100644 index 0000000..aa912c7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DPipelineWrapper(object): + def __init__(self): + """Creates an instance of DPipelineWrapper""" + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/delete.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/delete.py new file mode 100644 index 0000000..81d54eb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/delete.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Delete(object): + def __init__(self): + """Creates an instance of Delete""" + + self.__permanent = None + self.__key_modified = dict() + + def get_permanent(self): + """ + The method to get the permanent + + Returns: + bool: A bool representing the permanent + """ + + return self.__permanent + + def set_permanent(self, permanent): + """ + The method to set the value to permanent + + Parameters: + permanent (bool) : A bool representing the permanent + """ + + if permanent is not None and not isinstance(permanent, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permanent EXPECTED TYPE: bool', None, None) + + self.__permanent = permanent + self.__key_modified['permanent'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/forecast_category.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/forecast_category.py new file mode 100644 index 0000000..cc2b2e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/forecast_category.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ForecastCategory(object): + def __init__(self): + """Creates an instance of ForecastCategory""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/json_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/json_details.py new file mode 100644 index 0000000..aaf7438 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/json_details.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class JsonDetails(object): + def __init__(self): + """Creates an instance of JsonDetails""" + + self.__api_name = None + self.__json_path = None + self.__expected_data_type = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def get_expected_data_type(self): + """ + The method to get the expected_data_type + + Returns: + string: A string representing the expected_data_type + """ + + return self.__expected_data_type + + def set_expected_data_type(self, expected_data_type): + """ + The method to set the value to expected_data_type + + Parameters: + expected_data_type (string) : A string representing the expected_data_type + """ + + if expected_data_type is not None and not isinstance(expected_data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expected_data_type EXPECTED TYPE: str', None, None) + + self.__expected_data_type = expected_data_type + self.__key_modified['expected_data_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/maps.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/maps.py new file mode 100644 index 0000000..fee84a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/maps.py @@ -0,0 +1,254 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Maps(object): + def __init__(self): + """Creates an instance of Maps""" + + self.__display_value = None + self.__sequence_number = None + self.__forecast_category = None + self.__delete = None + self.__actual_value = None + self.__id = None + self.__colour_code = None + self.__forecast_type = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_forecast_category(self): + """ + The method to get the forecast_category + + Returns: + ForecastCategory: An instance of ForecastCategory + """ + + return self.__forecast_category + + def set_forecast_category(self, forecast_category): + """ + The method to set the value to forecast_category + + Parameters: + forecast_category (ForecastCategory) : An instance of ForecastCategory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.forecast_category import ForecastCategory + except Exception: + from .forecast_category import ForecastCategory + + if forecast_category is not None and not isinstance(forecast_category, ForecastCategory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_category EXPECTED TYPE: ForecastCategory', None, None) + + self.__forecast_category = forecast_category + self.__key_modified['forecast_category'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_forecast_type(self): + """ + The method to get the forecast_type + + Returns: + string: A string representing the forecast_type + """ + + return self.__forecast_type + + def set_forecast_type(self, forecast_type): + """ + The method to set the value to forecast_type + + Parameters: + forecast_type (string) : A string representing the forecast_type + """ + + if forecast_type is not None and not isinstance(forecast_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_type EXPECTED TYPE: str', None, None) + + self.__forecast_type = forecast_type + self.__key_modified['forecast_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline.py new file mode 100644 index 0000000..d5ef467 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Pipeline(object): + def __init__(self): + """Creates an instance of Pipeline""" + + self.__display_value = None + self.__default = None + self.__maps = None + self.__actual_value = None + self.__id = None + self.__child_available = None + self.__parent = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_maps(self): + """ + The method to get the maps + + Returns: + list: An instance of list + """ + + return self.__maps + + def set_maps(self, maps): + """ + The method to set the value to maps + + Parameters: + maps (list) : An instance of list + """ + + if maps is not None and not isinstance(maps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: list', None, None) + + self.__maps = maps + self.__key_modified['maps'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_child_available(self): + """ + The method to get the child_available + + Returns: + bool: A bool representing the child_available + """ + + return self.__child_available + + def set_child_available(self, child_available): + """ + The method to set the value to child_available + + Parameters: + child_available (bool) : A bool representing the child_available + """ + + if child_available is not None and not isinstance(child_available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: child_available EXPECTED TYPE: bool', None, None) + + self.__child_available = child_available + self.__key_modified['child_available'] = 1 + + def get_parent(self): + """ + The method to get the parent + + Returns: + Pipeline: An instance of Pipeline + """ + + return self.__parent + + def set_parent(self, parent): + """ + The method to set the value to parent + + Parameters: + parent (Pipeline) : An instance of Pipeline + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.pipeline import Pipeline + except Exception: + from .pipeline import Pipeline + + if parent is not None and not isinstance(parent, Pipeline): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent EXPECTED TYPE: Pipeline', None, None) + + self.__parent = parent + self.__key_modified['parent'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline_operations.py new file mode 100644 index 0000000..05de9eb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline_operations.py @@ -0,0 +1,304 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class PipelineOperations(object): + def __init__(self, layout_id=None): + """ + Creates an instance of PipelineOperations with the given parameters + + Parameters: + layout_id (int) : An int representing the layout_id + """ + + if layout_id is not None and not isinstance(layout_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: int', None, None) + + self.__layout_id = layout_id + + + def get_pipelines(self): + """ + The method to get pipelines + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/pipeline' + 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('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelinesParam'), self.__layout_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_pipeline(self, request): + """ + The method to create pipeline + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/pipeline' + 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.CreatePipelineParam'), self.__layout_id) + try: + from zohocrmsdk.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 update_pipelines(self, request): + """ + The method to update pipelines + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/pipeline' + 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.set_mandatory_checker(True) + handler_instance.add_param(Param('layout_id', 'com.zoho.crm.api.Pipeline.UpdatePipelinesParam'), self.__layout_id) + try: + from zohocrmsdk.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 get_pipeline(self, id): + """ + The method to get pipeline + + 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/v7/settings/pipeline/' + 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('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelineParam'), self.__layout_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_pipeline(self, id, request): + """ + The method to update pipeline + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/pipeline/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + 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 zohocrmsdk.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 delete_pipeline(self, id, request): + """ + The method to delete pipeline + + Parameters: + id (int) : An int representing the id + request (DPipelineWrapper) : An instance of DPipelineWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.d_pipeline_wrapper import DPipelineWrapper + except Exception: + from .d_pipeline_wrapper import DPipelineWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, DPipelineWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: DPipelineWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/pipeline/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.add_param(Param('layout_id', 'com.zoho.crm.api.Pipeline.DeletePipelineParam'), self.__layout_id) + try: + from zohocrmsdk.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_pipelines(self, request): + """ + The method to transfer pipelines + + Parameters: + request (TransferPipelineWrapper) : An instance of TransferPipelineWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_wrapper import TransferPipelineWrapper + except Exception: + from .transfer_pipeline_wrapper import TransferPipelineWrapper + + if request is not None and not isinstance(request, TransferPipelineWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferPipelineWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/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_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.add_param(Param('layout_id', 'com.zoho.crm.api.Pipeline.TransferPipelinesParam'), self.__layout_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_handler import TransferPipelineActionHandler + except Exception: + from .transfer_pipeline_action_handler import TransferPipelineActionHandler + return handler_instance.api_call(TransferPipelineActionHandler.__module__, 'application/json') + + +class GetPipelinesParam(object): + pass + + +class CreatePipelineParam(object): + pass + + +class UpdatePipelinesParam(object): + pass + + +class GetPipelineParam(object): + pass + + +class UpdatePipelineParam(object): + pass + + +class DeletePipelineParam(object): + pass + + +class TransferPipelinesParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_wrapper.py new file mode 100644 index 0000000..845b68b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/stages.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/stages.py new file mode 100644 index 0000000..12d8f42 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/stages.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Stages(object): + def __init__(self): + """Creates an instance of Stages""" + + self.__from_1 = None + self.__to = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + int: An int representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (int) : An int representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: int', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + int: An int representing the to + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (int) : An int representing the to + """ + + if to is not None and not isinstance(to, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: int', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/success_response.py new file mode 100644 index 0000000..a309c71 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/t_pipeline.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/t_pipeline.py new file mode 100644 index 0000000..d95d03b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/t_pipeline.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TPipeline(object): + def __init__(self): + """Creates an instance of TPipeline""" + + self.__from_1 = None + self.__to = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + int: An int representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (int) : An int representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: int', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + int: An int representing the to + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (int) : An int representing the to + """ + + if to is not None and not isinstance(to, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: int', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline.py new file mode 100644 index 0000000..64e904b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferPipeline(object): + def __init__(self): + """Creates an instance of TransferPipeline""" + + self.__pipeline = None + self.__stages = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + TPipeline: An instance of TPipeline + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (TPipeline) : An instance of TPipeline + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.t_pipeline import TPipeline + except Exception: + from .t_pipeline import TPipeline + + if pipeline is not None and not isinstance(pipeline, TPipeline): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: TPipeline', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def get_stages(self): + """ + The method to get the stages + + Returns: + list: An instance of list + """ + + return self.__stages + + def set_stages(self, stages): + """ + The method to set the value to stages + + Parameters: + stages (list) : An instance of list + """ + + if stages is not None and not isinstance(stages, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: stages EXPECTED TYPE: list', None, None) + + self.__stages = stages + self.__key_modified['stages'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_handler.py new file mode 100644 index 0000000..a4a50cc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferPipelineActionHandler(ABC): + def __init__(self): + """Creates an instance of TransferPipelineActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_response.py new file mode 100644 index 0000000..df59812 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferPipelineActionResponse(ABC): + def __init__(self): + """Creates an instance of TransferPipelineActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.py new file mode 100644 index 0000000..e40141f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_handler import TransferPipelineActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .transfer_pipeline_action_handler import TransferPipelineActionHandler + + +class TransferPipelineActionWrapper(TransferPipelineActionHandler): + def __init__(self): + """Creates an instance of TransferPipelineActionWrapper""" + super().__init__() + + self.__transfer_pipeline = None + self.__key_modified = dict() + + def get_transfer_pipeline(self): + """ + The method to get the transfer_pipeline + + Returns: + list: An instance of list + """ + + return self.__transfer_pipeline + + def set_transfer_pipeline(self, transfer_pipeline): + """ + The method to set the value to transfer_pipeline + + Parameters: + transfer_pipeline (list) : An instance of list + """ + + if transfer_pipeline is not None and not isinstance(transfer_pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_pipeline EXPECTED TYPE: list', None, None) + + self.__transfer_pipeline = transfer_pipeline + self.__key_modified['transfer_pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_success_response.py new file mode 100644 index 0000000..60b660b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_response import TransferPipelineActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .transfer_pipeline_action_response import TransferPipelineActionResponse + + +class TransferPipelineSuccessResponse(TransferPipelineActionResponse): + def __init__(self): + """Creates an instance of TransferPipelineSuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_wrapper.py new file mode 100644 index 0000000..8e5c470 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferPipelineWrapper(object): + def __init__(self): + """Creates an instance of TransferPipelineWrapper""" + + self.__transfer_pipeline = None + self.__key_modified = dict() + + def get_transfer_pipeline(self): + """ + The method to get the transfer_pipeline + + Returns: + list: An instance of list + """ + + return self.__transfer_pipeline + + def set_transfer_pipeline(self, transfer_pipeline): + """ + The method to set the value to transfer_pipeline + + Parameters: + transfer_pipeline (list) : An instance of list + """ + + if transfer_pipeline is not None and not isinstance(transfer_pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_pipeline EXPECTED TYPE: list', None, None) + + self.__transfer_pipeline = transfer_pipeline + self.__key_modified['transfer_pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/__init__.py new file mode 100644 index 0000000..6337197 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/__init__.py @@ -0,0 +1,12 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .job_response import JobResponse +from .action_response import ActionResponse +from .data import Data +from .portal_invite_operations import PortalInviteOperations, InviteUsersParam +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .portal_invite import PortalInvite +from .portal import Portal diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_wrapper.py new file mode 100644 index 0000000..e5460f1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__portal_invite = None + self.__key_modified = dict() + + def get_portal_invite(self): + """ + The method to get the portal_invite + + Returns: + list: An instance of list + """ + + return self.__portal_invite + + def set_portal_invite(self, portal_invite): + """ + The method to set the value to portal_invite + + Parameters: + portal_invite (list) : An instance of list + """ + + if portal_invite is not None and not isinstance(portal_invite, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_invite EXPECTED TYPE: list', None, None) + + self.__portal_invite = portal_invite + self.__key_modified['portal_invite'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/api_exception.py new file mode 100644 index 0000000..80e903b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.data import Data + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .data import Data + from .action_handler import ActionHandler + + +class APIException(Data, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/body_wrapper.py new file mode 100644 index 0000000..ea05a80 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__portal_invite = None + self.__key_modified = dict() + + def get_portal_invite(self): + """ + The method to get the portal_invite + + Returns: + list: An instance of list + """ + + return self.__portal_invite + + def set_portal_invite(self, portal_invite): + """ + The method to set the value to portal_invite + + Parameters: + portal_invite (list) : An instance of list + """ + + if portal_invite is not None and not isinstance(portal_invite, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_invite EXPECTED TYPE: list', None, None) + + self.__portal_invite = portal_invite + self.__key_modified['portal_invite'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/data.py new file mode 100644 index 0000000..ef0f3f6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/data.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class Data(ABC): + def __init__(self): + """Creates an instance of Data""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/job_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/job_response.py new file mode 100644 index 0000000..bf41daf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/job_response.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class JobResponse(object): + def __init__(self): + """Creates an instance of JobResponse""" + + self.__data = None + self.__job_id = None + self.__status = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_job_id(self): + """ + The method to get the job_id + + Returns: + int: An int representing the job_id + """ + + return self.__job_id + + def set_job_id(self, job_id): + """ + The method to set the value to job_id + + Parameters: + job_id (int) : An int representing the job_id + """ + + if job_id is not None and not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + self.__job_id = job_id + self.__key_modified['job_id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal.py new file mode 100644 index 0000000..243dabd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Portal(object): + def __init__(self): + """Creates an instance of Portal""" + + self.__id = None + self.__user_type_id = None + self.__type = None + self.__language = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_user_type_id(self): + """ + The method to get the user_type_id + + Returns: + int: An int representing the user_type_id + """ + + return self.__user_type_id + + def set_user_type_id(self, user_type_id): + """ + The method to set the value to user_type_id + + Parameters: + user_type_id (int) : An int representing the user_type_id + """ + + if user_type_id is not None and not isinstance(user_type_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: int', None, None) + + self.__user_type_id = user_type_id + self.__key_modified['user_type_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_language(self): + """ + The method to get the language + + Returns: + Choice: An instance of Choice + """ + + return self.__language + + def set_language(self, language): + """ + The method to set the value to language + + Parameters: + language (Choice) : An instance of Choice + """ + + if language is not None and not isinstance(language, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: language EXPECTED TYPE: Choice', None, None) + + self.__language = language + self.__key_modified['language'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite.py new file mode 100644 index 0000000..1dbb541 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PortalInvite(object): + def __init__(self): + """Creates an instance of PortalInvite""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite_operations.py new file mode 100644 index 0000000..1c65438 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite_operations.py @@ -0,0 +1,73 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class PortalInviteOperations(object): + def __init__(self, module): + """ + Creates an instance of PortalInviteOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def invite_users(self, record, param_instance=None): + """ + The method to invite users + + Parameters: + record (int) : An int representing the record + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: int', None, None) + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(record) + api_path = api_path + '/actions/portal_invite' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class InviteUsersParam(object): + user_type_id = Param('user_type_id', 'com.zoho.crm.api.PortalInvite.InviteUsersParam') + type = Param('type', 'com.zoho.crm.api.PortalInvite.InviteUsersParam') + language = Param('language', 'com.zoho.crm.api.PortalInvite.InviteUsersParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/response_wrapper.py new file mode 100644 index 0000000..cbe2b7f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__portal_invite = None + self.__key_modified = dict() + + def get_portal_invite(self): + """ + The method to get the portal_invite + + Returns: + list: An instance of list + """ + + return self.__portal_invite + + def set_portal_invite(self, portal_invite): + """ + The method to set the value to portal_invite + + Parameters: + portal_invite (list) : An instance of list + """ + + if portal_invite is not None and not isinstance(portal_invite, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_invite EXPECTED TYPE: list', None, None) + + self.__portal_invite = portal_invite + self.__key_modified['portal_invite'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/success_response.py new file mode 100644 index 0000000..be3370b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_invite/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.data import Data +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .data import Data + + +class SuccessResponse(Data, ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/__init__.py new file mode 100644 index 0000000..b536a16 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .owner import Owner +from .body_wrapper import BodyWrapper +from .filters import Filters +from .layouts import Layouts +from .modules import Modules +from .portal_user_type_operations import PortalUserTypeOperations, GetUserTypesParam +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .user_type import UserType +from .success_response import SuccessResponse +from .permissions import Permissions +from .personality_module import PersonalityModule +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .fields import Fields +from .views import Views diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_wrapper.py new file mode 100644 index 0000000..f8fd7f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__user_type = None + self.__key_modified = dict() + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + list: An instance of list + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (list) : An instance of list + """ + + if user_type is not None and not isinstance(user_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: list', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/api_exception.py new file mode 100644 index 0000000..635068f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/body_wrapper.py new file mode 100644 index 0000000..96c5477 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__user_type = None + self.__key_modified = dict() + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + list: An instance of list + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (list) : An instance of list + """ + + if user_type is not None and not isinstance(user_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: list', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/fields.py new file mode 100644 index 0000000..652da8c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/fields.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__read_only = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/filters.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/filters.py new file mode 100644 index 0000000..b232969 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/filters.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Filters(object): + def __init__(self): + """Creates an instance of Filters""" + + self.__display_label = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/layouts.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/layouts.py new file mode 100644 index 0000000..6b994bd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/layouts.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layouts(object): + def __init__(self): + """Creates an instance of Layouts""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__defaultview = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_defaultview(self): + """ + The method to get the defaultview + + Returns: + Views: An instance of Views + """ + + return self.__defaultview + + def set_defaultview(self, defaultview): + """ + The method to set the value to defaultview + + Parameters: + defaultview (Views) : An instance of Views + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.views import Views + except Exception: + from .views import Views + + if defaultview is not None and not isinstance(defaultview, Views): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: Views', None, None) + + self.__defaultview = defaultview + self.__key_modified['_default_view'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/modules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/modules.py new file mode 100644 index 0000000..bc50f54 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/modules.py @@ -0,0 +1,284 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__id = None + self.__plural_label = None + self.__shared_type = None + self.__api_name = None + self.__filters = None + self.__fields = None + self.__layouts = None + self.__views = None + self.__permissions = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_shared_type(self): + """ + The method to get the shared_type + + Returns: + string: A string representing the shared_type + """ + + return self.__shared_type + + def set_shared_type(self, shared_type): + """ + The method to set the value to shared_type + + Parameters: + shared_type (string) : A string representing the shared_type + """ + + if shared_type is not None and not isinstance(shared_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_type EXPECTED TYPE: str', None, None) + + self.__shared_type = shared_type + self.__key_modified['shared_type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_filters(self): + """ + The method to get the filters + + Returns: + list: An instance of list + """ + + return self.__filters + + def set_filters(self, filters): + """ + The method to set the value to filters + + Parameters: + filters (list) : An instance of list + """ + + if filters is not None and not isinstance(filters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: list', None, None) + + self.__filters = filters + self.__key_modified['filters'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_views(self): + """ + The method to get the views + + Returns: + Views: An instance of Views + """ + + return self.__views + + def set_views(self, views): + """ + The method to set the value to views + + Parameters: + views (Views) : An instance of Views + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.views import Views + except Exception: + from .views import Views + + if views is not None and not isinstance(views, Views): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: views EXPECTED TYPE: Views', None, None) + + self.__views = views + self.__key_modified['views'] = 1 + + def get_permissions(self): + """ + The method to get the permissions + + Returns: + Permissions: An instance of Permissions + """ + + return self.__permissions + + def set_permissions(self, permissions): + """ + The method to set the value to permissions + + Parameters: + permissions (Permissions) : An instance of Permissions + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.permissions import Permissions + except Exception: + from .permissions import Permissions + + if permissions is not None and not isinstance(permissions, Permissions): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions EXPECTED TYPE: Permissions', None, None) + + self.__permissions = permissions + self.__key_modified['permissions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/permissions.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/permissions.py new file mode 100644 index 0000000..0cac9cd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/permissions.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Permissions(object): + def __init__(self): + """Creates an instance of Permissions""" + + self.__view = None + self.__edit = None + self.__edit_shared_records = None + self.__create = None + self.__delete = None + self.__delete_attachment = None + self.__create_attachment = None + self.__key_modified = dict() + + def get_view(self): + """ + The method to get the view + + Returns: + bool: A bool representing the view + """ + + return self.__view + + def set_view(self, view): + """ + The method to set the value to view + + Parameters: + view (bool) : A bool representing the view + """ + + if view is not None and not isinstance(view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view EXPECTED TYPE: bool', None, None) + + self.__view = view + self.__key_modified['view'] = 1 + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_edit_shared_records(self): + """ + The method to get the edit_shared_records + + Returns: + bool: A bool representing the edit_shared_records + """ + + return self.__edit_shared_records + + def set_edit_shared_records(self, edit_shared_records): + """ + The method to set the value to edit_shared_records + + Parameters: + edit_shared_records (bool) : A bool representing the edit_shared_records + """ + + if edit_shared_records is not None and not isinstance(edit_shared_records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit_shared_records EXPECTED TYPE: bool', None, None) + + self.__edit_shared_records = edit_shared_records + self.__key_modified['edit_shared_records'] = 1 + + def get_create(self): + """ + The method to get the create + + Returns: + bool: A bool representing the create + """ + + return self.__create + + def set_create(self, create): + """ + The method to set the value to create + + Parameters: + create (bool) : A bool representing the create + """ + + if create is not None and not isinstance(create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create EXPECTED TYPE: bool', None, None) + + self.__create = create + self.__key_modified['create'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['delete'] = 1 + + def get_delete_attachment(self): + """ + The method to get the delete_attachment + + Returns: + bool: A bool representing the delete_attachment + """ + + return self.__delete_attachment + + def set_delete_attachment(self, delete_attachment): + """ + The method to set the value to delete_attachment + + Parameters: + delete_attachment (bool) : A bool representing the delete_attachment + """ + + if delete_attachment is not None and not isinstance(delete_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete_attachment EXPECTED TYPE: bool', None, None) + + self.__delete_attachment = delete_attachment + self.__key_modified['delete_attachment'] = 1 + + def get_create_attachment(self): + """ + The method to get the create_attachment + + Returns: + bool: A bool representing the create_attachment + """ + + return self.__create_attachment + + def set_create_attachment(self, create_attachment): + """ + The method to set the value to create_attachment + + Parameters: + create_attachment (bool) : A bool representing the create_attachment + """ + + if create_attachment is not None and not isinstance(create_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create_attachment EXPECTED TYPE: bool', None, None) + + self.__create_attachment = create_attachment + self.__key_modified['create_attachment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/personality_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/personality_module.py new file mode 100644 index 0000000..234efeb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/personality_module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PersonalityModule(object): + def __init__(self): + """Creates an instance of PersonalityModule""" + + self.__api_name = None + self.__id = None + self.__plural_label = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/portal_user_type_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/portal_user_type_operations.py new file mode 100644 index 0000000..0c7d155 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/portal_user_type_operations.py @@ -0,0 +1,212 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class PortalUserTypeOperations(object): + def __init__(self, portal): + """ + Creates an instance of PortalUserTypeOperations with the given parameters + + Parameters: + portal (string) : A string representing the portal + """ + + if not isinstance(portal, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal EXPECTED TYPE: str', None, None) + + self.__portal = portal + + + def get_user_types(self, param_instance=None): + """ + The method to get user types + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_user_type(self, request): + """ + The method to create user type + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_user_type(self, user_type_id): + """ + The method to get user type + + Parameters: + user_type_id (string) : A string representing the user_type_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user_type_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type/' + api_path = api_path + str(user_type_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_user_type(self, user_type_id, request): + """ + The method to update user type + + Parameters: + user_type_id (string) : A string representing the user_type_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(user_type_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: str', 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/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type/' + api_path = api_path + str(user_type_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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_user_type(self, user_type_id): + """ + The method to delete user type + + Parameters: + user_type_id (string) : A string representing the user_type_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user_type_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type/' + api_path = api_path + str(user_type_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetUserTypesParam(object): + include = Param('include', 'com.zoho.crm.api.PortalUserType.GetUserTypesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_wrapper.py new file mode 100644 index 0000000..6f42258 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__user_type = None + self.__key_modified = dict() + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + list: An instance of list + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (list) : An instance of list + """ + + if user_type is not None and not isinstance(user_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: list', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/success_response.py new file mode 100644 index 0000000..236fc01 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/user_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/user_type.py new file mode 100644 index 0000000..71c0f9c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/user_type.py @@ -0,0 +1,343 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UserType(object): + def __init__(self): + """Creates an instance of UserType""" + + self.__personality_module = None + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__created_by = None + self.__name = None + self.__active = None + self.__default = None + self.__no_of_users = None + self.__id = None + self.__modules = None + self.__key_modified = dict() + + def get_personality_module(self): + """ + The method to get the personality_module + + Returns: + PersonalityModule: An instance of PersonalityModule + """ + + return self.__personality_module + + def set_personality_module(self, personality_module): + """ + The method to set the value to personality_module + + Parameters: + personality_module (PersonalityModule) : An instance of PersonalityModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.personality_module import PersonalityModule + except Exception: + from .personality_module import PersonalityModule + + if personality_module is not None and not isinstance(personality_module, PersonalityModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: personality_module EXPECTED TYPE: PersonalityModule', None, None) + + self.__personality_module = personality_module + self.__key_modified['personality_module'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_no_of_users(self): + """ + The method to get the no_of_users + + Returns: + int: An int representing the no_of_users + """ + + return self.__no_of_users + + def set_no_of_users(self, no_of_users): + """ + The method to set the value to no_of_users + + Parameters: + no_of_users (int) : An int representing the no_of_users + """ + + if no_of_users is not None and not isinstance(no_of_users, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: no_of_users EXPECTED TYPE: int', None, None) + + self.__no_of_users = no_of_users + self.__key_modified['no_of_users'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/views.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/views.py new file mode 100644 index 0000000..29004af --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/views.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Views(object): + def __init__(self): + """Creates an instance of Views""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/__init__.py new file mode 100644 index 0000000..e5a4788 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/__init__.py @@ -0,0 +1,11 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .portals_operations import PortalsOperations +from .success_response import SuccessResponse +from .portals import Portals +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_wrapper.py new file mode 100644 index 0000000..b492d5b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__portals = None + self.__key_modified = dict() + + def get_portals(self): + """ + The method to get the portals + + Returns: + list: An instance of list + """ + + return self.__portals + + def set_portals(self, portals): + """ + The method to set the value to portals + + Parameters: + portals (list) : An instance of list + """ + + if portals is not None and not isinstance(portals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portals EXPECTED TYPE: list', None, None) + + self.__portals = portals + self.__key_modified['portals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/api_exception.py new file mode 100644 index 0000000..e1d7d55 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/body_wrapper.py new file mode 100644 index 0000000..11039bc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__portals = None + self.__key_modified = dict() + + def get_portals(self): + """ + The method to get the portals + + Returns: + list: An instance of list + """ + + return self.__portals + + def set_portals(self, portals): + """ + The method to set the value to portals + + Parameters: + portals (list) : An instance of list + """ + + if portals is not None and not isinstance(portals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portals EXPECTED TYPE: list', None, None) + + self.__portals = portals + self.__key_modified['portals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/portals.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/portals.py new file mode 100644 index 0000000..c7c6c19 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/portals.py @@ -0,0 +1,238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Portals(object): + def __init__(self): + """Creates an instance of Portals""" + + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__created_by = None + self.__zaid = None + self.__name = None + self.__active = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_zaid(self): + """ + The method to get the zaid + + Returns: + string: A string representing the zaid + """ + + return self.__zaid + + def set_zaid(self, zaid): + """ + The method to set the value to zaid + + Parameters: + zaid (string) : A string representing the zaid + """ + + if zaid is not None and not isinstance(zaid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zaid EXPECTED TYPE: str', None, None) + + self.__zaid = zaid + self.__key_modified['zaid'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/portals_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/portals_operations.py new file mode 100644 index 0000000..d05fb1c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/portals_operations.py @@ -0,0 +1,144 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class PortalsOperations(object): + def __init__(self): + """Creates an instance of PortalsOperations""" + pass + + def get_portals(self): + """ + The method to get portals + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_portal(self, request): + """ + The method to create portal + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/portals' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_portal(self, portal_name): + """ + The method to get portal + + Parameters: + portal_name (string) : A string representing the portal_name + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(portal_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_name EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals/' + api_path = api_path + str(portal_name) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_portal(self, portal_name, request): + """ + The method to update portal + + Parameters: + portal_name (string) : A string representing the portal_name + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(portal_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_name EXPECTED TYPE: str', 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/v7/settings/portals/' + api_path = api_path + str(portal_name) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/response_wrapper.py new file mode 100644 index 0000000..954b450 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__portals = None + self.__key_modified = dict() + + def get_portals(self): + """ + The method to get the portals + + Returns: + list: An instance of list + """ + + return self.__portals + + def set_portals(self, portals): + """ + The method to set the value to portals + + Parameters: + portals (list) : An instance of list + """ + + if portals is not None and not isinstance(portals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portals EXPECTED TYPE: list', None, None) + + self.__portals = portals + self.__key_modified['portals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/success_response.py new file mode 100644 index 0000000..717e097 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/__init__.py new file mode 100644 index 0000000..8a4366a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/__init__.py @@ -0,0 +1,6 @@ +from .related_lists import RelatedLists +from .wrapper import Wrapper +from .filters import Filters +from .layouts import Layouts +from .views import Views +from .modules import Modules diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/filters.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/filters.py new file mode 100644 index 0000000..b232969 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/filters.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Filters(object): + def __init__(self): + """Creates an instance of Filters""" + + self.__display_label = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/layouts.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/layouts.py new file mode 100644 index 0000000..244f14d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/layouts.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layouts(object): + def __init__(self): + """Creates an instance of Layouts""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/modules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/modules.py new file mode 100644 index 0000000..41d7cbe --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/modules.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__plural_label = None + self.__shared_type = None + self.__api_name = None + self.__id = None + self.__filters = None + self.__layouts = None + self.__views = None + self.__key_modified = dict() + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_shared_type(self): + """ + The method to get the shared_type + + Returns: + string: A string representing the shared_type + """ + + return self.__shared_type + + def set_shared_type(self, shared_type): + """ + The method to set the value to shared_type + + Parameters: + shared_type (string) : A string representing the shared_type + """ + + if shared_type is not None and not isinstance(shared_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_type EXPECTED TYPE: str', None, None) + + self.__shared_type = shared_type + self.__key_modified['shared_type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_filters(self): + """ + The method to get the filters + + Returns: + list: An instance of list + """ + + return self.__filters + + def set_filters(self, filters): + """ + The method to set the value to filters + + Parameters: + filters (list) : An instance of list + """ + + if filters is not None and not isinstance(filters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: list', None, None) + + self.__filters = filters + self.__key_modified['filters'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_views(self): + """ + The method to get the views + + Returns: + list: An instance of list + """ + + return self.__views + + def set_views(self, views): + """ + The method to set the value to views + + Parameters: + views (list) : An instance of list + """ + + if views is not None and not isinstance(views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: views EXPECTED TYPE: list', None, None) + + self.__views = views + self.__key_modified['views'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/related_lists.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/related_lists.py new file mode 100644 index 0000000..abaea27 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/related_lists.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedLists(object): + def __init__(self): + """Creates an instance of RelatedLists""" + + self.__module = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Modules: An instance of Modules + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals_meta.modules import Modules + except Exception: + from .modules import Modules + + if module is not None and not isinstance(module, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Modules', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/views.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/views.py new file mode 100644 index 0000000..29004af --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/views.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Views(object): + def __init__(self): + """Creates an instance of Views""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/wrapper.py new file mode 100644 index 0000000..68063bb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/portals_meta/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__related_lists = None + self.__key_modified = dict() + + def get_related_lists(self): + """ + The method to get the related_lists + + Returns: + list: An instance of list + """ + + return self.__related_lists + + def set_related_lists(self, related_lists): + """ + The method to set the value to related_lists + + Parameters: + related_lists (list) : An instance of list + """ + + if related_lists is not None and not isinstance(related_lists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_lists EXPECTED TYPE: list', None, None) + + self.__related_lists = related_lists + self.__key_modified['related_lists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/__init__.py new file mode 100644 index 0000000..853cf3d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/__init__.py @@ -0,0 +1,2 @@ +from .wrapper import Wrapper +from .apps import Apps diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/apps.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/apps.py new file mode 100644 index 0000000..e396575 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/apps.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Apps(object): + def __init__(self): + """Creates an instance of Apps""" + + self.__name = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/wrapper.py new file mode 100644 index 0000000..3953f43 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__privacy_configurable_apps = None + self.__key_modified = dict() + + def get_privacy_configurable_apps(self): + """ + The method to get the privacy_configurable_apps + + Returns: + list: An instance of list + """ + + return self.__privacy_configurable_apps + + def set_privacy_configurable_apps(self, privacy_configurable_apps): + """ + The method to set the value to privacy_configurable_apps + + Parameters: + privacy_configurable_apps (list) : An instance of list + """ + + if privacy_configurable_apps is not None and not isinstance(privacy_configurable_apps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacy_configurable_apps EXPECTED TYPE: list', None, None) + + self.__privacy_configurable_apps = privacy_configurable_apps + self.__key_modified['privacy_configurable_apps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/__init__.py new file mode 100644 index 0000000..7f71e2c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/__init__.py @@ -0,0 +1,7 @@ +from .privacy_preference import PrivacyPreference +from .preference import Preference +from .tpt import Tpt +from .wrapper import Wrapper +from .section import Section +from .config import Config +from .option import Option diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/config.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/config.py new file mode 100644 index 0000000..32418d2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/config.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Config(object): + def __init__(self): + """Creates an instance of Config""" + + self.__tpt = None + self.__section = None + self.__zoho_integ = None + self.__key_modified = dict() + + def get_tpt(self): + """ + The method to get the tpt + + Returns: + list: An instance of list + """ + + return self.__tpt + + def set_tpt(self, tpt): + """ + The method to set the value to tpt + + Parameters: + tpt (list) : An instance of list + """ + + if tpt is not None and not isinstance(tpt, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tpt EXPECTED TYPE: list', None, None) + + self.__tpt = tpt + self.__key_modified['tpt'] = 1 + + def get_section(self): + """ + The method to get the section + + Returns: + list: An instance of list + """ + + return self.__section + + def set_section(self, section): + """ + The method to set the value to section + + Parameters: + section (list) : An instance of list + """ + + if section is not None and not isinstance(section, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: section EXPECTED TYPE: list', None, None) + + self.__section = section + self.__key_modified['section'] = 1 + + def get_zoho_integ(self): + """ + The method to get the zoho_integ + + Returns: + list: An instance of list + """ + + return self.__zoho_integ + + def set_zoho_integ(self, zoho_integ): + """ + The method to set the value to zoho_integ + + Parameters: + zoho_integ (list) : An instance of list + """ + + if zoho_integ is not None and not isinstance(zoho_integ, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zoho_integ EXPECTED TYPE: list', None, None) + + self.__zoho_integ = zoho_integ + self.__key_modified['zoho_integ'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/option.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/option.py new file mode 100644 index 0000000..cbaddf0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/option.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Option(object): + def __init__(self): + """Creates an instance of Option""" + + self.__name = None + self.__tooltip = None + self.__type = None + self.__suboptions = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + string: A string representing the tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (string) : A string representing the tooltip + """ + + if tooltip is not None and not isinstance(tooltip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: str', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_suboptions(self): + """ + The method to get the suboptions + + Returns: + list: An instance of list + """ + + return self.__suboptions + + def set_suboptions(self, suboptions): + """ + The method to set the value to suboptions + + Parameters: + suboptions (list) : An instance of list + """ + + if suboptions is not None and not isinstance(suboptions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suboptions EXPECTED TYPE: list', None, None) + + self.__suboptions = suboptions + self.__key_modified['suboptions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/preference.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/preference.py new file mode 100644 index 0000000..3fe96d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/preference.py @@ -0,0 +1,599 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Preference(object): + def __init__(self): + """Creates an instance of Preference""" + + self.__consent_modules = None + self.__restrict_tpt_fields = None + self.__exclude_api_zoho = None + self.__awaiting_period = None + self.__consent_mail_send = None + self.__exclude_export_fields = None + self.__limit_actions = None + self.__exclude_export = None + self.__restrict_zoho_integ = None + self.__exclude_api_zoho_fields = None + self.__duration_timing = None + self.__data_processing_duration = None + self.__restrict_tpt_services = None + self.__exclude_api_tpt_fields = None + self.__restrict_zoho_integ_services = None + self.__privacy_setting_status = None + self.__double_opt_in = None + self.__restrict_zoho_integ_fields = None + self.__exclude_api_tpt = None + self.__block_list = None + self.__restrict_tpt = None + self.__actions_while_awaiting = None + self.__key_modified = dict() + + def get_consent_modules(self): + """ + The method to get the consent_modules + + Returns: + string: A string representing the consent_modules + """ + + return self.__consent_modules + + def set_consent_modules(self, consent_modules): + """ + The method to set the value to consent_modules + + Parameters: + consent_modules (string) : A string representing the consent_modules + """ + + if consent_modules is not None and not isinstance(consent_modules, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_modules EXPECTED TYPE: str', None, None) + + self.__consent_modules = consent_modules + self.__key_modified['consent_modules'] = 1 + + def get_restrict_tpt_fields(self): + """ + The method to get the restrict_tpt_fields + + Returns: + string: A string representing the restrict_tpt_fields + """ + + return self.__restrict_tpt_fields + + def set_restrict_tpt_fields(self, restrict_tpt_fields): + """ + The method to set the value to restrict_tpt_fields + + Parameters: + restrict_tpt_fields (string) : A string representing the restrict_tpt_fields + """ + + if restrict_tpt_fields is not None and not isinstance(restrict_tpt_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_tpt_fields EXPECTED TYPE: str', None, None) + + self.__restrict_tpt_fields = restrict_tpt_fields + self.__key_modified['restrict_tpt_fields'] = 1 + + def get_exclude_api_zoho(self): + """ + The method to get the exclude_api_zoho + + Returns: + string: A string representing the exclude_api_zoho + """ + + return self.__exclude_api_zoho + + def set_exclude_api_zoho(self, exclude_api_zoho): + """ + The method to set the value to exclude_api_zoho + + Parameters: + exclude_api_zoho (string) : A string representing the exclude_api_zoho + """ + + if exclude_api_zoho is not None and not isinstance(exclude_api_zoho, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_zoho EXPECTED TYPE: str', None, None) + + self.__exclude_api_zoho = exclude_api_zoho + self.__key_modified['exclude_api_zoho'] = 1 + + def get_awaiting_period(self): + """ + The method to get the awaiting_period + + Returns: + string: A string representing the awaiting_period + """ + + return self.__awaiting_period + + def set_awaiting_period(self, awaiting_period): + """ + The method to set the value to awaiting_period + + Parameters: + awaiting_period (string) : A string representing the awaiting_period + """ + + if awaiting_period is not None and not isinstance(awaiting_period, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: awaiting_period EXPECTED TYPE: str', None, None) + + self.__awaiting_period = awaiting_period + self.__key_modified['awaiting_period'] = 1 + + def get_consent_mail_send(self): + """ + The method to get the consent_mail_send + + Returns: + string: A string representing the consent_mail_send + """ + + return self.__consent_mail_send + + def set_consent_mail_send(self, consent_mail_send): + """ + The method to set the value to consent_mail_send + + Parameters: + consent_mail_send (string) : A string representing the consent_mail_send + """ + + if consent_mail_send is not None and not isinstance(consent_mail_send, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_mail_send EXPECTED TYPE: str', None, None) + + self.__consent_mail_send = consent_mail_send + self.__key_modified['consent_mail_send'] = 1 + + def get_exclude_export_fields(self): + """ + The method to get the exclude_export_fields + + Returns: + string: A string representing the exclude_export_fields + """ + + return self.__exclude_export_fields + + def set_exclude_export_fields(self, exclude_export_fields): + """ + The method to set the value to exclude_export_fields + + Parameters: + exclude_export_fields (string) : A string representing the exclude_export_fields + """ + + if exclude_export_fields is not None and not isinstance(exclude_export_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_export_fields EXPECTED TYPE: str', None, None) + + self.__exclude_export_fields = exclude_export_fields + self.__key_modified['exclude_export_fields'] = 1 + + def get_limit_actions(self): + """ + The method to get the limit_actions + + Returns: + string: A string representing the limit_actions + """ + + return self.__limit_actions + + def set_limit_actions(self, limit_actions): + """ + The method to set the value to limit_actions + + Parameters: + limit_actions (string) : A string representing the limit_actions + """ + + if limit_actions is not None and not isinstance(limit_actions, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: limit_actions EXPECTED TYPE: str', None, None) + + self.__limit_actions = limit_actions + self.__key_modified['limit_actions'] = 1 + + def get_exclude_export(self): + """ + The method to get the exclude_export + + Returns: + string: A string representing the exclude_export + """ + + return self.__exclude_export + + def set_exclude_export(self, exclude_export): + """ + The method to set the value to exclude_export + + Parameters: + exclude_export (string) : A string representing the exclude_export + """ + + if exclude_export is not None and not isinstance(exclude_export, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_export EXPECTED TYPE: str', None, None) + + self.__exclude_export = exclude_export + self.__key_modified['exclude_export'] = 1 + + def get_restrict_zoho_integ(self): + """ + The method to get the restrict_zoho_integ + + Returns: + string: A string representing the restrict_zoho_integ + """ + + return self.__restrict_zoho_integ + + def set_restrict_zoho_integ(self, restrict_zoho_integ): + """ + The method to set the value to restrict_zoho_integ + + Parameters: + restrict_zoho_integ (string) : A string representing the restrict_zoho_integ + """ + + if restrict_zoho_integ is not None and not isinstance(restrict_zoho_integ, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_zoho_integ EXPECTED TYPE: str', None, None) + + self.__restrict_zoho_integ = restrict_zoho_integ + self.__key_modified['restrict_zoho_integ'] = 1 + + def get_exclude_api_zoho_fields(self): + """ + The method to get the exclude_api_zoho_fields + + Returns: + string: A string representing the exclude_api_zoho_fields + """ + + return self.__exclude_api_zoho_fields + + def set_exclude_api_zoho_fields(self, exclude_api_zoho_fields): + """ + The method to set the value to exclude_api_zoho_fields + + Parameters: + exclude_api_zoho_fields (string) : A string representing the exclude_api_zoho_fields + """ + + if exclude_api_zoho_fields is not None and not isinstance(exclude_api_zoho_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_zoho_fields EXPECTED TYPE: str', None, None) + + self.__exclude_api_zoho_fields = exclude_api_zoho_fields + self.__key_modified['exclude_api_zoho_fields'] = 1 + + def get_duration_timing(self): + """ + The method to get the duration_timing + + Returns: + string: A string representing the duration_timing + """ + + return self.__duration_timing + + def set_duration_timing(self, duration_timing): + """ + The method to set the value to duration_timing + + Parameters: + duration_timing (string) : A string representing the duration_timing + """ + + if duration_timing is not None and not isinstance(duration_timing, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duration_timing EXPECTED TYPE: str', None, None) + + self.__duration_timing = duration_timing + self.__key_modified['duration_timing'] = 1 + + def get_data_processing_duration(self): + """ + The method to get the data_processing_duration + + Returns: + string: A string representing the data_processing_duration + """ + + return self.__data_processing_duration + + def set_data_processing_duration(self, data_processing_duration): + """ + The method to set the value to data_processing_duration + + Parameters: + data_processing_duration (string) : A string representing the data_processing_duration + """ + + if data_processing_duration is not None and not isinstance(data_processing_duration, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_processing_duration EXPECTED TYPE: str', None, None) + + self.__data_processing_duration = data_processing_duration + self.__key_modified['data_processing_duration'] = 1 + + def get_restrict_tpt_services(self): + """ + The method to get the restrict_tpt_services + + Returns: + string: A string representing the restrict_tpt_services + """ + + return self.__restrict_tpt_services + + def set_restrict_tpt_services(self, restrict_tpt_services): + """ + The method to set the value to restrict_tpt_services + + Parameters: + restrict_tpt_services (string) : A string representing the restrict_tpt_services + """ + + if restrict_tpt_services is not None and not isinstance(restrict_tpt_services, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_tpt_services EXPECTED TYPE: str', None, None) + + self.__restrict_tpt_services = restrict_tpt_services + self.__key_modified['restrict_tpt_services'] = 1 + + def get_exclude_api_tpt_fields(self): + """ + The method to get the exclude_api_tpt_fields + + Returns: + string: A string representing the exclude_api_tpt_fields + """ + + return self.__exclude_api_tpt_fields + + def set_exclude_api_tpt_fields(self, exclude_api_tpt_fields): + """ + The method to set the value to exclude_api_tpt_fields + + Parameters: + exclude_api_tpt_fields (string) : A string representing the exclude_api_tpt_fields + """ + + if exclude_api_tpt_fields is not None and not isinstance(exclude_api_tpt_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_tpt_fields EXPECTED TYPE: str', None, None) + + self.__exclude_api_tpt_fields = exclude_api_tpt_fields + self.__key_modified['exclude_api_tpt_fields'] = 1 + + def get_restrict_zoho_integ_services(self): + """ + The method to get the restrict_zoho_integ_services + + Returns: + string: A string representing the restrict_zoho_integ_services + """ + + return self.__restrict_zoho_integ_services + + def set_restrict_zoho_integ_services(self, restrict_zoho_integ_services): + """ + The method to set the value to restrict_zoho_integ_services + + Parameters: + restrict_zoho_integ_services (string) : A string representing the restrict_zoho_integ_services + """ + + if restrict_zoho_integ_services is not None and not isinstance(restrict_zoho_integ_services, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_zoho_integ_services EXPECTED TYPE: str', None, None) + + self.__restrict_zoho_integ_services = restrict_zoho_integ_services + self.__key_modified['restrict_zoho_integ_services'] = 1 + + def get_privacy_setting_status(self): + """ + The method to get the privacy_setting_status + + Returns: + string: A string representing the privacy_setting_status + """ + + return self.__privacy_setting_status + + def set_privacy_setting_status(self, privacy_setting_status): + """ + The method to set the value to privacy_setting_status + + Parameters: + privacy_setting_status (string) : A string representing the privacy_setting_status + """ + + if privacy_setting_status is not None and not isinstance(privacy_setting_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacy_setting_status EXPECTED TYPE: str', None, None) + + self.__privacy_setting_status = privacy_setting_status + self.__key_modified['privacy_setting_status'] = 1 + + def get_double_opt_in(self): + """ + The method to get the double_opt_in + + Returns: + string: A string representing the double_opt_in + """ + + return self.__double_opt_in + + def set_double_opt_in(self, double_opt_in): + """ + The method to set the value to double_opt_in + + Parameters: + double_opt_in (string) : A string representing the double_opt_in + """ + + if double_opt_in is not None and not isinstance(double_opt_in, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: double_opt_in EXPECTED TYPE: str', None, None) + + self.__double_opt_in = double_opt_in + self.__key_modified['double_opt_in'] = 1 + + def get_restrict_zoho_integ_fields(self): + """ + The method to get the restrict_zoho_integ_fields + + Returns: + string: A string representing the restrict_zoho_integ_fields + """ + + return self.__restrict_zoho_integ_fields + + def set_restrict_zoho_integ_fields(self, restrict_zoho_integ_fields): + """ + The method to set the value to restrict_zoho_integ_fields + + Parameters: + restrict_zoho_integ_fields (string) : A string representing the restrict_zoho_integ_fields + """ + + if restrict_zoho_integ_fields is not None and not isinstance(restrict_zoho_integ_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_zoho_integ_fields EXPECTED TYPE: str', None, None) + + self.__restrict_zoho_integ_fields = restrict_zoho_integ_fields + self.__key_modified['restrict_zoho_integ_fields'] = 1 + + def get_exclude_api_tpt(self): + """ + The method to get the exclude_api_tpt + + Returns: + string: A string representing the exclude_api_tpt + """ + + return self.__exclude_api_tpt + + def set_exclude_api_tpt(self, exclude_api_tpt): + """ + The method to set the value to exclude_api_tpt + + Parameters: + exclude_api_tpt (string) : A string representing the exclude_api_tpt + """ + + if exclude_api_tpt is not None and not isinstance(exclude_api_tpt, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_tpt EXPECTED TYPE: str', None, None) + + self.__exclude_api_tpt = exclude_api_tpt + self.__key_modified['exclude_api_tpt'] = 1 + + def get_block_list(self): + """ + The method to get the block_list + + Returns: + string: A string representing the block_list + """ + + return self.__block_list + + def set_block_list(self, block_list): + """ + The method to set the value to block_list + + Parameters: + block_list (string) : A string representing the block_list + """ + + if block_list is not None and not isinstance(block_list, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: block_list EXPECTED TYPE: str', None, None) + + self.__block_list = block_list + self.__key_modified['block_list'] = 1 + + def get_restrict_tpt(self): + """ + The method to get the restrict_tpt + + Returns: + string: A string representing the restrict_tpt + """ + + return self.__restrict_tpt + + def set_restrict_tpt(self, restrict_tpt): + """ + The method to set the value to restrict_tpt + + Parameters: + restrict_tpt (string) : A string representing the restrict_tpt + """ + + if restrict_tpt is not None and not isinstance(restrict_tpt, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_tpt EXPECTED TYPE: str', None, None) + + self.__restrict_tpt = restrict_tpt + self.__key_modified['restrict_tpt'] = 1 + + def get_actions_while_awaiting(self): + """ + The method to get the actions_while_awaiting + + Returns: + string: A string representing the actions_while_awaiting + """ + + return self.__actions_while_awaiting + + def set_actions_while_awaiting(self, actions_while_awaiting): + """ + The method to set the value to actions_while_awaiting + + Parameters: + actions_while_awaiting (string) : A string representing the actions_while_awaiting + """ + + if actions_while_awaiting is not None and not isinstance(actions_while_awaiting, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actions_while_awaiting EXPECTED TYPE: str', None, None) + + self.__actions_while_awaiting = actions_while_awaiting + self.__key_modified['actions_while_awaiting'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/privacy_preference.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/privacy_preference.py new file mode 100644 index 0000000..360e5f7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/privacy_preference.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PrivacyPreference(object): + def __init__(self): + """Creates an instance of PrivacyPreference""" + + self.__preference = None + self.__config = None + self.__key_modified = dict() + + def get_preference(self): + """ + The method to get the preference + + Returns: + Preference: An instance of Preference + """ + + return self.__preference + + def set_preference(self, preference): + """ + The method to set the value to preference + + Parameters: + preference (Preference) : An instance of Preference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.privacy_preference.preference import Preference + except Exception: + from .preference import Preference + + if preference is not None and not isinstance(preference, Preference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preference EXPECTED TYPE: Preference', None, None) + + self.__preference = preference + self.__key_modified['preference'] = 1 + + def get_config(self): + """ + The method to get the config + + Returns: + Config: An instance of Config + """ + + return self.__config + + def set_config(self, config): + """ + The method to set the value to config + + Parameters: + config (Config) : An instance of Config + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.privacy_preference.config import Config + except Exception: + from .config import Config + + if config is not None and not isinstance(config, Config): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: config EXPECTED TYPE: Config', None, None) + + self.__config = config + self.__key_modified['config'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/section.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/section.py new file mode 100644 index 0000000..a003ea9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/section.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Section(object): + def __init__(self): + """Creates an instance of Section""" + + self.__name = None + self.__tooltip = None + self.__show_type = None + self.__title = None + self.__options = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + string: A string representing the tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (string) : A string representing the tooltip + """ + + if tooltip is not None and not isinstance(tooltip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: str', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_show_type(self): + """ + The method to get the show_type + + Returns: + string: A string representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (string) : A string representing the show_type + """ + + if show_type is not None and not isinstance(show_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: str', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_options(self): + """ + The method to get the options + + Returns: + list: An instance of list + """ + + return self.__options + + def set_options(self, options): + """ + The method to set the value to options + + Parameters: + options (list) : An instance of list + """ + + if options is not None and not isinstance(options, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: options EXPECTED TYPE: list', None, None) + + self.__options = options + self.__key_modified['options'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/tpt.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/tpt.py new file mode 100644 index 0000000..ca0a8f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/tpt.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tpt(object): + def __init__(self): + """Creates an instance of Tpt""" + + self.__isenabled = None + self.__name = None + self.__issupported = None + self.__key_modified = dict() + + def get_isenabled(self): + """ + The method to get the isenabled + + Returns: + string: A string representing the isenabled + """ + + return self.__isenabled + + def set_isenabled(self, isenabled): + """ + The method to set the value to isenabled + + Parameters: + isenabled (string) : A string representing the isenabled + """ + + if isenabled is not None and not isinstance(isenabled, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isenabled EXPECTED TYPE: str', None, None) + + self.__isenabled = isenabled + self.__key_modified['isEnabled'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_issupported(self): + """ + The method to get the issupported + + Returns: + string: A string representing the issupported + """ + + return self.__issupported + + def set_issupported(self, issupported): + """ + The method to set the value to issupported + + Parameters: + issupported (string) : A string representing the issupported + """ + + if issupported is not None and not isinstance(issupported, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: issupported EXPECTED TYPE: str', None, None) + + self.__issupported = issupported + self.__key_modified['isSupported'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/wrapper.py new file mode 100644 index 0000000..6e155e7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__privacypreference = None + self.__key_modified = dict() + + def get_privacypreference(self): + """ + The method to get the privacypreference + + Returns: + list: An instance of list + """ + + return self.__privacypreference + + def set_privacypreference(self, privacypreference): + """ + The method to set the value to privacypreference + + Parameters: + privacypreference (list) : An instance of list + """ + + if privacypreference is not None and not isinstance(privacypreference, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacypreference EXPECTED TYPE: list', None, None) + + self.__privacypreference = privacypreference + self.__key_modified['privacyPreference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/__init__.py new file mode 100644 index 0000000..51ffabd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .profile import Profile +from .section import Section +from .body_wrapper import BodyWrapper +from .category_others import CategoryOthers +from .permission_detail import PermissionDetail +from .minified_profile import MinifiedProfile +from .api_exception import APIException +from .profiles_operations import ProfilesOperations, GetProfilesParam, GetProfilesHeader, GetProfileHeader, DeleteProfileParam +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .category_module import CategoryModule +from .action_handler import ActionHandler +from .category import Category +from .default_view import DefaultView +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_wrapper.py new file mode 100644 index 0000000..7f7166b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__profiles = None + self.__key_modified = dict() + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/api_exception.py new file mode 100644 index 0000000..acb3f18 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/body_wrapper.py new file mode 100644 index 0000000..9c29c1d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__profiles = None + self.__key_modified = dict() + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category.py new file mode 100644 index 0000000..58a0200 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class Category(ABC): + def __init__(self): + """Creates an instance of Category""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category_module.py new file mode 100644 index 0000000..1aac312 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category_module.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.category import Category +except Exception: + from ..exception import SDKException + from ..util import Constants + from .category import Category + + +class CategoryModule(Category): + def __init__(self): + """Creates an instance of CategoryModule""" + super().__init__() + + self.__display_label = None + self.__permissions_details = None + self.__name = None + self.__module = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_permissions_details(self): + """ + The method to get the permissions_details + + Returns: + list: An instance of list + """ + + return self.__permissions_details + + def set_permissions_details(self, permissions_details): + """ + The method to set the value to permissions_details + + Parameters: + permissions_details (list) : An instance of list + """ + + if permissions_details is not None and not isinstance(permissions_details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: list', None, None) + + self.__permissions_details = permissions_details + self.__key_modified['permissions_details'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category_others.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category_others.py new file mode 100644 index 0000000..e3e3ca2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/category_others.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.category import Category +except Exception: + from ..exception import SDKException + from ..util import Constants + from .category import Category + + +class CategoryOthers(Category): + def __init__(self): + """Creates an instance of CategoryOthers""" + super().__init__() + + self.__display_label = None + self.__permissions_details = None + self.__name = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_permissions_details(self): + """ + The method to get the permissions_details + + Returns: + list: An instance of list + """ + + return self.__permissions_details + + def set_permissions_details(self, permissions_details): + """ + The method to set the value to permissions_details + + Parameters: + permissions_details (list) : An instance of list + """ + + if permissions_details is not None and not isinstance(permissions_details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: list', None, None) + + self.__permissions_details = permissions_details + self.__key_modified['permissions_details'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/default_view.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/default_view.py new file mode 100644 index 0000000..49e724a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/default_view.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultView(object): + def __init__(self): + """Creates an instance of DefaultView""" + + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/info.py new file mode 100644 index 0000000..42190c7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/info.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__license_limit = None + self.__key_modified = dict() + + def get_license_limit(self): + """ + The method to get the license_limit + + Returns: + int: An int representing the license_limit + """ + + return self.__license_limit + + def set_license_limit(self, license_limit): + """ + The method to set the value to license_limit + + Parameters: + license_limit (int) : An int representing the license_limit + """ + + if license_limit is not None and not isinstance(license_limit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: license_limit EXPECTED TYPE: int', None, None) + + self.__license_limit = license_limit + self.__key_modified['license_limit'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/minified_profile.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/minified_profile.py new file mode 100644 index 0000000..185bfe0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/minified_profile.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedProfile(object): + def __init__(self): + """Creates an instance of MinifiedProfile""" + + self.__id = None + self.__name = None + self.__delete = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/permission_detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/permission_detail.py new file mode 100644 index 0000000..cd9108d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/permission_detail.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PermissionDetail(object): + def __init__(self): + """Creates an instance of PermissionDetail""" + + self.__id = None + self.__enabled = None + self.__name = None + self.__display_label = None + self.__customizable = None + self.__parent_permissions = None + self.__module = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_enabled(self): + """ + The method to get the enabled + + Returns: + bool: A bool representing the enabled + """ + + return self.__enabled + + def set_enabled(self, enabled): + """ + The method to set the value to enabled + + Parameters: + enabled (bool) : A bool representing the enabled + """ + + if enabled is not None and not isinstance(enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enabled EXPECTED TYPE: bool', None, None) + + self.__enabled = enabled + self.__key_modified['enabled'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_customizable(self): + """ + The method to get the customizable + + Returns: + bool: A bool representing the customizable + """ + + return self.__customizable + + def set_customizable(self, customizable): + """ + The method to set the value to customizable + + Parameters: + customizable (bool) : A bool representing the customizable + """ + + if customizable is not None and not isinstance(customizable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable EXPECTED TYPE: bool', None, None) + + self.__customizable = customizable + self.__key_modified['customizable'] = 1 + + def get_parent_permissions(self): + """ + The method to get the parent_permissions + + Returns: + list: An instance of list + """ + + return self.__parent_permissions + + def set_parent_permissions(self, parent_permissions): + """ + The method to set the value to parent_permissions + + Parameters: + parent_permissions (list) : An instance of list + """ + + if parent_permissions is not None and not isinstance(parent_permissions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_permissions EXPECTED TYPE: list', None, None) + + self.__parent_permissions = parent_permissions + self.__key_modified['parent_permissions'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/profile.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/profile.py new file mode 100644 index 0000000..5e662f2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/profile.py @@ -0,0 +1,493 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__defaultview = None + self.__name = None + self.__description = None + self.__id = None + self.__default = None + self.__delete = None + self.__permission_type = None + self.__custom = None + self.__display_label = None + self.__type = None + self.__permissions_details = None + self.__sections = None + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__category = None + self.__created_by = None + self.__key_modified = dict() + + def get_defaultview(self): + """ + The method to get the defaultview + + Returns: + DefaultView: An instance of DefaultView + """ + + return self.__defaultview + + def set_defaultview(self, defaultview): + """ + The method to set the value to defaultview + + Parameters: + defaultview (DefaultView) : An instance of DefaultView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.default_view import DefaultView + except Exception: + from .default_view import DefaultView + + if defaultview is not None and not isinstance(defaultview, DefaultView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', None, None) + + self.__defaultview = defaultview + self.__key_modified['_default_view'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + string: A string representing the permission_type + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (string) : A string representing the permission_type + """ + + if permission_type is not None and not isinstance(permission_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: str', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def get_custom(self): + """ + The method to get the custom + + Returns: + bool: A bool representing the custom + """ + + return self.__custom + + def set_custom(self, custom): + """ + The method to set the value to custom + + Parameters: + custom (bool) : A bool representing the custom + """ + + if custom is not None and not isinstance(custom, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom EXPECTED TYPE: bool', None, None) + + self.__custom = custom + self.__key_modified['custom'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_permissions_details(self): + """ + The method to get the permissions_details + + Returns: + list: An instance of list + """ + + return self.__permissions_details + + def set_permissions_details(self, permissions_details): + """ + The method to set the value to permissions_details + + Parameters: + permissions_details (list) : An instance of list + """ + + if permissions_details is not None and not isinstance(permissions_details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: list', None, None) + + self.__permissions_details = permissions_details + self.__key_modified['permissions_details'] = 1 + + def get_sections(self): + """ + The method to get the sections + + Returns: + list: An instance of list + """ + + return self.__sections + + def set_sections(self, sections): + """ + The method to set the value to sections + + Parameters: + sections (list) : An instance of list + """ + + if sections is not None and not isinstance(sections, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: list', None, None) + + self.__sections = sections + self.__key_modified['sections'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + bool: A bool representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (bool) : A bool representing the category + """ + + if category is not None and not isinstance(category, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: bool', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/profiles_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/profiles_operations.py new file mode 100644 index 0000000..559895d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/profiles_operations.py @@ -0,0 +1,219 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class ProfilesOperations(object): + def __init__(self): + """Creates an instance of ProfilesOperations""" + pass + + def get_profiles(self, param_instance=None): + """ + The method to get profiles + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/profiles' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def clone_profiles(self, id, request): + """ + The method to clone profiles + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/profiles/' + api_path = api_path + str(id) + api_path = api_path + '/actions/clone' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_profile(self, id, request): + """ + The method to update profile + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/profiles/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_profile(self, id): + """ + The method to get profile + + 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/v7/settings/profiles/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_profile(self, id, param_instance=None): + """ + The method to delete profile + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/profiles/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetProfilesParam(object): + include_lite_profile = Param('include_lite_profile', 'com.zoho.crm.api.Profiles.GetProfilesParam') + + +class GetProfilesHeader(object): + pass + + +class GetProfileHeader(object): + pass + + +class DeleteProfileParam(object): + transfer_to = Param('transfer_to', 'com.zoho.crm.api.Profiles.DeleteProfileParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/response_wrapper.py new file mode 100644 index 0000000..31cabb7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__profiles = None + self.__info = None + self.__key_modified = dict() + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/section.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/section.py new file mode 100644 index 0000000..0840f41 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/section.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Section(object): + def __init__(self): + """Creates an instance of Section""" + + self.__name = None + self.__categories = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_categories(self): + """ + The method to get the categories + + Returns: + list: An instance of list + """ + + return self.__categories + + def set_categories(self, categories): + """ + The method to set the value to categories + + Parameters: + categories (list) : An instance of list + """ + + if categories is not None and not isinstance(categories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: categories EXPECTED TYPE: list', None, None) + + self.__categories = categories + self.__key_modified['categories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/success_response.py new file mode 100644 index 0000000..deb52c4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/profiles/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class SuccessResponse(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/__init__.py new file mode 100644 index 0000000..b6cd274 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/__init__.py @@ -0,0 +1,52 @@ +from .image_upload import ImageUpload +from .file_details import FileDetails +from .criteria import Criteria +from .record_operations import RecordOperations, GetRecordParam, GetRecordHeader, UpdateRecordHeader, DeleteRecordParam, DeleteRecordHeader, GetRecordsParam, GetRecordsHeader, CreateRecordsHeader, UpdateRecordsHeader, DeleteRecordsParam, DeleteRecordsHeader, UpsertRecordsHeader, GetDeletedRecordsParam, GetDeletedRecordsHeader, SearchRecordsParam, SearchRecordsHeader, UploadPhotoParam, GetMassUpdateStatusParam, RecordCountParam, GetRecordUsingExternalIDParam, GetRecordUsingExternalIDHeader, UpdateRecordUsingExternalIDHeader, DeleteRecordUsingExternalIDParam, DeleteRecordUsingExternalIDHeader +from .count_wrapper import CountWrapper +from .mass_update_response_wrapper import MassUpdateResponseWrapper +from .recurring_activity import RecurringActivity +from .record import Record +from .options import Options +from .download_handler import DownloadHandler +from .info import Info +from .tax import Tax +from .body_wrapper import BodyWrapper +from .consent import Consent +from .multi_select_lookup import MultiSelectLookup +from .line_item_product import LineItemProduct +from .field import Field +from .count_handler import CountHandler +from .mass_update_success_response import MassUpdateSuccessResponse +from .line_tax import LineTax +from .widget import Widget +from .deleted_record import DeletedRecord +from .duplicate_record import DuplicateRecord +from .pricing_details import PricingDetails +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .time_range import TimeRange +from .file_body_wrapper import FileBodyWrapper +from .success_response import SuccessResponse +from .mass_update_response import MassUpdateResponse +from .action_handler import ActionHandler +from .price_book import PriceBook +from .participants import Participants +from .action_wrapper import ActionWrapper +from .mass_update_action_wrapper import MassUpdateActionWrapper +from .reminder import Reminder +from .mass_update_action_handler import MassUpdateActionHandler +from .mass_update_body_wrapper import MassUpdateBodyWrapper +from .deleted_records_wrapper import DeletedRecordsWrapper +from .file_handler import FileHandler +from .remind_at import RemindAt +from .mass_update_action_response import MassUpdateActionResponse +from .deleted_records_handler import DeletedRecordsHandler +from .mass_update_territory import MassUpdateTerritory +from .mass_update_response_handler import MassUpdateResponseHandler +from .multi_select_picklist import MultiSelectPicklist +from .response_wrapper import ResponseWrapper +from .comment import Comment +from .wizard import Wizard +from .mass_update import MassUpdate +from .territory import Territory diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_wrapper.py new file mode 100644 index 0000000..fad9a72 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/api_exception.py new file mode 100644 index 0000000..d42d33b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/api_exception.py @@ -0,0 +1,172 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response_handler import MassUpdateResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_handler import MassUpdateActionHandler + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response import MassUpdateResponse + from zohocrmsdk.src.com.zoho.crm.api.record.count_handler import CountHandler + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.record.download_handler import DownloadHandler + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_response import MassUpdateActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record.deleted_records_handler import DeletedRecordsHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .mass_update_response_handler import MassUpdateResponseHandler + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .mass_update_action_handler import MassUpdateActionHandler + from .mass_update_response import MassUpdateResponse + from .count_handler import CountHandler + from .action_handler import ActionHandler + from .download_handler import DownloadHandler + from .file_handler import FileHandler + from .mass_update_action_response import MassUpdateActionResponse + from .deleted_records_handler import DeletedRecordsHandler + + +class APIException(ResponseHandler, ActionResponse, ActionHandler, DeletedRecordsHandler, DownloadHandler, FileHandler, MassUpdateActionResponse, MassUpdateActionHandler, MassUpdateResponse, MassUpdateResponseHandler, CountHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/body_wrapper.py new file mode 100644 index 0000000..085259b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/body_wrapper.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__trigger = None + self.__process = None + self.__duplicate_check_fields = None + self.__wf_trigger = None + self.__lar_id = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_trigger(self): + """ + The method to get the trigger + + Returns: + list: An instance of list + """ + + return self.__trigger + + def set_trigger(self, trigger): + """ + The method to set the value to trigger + + Parameters: + trigger (list) : An instance of list + """ + + if trigger is not None and not isinstance(trigger, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trigger EXPECTED TYPE: list', None, None) + + self.__trigger = trigger + self.__key_modified['trigger'] = 1 + + def get_process(self): + """ + The method to get the process + + Returns: + list: An instance of list + """ + + return self.__process + + def set_process(self, process): + """ + The method to set the value to process + + Parameters: + process (list) : An instance of list + """ + + if process is not None and not isinstance(process, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process EXPECTED TYPE: list', None, None) + + self.__process = process + self.__key_modified['process'] = 1 + + def get_duplicate_check_fields(self): + """ + The method to get the duplicate_check_fields + + Returns: + list: An instance of list + """ + + return self.__duplicate_check_fields + + def set_duplicate_check_fields(self, duplicate_check_fields): + """ + The method to set the value to duplicate_check_fields + + Parameters: + duplicate_check_fields (list) : An instance of list + """ + + if duplicate_check_fields is not None and not isinstance(duplicate_check_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_fields EXPECTED TYPE: list', None, None) + + self.__duplicate_check_fields = duplicate_check_fields + self.__key_modified['duplicate_check_fields'] = 1 + + def get_wf_trigger(self): + """ + The method to get the wf_trigger + + Returns: + string: A string representing the wf_trigger + """ + + return self.__wf_trigger + + def set_wf_trigger(self, wf_trigger): + """ + The method to set the value to wf_trigger + + Parameters: + wf_trigger (string) : A string representing the wf_trigger + """ + + if wf_trigger is not None and not isinstance(wf_trigger, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wf_trigger EXPECTED TYPE: str', None, None) + + self.__wf_trigger = wf_trigger + self.__key_modified['wf_trigger'] = 1 + + def get_lar_id(self): + """ + The method to get the lar_id + + Returns: + string: A string representing the lar_id + """ + + return self.__lar_id + + def set_lar_id(self, lar_id): + """ + The method to set the value to lar_id + + Parameters: + lar_id (string) : A string representing the lar_id + """ + + if lar_id is not None and not isinstance(lar_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lar_id EXPECTED TYPE: str', None, None) + + self.__lar_id = lar_id + self.__key_modified['lar_id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/comment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/comment.py new file mode 100644 index 0000000..b7492e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/comment.py @@ -0,0 +1,151 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Comment(object): + def __init__(self): + """Creates an instance of Comment""" + + self.__commented_by = None + self.__commented_time = None + self.__comment_content = None + self.__id = None + self.__key_modified = dict() + + def get_commented_by(self): + """ + The method to get the commented_by + + Returns: + string: A string representing the commented_by + """ + + return self.__commented_by + + def set_commented_by(self, commented_by): + """ + The method to set the value to commented_by + + Parameters: + commented_by (string) : A string representing the commented_by + """ + + if commented_by is not None and not isinstance(commented_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: commented_by EXPECTED TYPE: str', None, None) + + self.__commented_by = commented_by + self.__key_modified['commented_by'] = 1 + + def get_commented_time(self): + """ + The method to get the commented_time + + Returns: + datetime: An instance of datetime + """ + + return self.__commented_time + + def set_commented_time(self, commented_time): + """ + The method to set the value to commented_time + + Parameters: + commented_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if commented_time is not None and not isinstance(commented_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: commented_time EXPECTED TYPE: datetime', None, None) + + self.__commented_time = commented_time + self.__key_modified['commented_time'] = 1 + + def get_comment_content(self): + """ + The method to get the comment_content + + Returns: + string: A string representing the comment_content + """ + + return self.__comment_content + + def set_comment_content(self, comment_content): + """ + The method to set the value to comment_content + + Parameters: + comment_content (string) : A string representing the comment_content + """ + + if comment_content is not None and not isinstance(comment_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comment_content EXPECTED TYPE: str', None, None) + + self.__comment_content = comment_content + self.__key_modified['comment_content'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/consent.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/consent.py new file mode 100644 index 0000000..31b662c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/consent.py @@ -0,0 +1,429 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class Consent(Record): + def __init__(self): + """Creates an instance of Consent""" + super().__init__() + + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Owner') + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Owner', owner) + + def get_contact_through_email(self): + """ + The method to get the contact_through_email + + Returns: + bool: A bool representing the contact_through_email + """ + + return self.get_key_value('Contact_Through_Email') + + def set_contact_through_email(self, contact_through_email): + """ + The method to set the value to contact_through_email + + Parameters: + contact_through_email (bool) : A bool representing the contact_through_email + """ + + if contact_through_email is not None and not isinstance(contact_through_email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_email EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Email', contact_through_email) + + def get_contact_through_social(self): + """ + The method to get the contact_through_social + + Returns: + bool: A bool representing the contact_through_social + """ + + return self.get_key_value('Contact_Through_Social') + + def set_contact_through_social(self, contact_through_social): + """ + The method to set the value to contact_through_social + + Parameters: + contact_through_social (bool) : A bool representing the contact_through_social + """ + + if contact_through_social is not None and not isinstance(contact_through_social, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_social EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Social', contact_through_social) + + def get_contact_through_survey(self): + """ + The method to get the contact_through_survey + + Returns: + bool: A bool representing the contact_through_survey + """ + + return self.get_key_value('Contact_Through_Survey') + + def set_contact_through_survey(self, contact_through_survey): + """ + The method to set the value to contact_through_survey + + Parameters: + contact_through_survey (bool) : A bool representing the contact_through_survey + """ + + if contact_through_survey is not None and not isinstance(contact_through_survey, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_survey EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Survey', contact_through_survey) + + def get_contact_through_phone(self): + """ + The method to get the contact_through_phone + + Returns: + bool: A bool representing the contact_through_phone + """ + + return self.get_key_value('Contact_Through_Phone') + + def set_contact_through_phone(self, contact_through_phone): + """ + The method to set the value to contact_through_phone + + Parameters: + contact_through_phone (bool) : A bool representing the contact_through_phone + """ + + if contact_through_phone is not None and not isinstance(contact_through_phone, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_phone EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Phone', contact_through_phone) + + def get_mail_sent_time(self): + """ + The method to get the mail_sent_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Mail_Sent_Time') + + def set_mail_sent_time(self, mail_sent_time): + """ + The method to set the value to mail_sent_time + + Parameters: + mail_sent_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if mail_sent_time is not None and not isinstance(mail_sent_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_sent_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Mail_Sent_Time', mail_sent_time) + + def get_consent_date(self): + """ + The method to get the consent_date + + Returns: + date: An instance of date + """ + + return self.get_key_value('Consent_Date') + + def set_consent_date(self, consent_date): + """ + The method to set the value to consent_date + + Parameters: + consent_date (date) : An instance of date + """ + + from datetime import date as date1 + + if consent_date is not None and not isinstance(consent_date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_date EXPECTED TYPE: date1', None, None) + + self.add_key_value('Consent_Date', consent_date) + + def get_consent_remarks(self): + """ + The method to get the consent_remarks + + Returns: + string: A string representing the consent_remarks + """ + + return self.get_key_value('Consent_Remarks') + + def set_consent_remarks(self, consent_remarks): + """ + The method to set the value to consent_remarks + + Parameters: + consent_remarks (string) : A string representing the consent_remarks + """ + + if consent_remarks is not None and not isinstance(consent_remarks, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_remarks EXPECTED TYPE: str', None, None) + + self.add_key_value('Consent_Remarks', consent_remarks) + + def get_consent_through(self): + """ + The method to get the consent_through + + Returns: + string: A string representing the consent_through + """ + + return self.get_key_value('Consent_Through') + + def set_consent_through(self, consent_through): + """ + The method to set the value to consent_through + + Parameters: + consent_through (string) : A string representing the consent_through + """ + + if consent_through is not None and not isinstance(consent_through, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_through EXPECTED TYPE: str', None, None) + + self.add_key_value('Consent_Through', consent_through) + + def get_data_processing_basis(self): + """ + The method to get the data_processing_basis + + Returns: + string: A string representing the data_processing_basis + """ + + return self.get_key_value('Data_Processing_Basis') + + def set_data_processing_basis(self, data_processing_basis): + """ + The method to set the value to data_processing_basis + + Parameters: + data_processing_basis (string) : A string representing the data_processing_basis + """ + + if data_processing_basis is not None and not isinstance(data_processing_basis, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_processing_basis EXPECTED TYPE: str', None, None) + + self.add_key_value('Data_Processing_Basis', data_processing_basis) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/count_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/count_handler.py new file mode 100644 index 0000000..6c4eb60 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/count_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class CountHandler(ABC): + def __init__(self): + """Creates an instance of CountHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/count_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/count_wrapper.py new file mode 100644 index 0000000..88b90a8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/count_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.count_handler import CountHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .count_handler import CountHandler + + +class CountWrapper(CountHandler): + def __init__(self): + """Creates an instance of CountWrapper""" + super().__init__() + + self.__count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/criteria.py new file mode 100644 index 0000000..fe44a34 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/criteria.py @@ -0,0 +1,171 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + Choice: An instance of Choice + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (Choice) : An instance of Choice + """ + + if comparator is not None and not isinstance(comparator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Choice', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + string: A string representing the field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (string) : A string representing the field + """ + + if field is not None and not isinstance(field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: str', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + Choice: An instance of Choice + """ + + return self.__group_operator + + 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 get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_record.py new file mode 100644 index 0000000..e1338c9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_record.py @@ -0,0 +1,211 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DeletedRecord(object): + def __init__(self): + """Creates an instance of DeletedRecord""" + + self.__deleted_by = None + self.__id = None + self.__display_name = None + self.__type = None + self.__created_by = None + self.__deleted_time = None + self.__key_modified = dict() + + def get_deleted_by(self): + """ + The method to get the deleted_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__deleted_by + + def set_deleted_by(self, deleted_by): + """ + The method to set the value to deleted_by + + Parameters: + deleted_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if deleted_by is not None and not isinstance(deleted_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__deleted_by = deleted_by + self.__key_modified['deleted_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_display_name(self): + """ + The method to get the display_name + + Returns: + string: A string representing the display_name + """ + + return self.__display_name + + def set_display_name(self, display_name): + """ + The method to set the value to display_name + + Parameters: + display_name (string) : A string representing the display_name + """ + + if display_name is not None and not isinstance(display_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_name EXPECTED TYPE: str', None, None) + + self.__display_name = display_name + self.__key_modified['display_name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_deleted_time(self): + """ + The method to get the deleted_time + + Returns: + datetime: An instance of datetime + """ + + return self.__deleted_time + + def set_deleted_time(self, deleted_time): + """ + The method to set the value to deleted_time + + Parameters: + deleted_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if deleted_time is not None and not isinstance(deleted_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_time EXPECTED TYPE: datetime', None, None) + + self.__deleted_time = deleted_time + self.__key_modified['deleted_time'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_handler.py new file mode 100644 index 0000000..4dcc93a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DeletedRecordsHandler(ABC): + def __init__(self): + """Creates an instance of DeletedRecordsHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_wrapper.py new file mode 100644 index 0000000..adec4dc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.deleted_records_handler import DeletedRecordsHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .deleted_records_handler import DeletedRecordsHandler + + +class DeletedRecordsWrapper(DeletedRecordsHandler): + def __init__(self): + """Creates an instance of DeletedRecordsWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/download_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/download_handler.py new file mode 100644 index 0000000..3188004 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/download_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DownloadHandler(ABC): + def __init__(self): + """Creates an instance of DownloadHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/duplicate_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/duplicate_record.py new file mode 100644 index 0000000..9c3e8b9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/duplicate_record.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DuplicateRecord(object): + def __init__(self): + """Creates an instance of DuplicateRecord""" + + self.__owner = None + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['Owner'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/field.py new file mode 100644 index 0000000..e21a0b6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/field.py @@ -0,0 +1,2940 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self, api_name): + """ + Creates an instance of Field with the given parameters + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + + class Products(object): + + @classmethod + def product_category(cls): + return Field('Product_Category') + + @classmethod + def qty_in_demand(cls): + return Field('Qty_in_Demand') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def sales_start_date(cls): + return Field('Sales_Start_Date') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def product_active(cls): + return Field('Product_Active') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def product_code(cls): + return Field('Product_Code') + + @classmethod + def manufacturer(cls): + return Field('Manufacturer') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def support_expiry_date(cls): + return Field('Support_Expiry_Date') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def commission_rate(cls): + return Field('Commission_Rate') + + @classmethod + def product_name(cls): + return Field('Product_Name') + + @classmethod + def handler(cls): + return Field('Handler') + + @classmethod + def support_start_date(cls): + return Field('Support_Start_Date') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def usage_unit(cls): + return Field('Usage_Unit') + + @classmethod + def qty_ordered(cls): + return Field('Qty_Ordered') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def qty_in_stock(cls): + return Field('Qty_in_Stock') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def sales_end_date(cls): + return Field('Sales_End_Date') + + @classmethod + def unit_price(cls): + return Field('Unit_Price') + + @classmethod + def taxable(cls): + return Field('Taxable') + + @classmethod + def reorder_level(cls): + return Field('Reorder_Level') + + + + + class Consents(object): + + @classmethod + def contact_through_email(cls): + return Field('Contact_Through_Email') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def consent_through(cls): + return Field('Consent_Through') + + @classmethod + def contact_through_survey(cls): + return Field('Contact_Through_Survey') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def data_processing_basis(cls): + return Field('Data_Processing_Basis') + + @classmethod + def contact_through_phone(cls): + return Field('Contact_Through_Phone') + + @classmethod + def lawful_reason(cls): + return Field('Lawful_Reason') + + @classmethod + def mail_sent_time(cls): + return Field('Mail_Sent_Time') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def consent_date(cls): + return Field('Consent_Date') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def consent_remarks(cls): + return Field('Consent_Remarks') + + + + + class Tasks(object): + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def priority(cls): + return Field('Priority') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def closed_time(cls): + return Field('Closed_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def send_notification_email(cls): + return Field('Send_Notification_Email') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def recurring_activity(cls): + return Field('Recurring_Activity') + + @classmethod + def what_id(cls): + return Field('What_Id') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def remind_at(cls): + return Field('Remind_At') + + @classmethod + def who_id(cls): + return Field('Who_Id') + + + + + class Data_Subject_Requests(object): + + @classmethod + def request_type(cls): + return Field('Request_Type') + + @classmethod + def is_closed(cls): + return Field('Is_Closed') + + @classmethod + def parent_id(cls): + return Field('Parent_Id') + + @classmethod + def request_source(cls): + return Field('Request_Source') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def closed_by(cls): + return Field('Closed_By') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def requested_by(cls): + return Field('Requested_By') + + @classmethod + def requested_date(cls): + return Field('Requested_Date') + + @classmethod + def closed_date(cls): + return Field('Closed_Date') + + + + + class Vendors(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def category(cls): + return Field('Category') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def website(cls): + return Field('Website') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def unsubscribed_mode(cls): + return Field('Unsubscribed_Mode') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def street(cls): + return Field('Street') + + @classmethod + def zip_code(cls): + return Field('Zip_Code') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def email_opt_out(cls): + return Field('Email_Opt_Out') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def unsubscribed_time(cls): + return Field('Unsubscribed_Time') + + @classmethod + def city(cls): + return Field('City') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def state(cls): + return Field('State') + + @classmethod + def gl_account(cls): + return Field('GL_Account') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def country(cls): + return Field('Country') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + + + + class Data_Enrichment_Stats__s(object): + + @classmethod + def usage_bulk_count__s(cls): + return Field('Usage_Bulk_Count__s') + + @classmethod + def usage_date__s(cls): + return Field('Usage_Date__s') + + @classmethod + def feature_name__s(cls): + return Field('Feature_Name__s') + + @classmethod + def module__s(cls): + return Field('Module__s') + + @classmethod + def add_on_limit__s(cls): + return Field('Add_On_Limit__s') + + @classmethod + def monthly_limit__s(cls): + return Field('Monthly_Limit__s') + + @classmethod + def usage_count__s(cls): + return Field('Usage_Count__s') + + + + + class Appointments__s(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def address(cls): + return Field('Address') + + @classmethod + def appointment_start_time(cls): + return Field('Appointment_Start_Time') + + @classmethod + def cancellation_reason(cls): + return Field('Cancellation_Reason') + + @classmethod + def appointment_for(cls): + return Field('Appointment_For') + + @classmethod + def rescheduled_to(cls): + return Field('Rescheduled_To') + + @classmethod + def reschedule_reason(cls): + return Field('Reschedule_Reason') + + @classmethod + def job_sheet_name__s(cls): + return Field('Job_Sheet_Name__s') + + @classmethod + def additional_information(cls): + return Field('Additional_Information') + + @classmethod + def job_sheet_created__s(cls): + return Field('Job_Sheet_Created__s') + + @classmethod + def cancelled_time(cls): + return Field('Cancelled_Time') + + @classmethod + def cancellation_note(cls): + return Field('Cancellation_Note') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def reschedule_count(cls): + return Field('Reschedule_Count') + + @classmethod + def rescheduled_by(cls): + return Field('Rescheduled_By') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def rescheduled_time(cls): + return Field('Rescheduled_Time') + + @classmethod + def remind_at(cls): + return Field('Remind_At') + + @classmethod + def appointment_end_time(cls): + return Field('Appointment_End_Time') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def service_name(cls): + return Field('Service_Name') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def rescheduled_from(cls): + return Field('Rescheduled_From') + + @classmethod + def cancelled_by(cls): + return Field('Cancelled_By') + + @classmethod + def duration(cls): + return Field('Duration') + + @classmethod + def appointment_name(cls): + return Field('Appointment_Name') + + @classmethod + def job_sheet_section__s(cls): + return Field('Job_Sheet_Section__s') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def job_sheet_description__s(cls): + return Field('Job_Sheet_Description__s') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def location(cls): + return Field('Location') + + @classmethod + def reschedule_note(cls): + return Field('Reschedule_Note') + + + + + class Calls(object): + + @classmethod + def call_duration(cls): + return Field('Call_Duration') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def caller_id(cls): + return Field('Caller_ID') + + @classmethod + def cti_entry(cls): + return Field('CTI_Entry') + + @classmethod + def call_agenda(cls): + return Field('Call_Agenda') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def call_purpose(cls): + return Field('Call_Purpose') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def who_id(cls): + return Field('Who_Id') + + @classmethod + def outgoing_call_status(cls): + return Field('Outgoing_Call_Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def reminder(cls): + return Field('Reminder') + + @classmethod + def voice_recording__s(cls): + return Field('Voice_Recording__s') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def call_start_time(cls): + return Field('Call_Start_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def call_type(cls): + return Field('Call_Type') + + @classmethod + def scheduled_in_crm(cls): + return Field('Scheduled_In_CRM') + + @classmethod + def call_result(cls): + return Field('Call_Result') + + @classmethod + def what_id(cls): + return Field('What_Id') + + @classmethod + def call_duration_in_seconds(cls): + return Field('Call_Duration_in_seconds') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def dialled_number(cls): + return Field('Dialled_Number') + + + + + class Leads(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def company(cls): + return Field('Company') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def visitor_score(cls): + return Field('Visitor_Score') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def industry(cls): + return Field('Industry') + + @classmethod + def unsubscribed_mode(cls): + return Field('Unsubscribed_Mode') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def street(cls): + return Field('Street') + + @classmethod + def data_processing_basis_details(cls): + return Field('Data_Processing_Basis_Details') + + @classmethod + def zip_code(cls): + return Field('Zip_Code') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def data_source(cls): + return Field('Data_Source') + + @classmethod + def enrich_status__s(cls): + return Field('Enrich_Status__s') + + @classmethod + def first_visited_url(cls): + return Field('First_Visited_URL') + + @classmethod + def days_visited(cls): + return Field('Days_Visited') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def city(cls): + return Field('City') + + @classmethod + def no_of_employees(cls): + return Field('No_of_Employees') + + @classmethod + def data_processing_basis(cls): + return Field('Data_Processing_Basis') + + @classmethod + def converted__s(cls): + return Field('Converted__s') + + @classmethod + def converted_date_time(cls): + return Field('Converted_Date_Time') + + @classmethod + def converted_account(cls): + return Field('Converted_Account') + + @classmethod + def state(cls): + return Field('State') + + @classmethod + def country(cls): + return Field('Country') + + @classmethod + def last_visited_time(cls): + return Field('Last_Visited_Time') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def annual_revenue(cls): + return Field('Annual_Revenue') + + @classmethod + def secondary_email(cls): + return Field('Secondary_Email') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def number_of_chats(cls): + return Field('Number_Of_Chats') + + @classmethod + def rating(cls): + return Field('Rating') + + @classmethod + def website(cls): + return Field('Website') + + @classmethod + def twitter(cls): + return Field('Twitter') + + @classmethod + def average_time_spent_minutes(cls): + return Field('Average_Time_Spent_Minutes') + + @classmethod + def salutation(cls): + return Field('Salutation') + + @classmethod + def first_name(cls): + return Field('First_Name') + + @classmethod + def full_name(cls): + return Field('Full_Name') + + @classmethod + def lead_status(cls): + return Field('Lead_Status') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def converted_deal(cls): + return Field('Converted_Deal') + + @classmethod + def lead_conversion_time(cls): + return Field('Lead_Conversion_Time') + + @classmethod + def skype_id(cls): + return Field('Skype_ID') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def email_opt_out(cls): + return Field('Email_Opt_Out') + + @classmethod + def designation(cls): + return Field('Designation') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def unsubscribed_time(cls): + return Field('Unsubscribed_Time') + + @classmethod + def converted_contact(cls): + return Field('Converted_Contact') + + @classmethod + def mobile(cls): + return Field('Mobile') + + @classmethod + def territories(cls): + return Field('Territories') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def first_visited_time(cls): + return Field('First_Visited_Time') + + @classmethod + def last_name(cls): + return Field('Last_Name') + + @classmethod + def layout(cls): + return Field('Layout') + + @classmethod + def referrer(cls): + return Field('Referrer') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def lead_source(cls): + return Field('Lead_Source') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def fax(cls): + return Field('Fax') + + @classmethod + def last_enriched_time__s(cls): + return Field('Last_Enriched_Time__s') + + + + + class Deals(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def campaign_source(cls): + return Field('Campaign_Source') + + @classmethod + def closing_date(cls): + return Field('Closing_Date') + + @classmethod + def reason_for_loss__s(cls): + return Field('Reason_For_Loss__s') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def lead_conversion_time(cls): + return Field('Lead_Conversion_Time') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def expected_revenue(cls): + return Field('Expected_Revenue') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def overall_sales_duration(cls): + return Field('Overall_Sales_Duration') + + @classmethod + def stage(cls): + return Field('Stage') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def territory(cls): + return Field('Territory') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def amount(cls): + return Field('Amount') + + @classmethod + def probability(cls): + return Field('Probability') + + @classmethod + def next_step(cls): + return Field('Next_Step') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def pipeline(cls): + return Field('Pipeline') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def sales_cycle_duration(cls): + return Field('Sales_Cycle_Duration') + + @classmethod + def type(cls): + return Field('Type') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def lead_source(cls): + return Field('Lead_Source') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + + + + class Quotes(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def valid_till(cls): + return Field('Valid_Till') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def team(cls): + return Field('Team') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def carrier(cls): + return Field('Carrier') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def quoted_items(cls): + return Field('Quoted_Items') + + @classmethod + def quote_stage(cls): + return Field('Quote_Stage') + + @classmethod + def grand_total(cls): + return Field('Grand_Total') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def quote_number(cls): + return Field('Quote_Number') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Invoices(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def invoice_date(cls): + return Field('Invoice_Date') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def invoiced_items(cls): + return Field('Invoiced_Items') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def sales_order(cls): + return Field('Sales_Order') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def sales_commission(cls): + return Field('Sales_Commission') + + @classmethod + def grand_total(cls): + return Field('Grand_Total') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def invoice_number(cls): + return Field('Invoice_Number') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def excise_duty(cls): + return Field('Excise_Duty') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def purchase_order(cls): + return Field('Purchase_Order') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Campaigns(object): + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def campaign_name(cls): + return Field('Campaign_Name') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def end_date(cls): + return Field('End_Date') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def type(cls): + return Field('Type') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def num_sent(cls): + return Field('Num_sent') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def expected_revenue(cls): + return Field('Expected_Revenue') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def actual_cost(cls): + return Field('Actual_Cost') + + @classmethod + def expected_response(cls): + return Field('Expected_Response') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def parent_campaign(cls): + return Field('Parent_Campaign') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def start_date(cls): + return Field('Start_Date') + + @classmethod + def budgeted_cost(cls): + return Field('Budgeted_Cost') + + + + + class Attachments(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def file_name(cls): + return Field('File_Name') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def size(cls): + return Field('Size') + + @classmethod + def parent_id(cls): + return Field('Parent_Id') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + + + + class Price_Books(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def pricing_details(cls): + return Field('Pricing_Details') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def active(cls): + return Field('Active') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def pricing_model(cls): + return Field('Pricing_Model') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def price_book_name(cls): + return Field('Price_Book_Name') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + + + + class Sales_Orders(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def customer_no(cls): + return Field('Customer_No') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def carrier(cls): + return Field('Carrier') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def ordered_items(cls): + return Field('Ordered_Items') + + @classmethod + def quote_name(cls): + return Field('Quote_Name') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def sales_commission(cls): + return Field('Sales_Commission') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def excise_duty(cls): + return Field('Excise_Duty') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def so_number(cls): + return Field('SO_Number') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def purchase_order(cls): + return Field('Purchase_Order') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def pending(cls): + return Field('Pending') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Services__s(object): + + @classmethod + def job_sheet_required(cls): + return Field('Job_Sheet_Required') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def available_days(cls): + return Field('Available_Days') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def unavailable_from(cls): + return Field('Unavailable_From') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def available_dates(cls): + return Field('Available_Dates') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def available_timings(cls): + return Field('Available_Timings') + + @classmethod + def service_name(cls): + return Field('Service_Name') + + @classmethod + def available_from(cls): + return Field('Available_From') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def available_till(cls): + return Field('Available_Till') + + @classmethod + def duration(cls): + return Field('Duration') + + @classmethod + def job_sheet_section__s(cls): + return Field('Job_Sheet_Section__s') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def price(cls): + return Field('Price') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def availability_type(cls): + return Field('Availability_Type') + + @classmethod + def members(cls): + return Field('Members') + + @classmethod + def location(cls): + return Field('Location') + + @classmethod + def unavailable_till(cls): + return Field('Unavailable_Till') + + + + + class Contacts(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def visitor_score(cls): + return Field('Visitor_Score') + + @classmethod + def other_phone(cls): + return Field('Other_Phone') + + @classmethod + def mailing_state(cls): + return Field('Mailing_State') + + @classmethod + def other_state(cls): + return Field('Other_State') + + @classmethod + def other_country(cls): + return Field('Other_Country') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def department(cls): + return Field('Department') + + @classmethod + def unsubscribed_mode(cls): + return Field('Unsubscribed_Mode') + + @classmethod + def assistant(cls): + return Field('Assistant') + + @classmethod + def mailing_country(cls): + return Field('Mailing_Country') + + @classmethod + def data_processing_basis_details(cls): + return Field('Data_Processing_Basis_Details') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def data_source(cls): + return Field('Data_Source') + + @classmethod + def reporting_to(cls): + return Field('Reporting_To') + + @classmethod + def enrich_status__s(cls): + return Field('Enrich_Status__s') + + @classmethod + def first_visited_url(cls): + return Field('First_Visited_URL') + + @classmethod + def days_visited(cls): + return Field('Days_Visited') + + @classmethod + def other_city(cls): + return Field('Other_City') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def data_processing_basis(cls): + return Field('Data_Processing_Basis') + + @classmethod + def home_phone(cls): + return Field('Home_Phone') + + @classmethod + def last_visited_time(cls): + return Field('Last_Visited_Time') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def secondary_email(cls): + return Field('Secondary_Email') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def mailing_zip(cls): + return Field('Mailing_Zip') + + @classmethod + def reports_to(cls): + return Field('Reports_To') + + @classmethod + def number_of_chats(cls): + return Field('Number_Of_Chats') + + @classmethod + def twitter(cls): + return Field('Twitter') + + @classmethod + def other_zip(cls): + return Field('Other_Zip') + + @classmethod + def mailing_street(cls): + return Field('Mailing_Street') + + @classmethod + def average_time_spent_minutes(cls): + return Field('Average_Time_Spent_Minutes') + + @classmethod + def salutation(cls): + return Field('Salutation') + + @classmethod + def first_name(cls): + return Field('First_Name') + + @classmethod + def full_name(cls): + return Field('Full_Name') + + @classmethod + def asst_phone(cls): + return Field('Asst_Phone') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def skype_id(cls): + return Field('Skype_ID') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def email_opt_out(cls): + return Field('Email_Opt_Out') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def date_of_birth(cls): + return Field('Date_of_Birth') + + @classmethod + def mailing_city(cls): + return Field('Mailing_City') + + @classmethod + def unsubscribed_time(cls): + return Field('Unsubscribed_Time') + + @classmethod + def title(cls): + return Field('Title') + + @classmethod + def other_street(cls): + return Field('Other_Street') + + @classmethod + def mobile(cls): + return Field('Mobile') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def territories(cls): + return Field('Territories') + + @classmethod + def first_visited_time(cls): + return Field('First_Visited_Time') + + @classmethod + def last_name(cls): + return Field('Last_Name') + + @classmethod + def referrer(cls): + return Field('Referrer') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def lead_source(cls): + return Field('Lead_Source') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def fax(cls): + return Field('Fax') + + @classmethod + def last_enriched_time__s(cls): + return Field('Last_Enriched_Time__s') + + + + + class Solutions(object): + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def comments(cls): + return Field('Comments') + + @classmethod + def no_of_comments(cls): + return Field('No_of_comments') + + @classmethod + def product_name(cls): + return Field('Product_Name') + + @classmethod + def add_comment(cls): + return Field('Add_Comment') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def solution_number(cls): + return Field('Solution_Number') + + @classmethod + def answer(cls): + return Field('Answer') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def solution_title(cls): + return Field('Solution_Title') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def published(cls): + return Field('Published') + + @classmethod + def question(cls): + return Field('Question') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + + + + class Events(object): + + @classmethod + def all_day(cls): + return Field('All_day') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def check_in_state(cls): + return Field('Check_In_State') + + @classmethod + def check_in_address(cls): + return Field('Check_In_Address') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def remind_participants(cls): + return Field('Remind_Participants') + + @classmethod + def start_datetime(cls): + return Field('Start_DateTime') + + @classmethod + def latitude(cls): + return Field('Latitude') + + @classmethod + def participants(cls): + return Field('Participants') + + @classmethod + def event_title(cls): + return Field('Event_Title') + + @classmethod + def end_datetime(cls): + return Field('End_DateTime') + + @classmethod + def check_in_by(cls): + return Field('Check_In_By') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def check_in_city(cls): + return Field('Check_In_City') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def check_in_comment(cls): + return Field('Check_In_Comment') + + @classmethod + def remind_at(cls): + return Field('Remind_At') + + @classmethod + def who_id(cls): + return Field('Who_Id') + + @classmethod + def check_in_status(cls): + return Field('Check_In_Status') + + @classmethod + def check_in_country(cls): + return Field('Check_In_Country') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def venue(cls): + return Field('Venue') + + @classmethod + def zip_code(cls): + return Field('ZIP_Code') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def longitude(cls): + return Field('Longitude') + + @classmethod + def check_in_time(cls): + return Field('Check_In_Time') + + @classmethod + def recurring_activity(cls): + return Field('Recurring_Activity') + + @classmethod + def what_id(cls): + return Field('What_Id') + + @classmethod + def check_in_sub_locality(cls): + return Field('Check_In_Sub_Locality') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + + + + class Purchase_Orders(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def po_date(cls): + return Field('PO_Date') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def purchase_items(cls): + return Field('Purchase_Items') + + @classmethod + def carrier(cls): + return Field('Carrier') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def sales_commission(cls): + return Field('Sales_Commission') + + @classmethod + def grand_total(cls): + return Field('Grand_Total') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def po_number(cls): + return Field('PO_Number') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def tracking_number(cls): + return Field('Tracking_Number') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def excise_duty(cls): + return Field('Excise_Duty') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def requisition_no(cls): + return Field('Requisition_No') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Accounts(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def ownership(cls): + return Field('Ownership') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def account_type(cls): + return Field('Account_Type') + + @classmethod + def rating(cls): + return Field('Rating') + + @classmethod + def sic_code(cls): + return Field('SIC_Code') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def website(cls): + return Field('Website') + + @classmethod + def employees(cls): + return Field('Employees') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def industry(cls): + return Field('Industry') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def account_site(cls): + return Field('Account_Site') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def account_number(cls): + return Field('Account_Number') + + @classmethod + def ticker_symbol(cls): + return Field('Ticker_Symbol') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def enrich_status__s(cls): + return Field('Enrich_Status__s') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def territories(cls): + return Field('Territories') + + @classmethod + def parent_account(cls): + return Field('Parent_Account') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def fax(cls): + return Field('Fax') + + @classmethod + def annual_revenue(cls): + return Field('Annual_Revenue') + + @classmethod + def last_enriched_time__s(cls): + return Field('Last_Enriched_Time__s') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Cases(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def internal_comments(cls): + return Field('Internal_Comments') + + @classmethod + def no_of_comments(cls): + return Field('No_of_comments') + + @classmethod + def reported_by(cls): + return Field('Reported_By') + + @classmethod + def case_number(cls): + return Field('Case_Number') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def solution(cls): + return Field('Solution') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def priority(cls): + return Field('Priority') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def comments(cls): + return Field('Comments') + + @classmethod + def product_name(cls): + return Field('Product_Name') + + @classmethod + def add_comment(cls): + return Field('Add_Comment') + + @classmethod + def case_origin(cls): + return Field('Case_Origin') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def case_reason(cls): + return Field('Case_Reason') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def type(cls): + return Field('Type') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def related_to(cls): + return Field('Related_To') + + + + + class Notes(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def parent_id(cls): + return Field('Parent_Id') + + @classmethod + def associated_id__s(cls): + return Field('Associated_Id__s') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def note_title(cls): + return Field('Note_Title') + + @classmethod + def note_content(cls): + return Field('Note_Content') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_body_wrapper.py new file mode 100644 index 0000000..30c2b86 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record.download_handler import DownloadHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + from .download_handler import DownloadHandler + + +class FileBodyWrapper(ResponseHandler, DownloadHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_details.py new file mode 100644 index 0000000..52dc096 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_details.py @@ -0,0 +1,318 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FileDetails(object): + def __init__(self): + """Creates an instance of FileDetails""" + + self.__created_time__s = None + self.__file_name__s = None + self.__modified_time__s = None + self.__created_by__s = None + self.__size__s = None + self.__id = None + self.__owner__s = None + self.__modified_by__s = None + self.__file_id__s = None + self.__delete = None + self.__key_modified = dict() + + def get_created_time__s(self): + """ + The method to get the created_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time__s + + def set_created_time__s(self, created_time__s): + """ + The method to set the value to created_time__s + + Parameters: + created_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time__s is not None and not isinstance(created_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time__s EXPECTED TYPE: datetime', None, None) + + self.__created_time__s = created_time__s + self.__key_modified['Created_Time__s'] = 1 + + def get_file_name__s(self): + """ + The method to get the file_name__s + + Returns: + string: A string representing the file_name__s + """ + + return self.__file_name__s + + def set_file_name__s(self, file_name__s): + """ + The method to set the value to file_name__s + + Parameters: + file_name__s (string) : A string representing the file_name__s + """ + + if file_name__s is not None and not isinstance(file_name__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name__s EXPECTED TYPE: str', None, None) + + self.__file_name__s = file_name__s + self.__key_modified['File_Name__s'] = 1 + + def get_modified_time__s(self): + """ + The method to get the modified_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time__s + + def set_modified_time__s(self, modified_time__s): + """ + The method to set the value to modified_time__s + + Parameters: + modified_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if modified_time__s is not None and not isinstance(modified_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time__s EXPECTED TYPE: datetime', None, None) + + self.__modified_time__s = modified_time__s + self.__key_modified['Modified_Time__s'] = 1 + + def get_created_by__s(self): + """ + The method to get the created_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by__s + + def set_created_by__s(self, created_by__s): + """ + The method to set the value to created_by__s + + Parameters: + created_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by__s is not None and not isinstance(created_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by__s = created_by__s + self.__key_modified['Created_By__s'] = 1 + + def get_size__s(self): + """ + The method to get the size__s + + Returns: + string: A string representing the size__s + """ + + return self.__size__s + + def set_size__s(self, size__s): + """ + The method to set the value to size__s + + Parameters: + size__s (string) : A string representing the size__s + """ + + if size__s is not None and not isinstance(size__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size__s EXPECTED TYPE: str', None, None) + + self.__size__s = size__s + self.__key_modified['Size__s'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_owner__s(self): + """ + The method to get the owner__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner__s + + def set_owner__s(self, owner__s): + """ + The method to set the value to owner__s + + Parameters: + owner__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner__s is not None and not isinstance(owner__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner__s = owner__s + self.__key_modified['Owner__s'] = 1 + + def get_modified_by__s(self): + """ + The method to get the modified_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by__s + + def set_modified_by__s(self, modified_by__s): + """ + The method to set the value to modified_by__s + + Parameters: + modified_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by__s is not None and not isinstance(modified_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by__s = modified_by__s + self.__key_modified['Modified_By__s'] = 1 + + def get_file_id__s(self): + """ + The method to get the file_id__s + + Returns: + string: A string representing the file_id__s + """ + + return self.__file_id__s + + def set_file_id__s(self, file_id__s): + """ + The method to set the value to file_id__s + + Parameters: + file_id__s (string) : A string representing the file_id__s + """ + + if file_id__s is not None and not isinstance(file_id__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id__s EXPECTED TYPE: str', None, None) + + self.__file_id__s = file_id__s + self.__key_modified['File_Id__s'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + string: A string representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (string) : A string representing the delete + """ + + if delete is not None and not isinstance(delete, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: str', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_handler.py new file mode 100644 index 0000000..2f9df9c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/file_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class FileHandler(ABC): + def __init__(self): + """Creates an instance of FileHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/image_upload.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/image_upload.py new file mode 100644 index 0000000..8d9af0f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/image_upload.py @@ -0,0 +1,418 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ImageUpload(object): + def __init__(self): + """Creates an instance of ImageUpload""" + + self.__preview_id__s = None + self.__file_name__s = None + self.__description__s = None + self.__size__s = None + self.__id = None + self.__sequence_number__s = None + self.__state__s = None + self.__file_id__s = None + self.__delete = None + self.__created_time__s = None + self.__modified_time__s = None + self.__created_by__s = None + self.__owner__s = None + self.__modified_by__s = None + self.__key_modified = dict() + + def get_preview_id__s(self): + """ + The method to get the preview_id__s + + Returns: + string: A string representing the preview_id__s + """ + + return self.__preview_id__s + + def set_preview_id__s(self, preview_id__s): + """ + The method to set the value to preview_id__s + + Parameters: + preview_id__s (string) : A string representing the preview_id__s + """ + + if preview_id__s is not None and not isinstance(preview_id__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preview_id__s EXPECTED TYPE: str', None, None) + + self.__preview_id__s = preview_id__s + self.__key_modified['Preview_Id__s'] = 1 + + def get_file_name__s(self): + """ + The method to get the file_name__s + + Returns: + string: A string representing the file_name__s + """ + + return self.__file_name__s + + def set_file_name__s(self, file_name__s): + """ + The method to set the value to file_name__s + + Parameters: + file_name__s (string) : A string representing the file_name__s + """ + + if file_name__s is not None and not isinstance(file_name__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name__s EXPECTED TYPE: str', None, None) + + self.__file_name__s = file_name__s + self.__key_modified['File_Name__s'] = 1 + + def get_description__s(self): + """ + The method to get the description__s + + Returns: + string: A string representing the description__s + """ + + return self.__description__s + + def set_description__s(self, description__s): + """ + The method to set the value to description__s + + Parameters: + description__s (string) : A string representing the description__s + """ + + if description__s is not None and not isinstance(description__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: description__s EXPECTED TYPE: str', None, None) + + self.__description__s = description__s + self.__key_modified['Description__s'] = 1 + + def get_size__s(self): + """ + The method to get the size__s + + Returns: + string: A string representing the size__s + """ + + return self.__size__s + + def set_size__s(self, size__s): + """ + The method to set the value to size__s + + Parameters: + size__s (string) : A string representing the size__s + """ + + if size__s is not None and not isinstance(size__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size__s EXPECTED TYPE: str', None, None) + + self.__size__s = size__s + self.__key_modified['Size__s'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number__s(self): + """ + The method to get the sequence_number__s + + Returns: + int: An int representing the sequence_number__s + """ + + return self.__sequence_number__s + + def set_sequence_number__s(self, sequence_number__s): + """ + The method to set the value to sequence_number__s + + Parameters: + sequence_number__s (int) : An int representing the sequence_number__s + """ + + if sequence_number__s is not None and not isinstance(sequence_number__s, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sequence_number__s EXPECTED TYPE: int', None, None) + + self.__sequence_number__s = sequence_number__s + self.__key_modified['Sequence_Number__s'] = 1 + + def get_state__s(self): + """ + The method to get the state__s + + Returns: + string: A string representing the state__s + """ + + return self.__state__s + + def set_state__s(self, state__s): + """ + The method to set the value to state__s + + Parameters: + state__s (string) : A string representing the state__s + """ + + if state__s is not None and not isinstance(state__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state__s EXPECTED TYPE: str', None, None) + + self.__state__s = state__s + self.__key_modified['State__s'] = 1 + + def get_file_id__s(self): + """ + The method to get the file_id__s + + Returns: + string: A string representing the file_id__s + """ + + return self.__file_id__s + + def set_file_id__s(self, file_id__s): + """ + The method to set the value to file_id__s + + Parameters: + file_id__s (string) : A string representing the file_id__s + """ + + if file_id__s is not None and not isinstance(file_id__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id__s EXPECTED TYPE: str', None, None) + + self.__file_id__s = file_id__s + self.__key_modified['File_Id__s'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + string: A string representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (string) : A string representing the delete + """ + + if delete is not None and not isinstance(delete, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: str', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def get_created_time__s(self): + """ + The method to get the created_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time__s + + def set_created_time__s(self, created_time__s): + """ + The method to set the value to created_time__s + + Parameters: + created_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time__s is not None and not isinstance(created_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time__s EXPECTED TYPE: datetime', None, None) + + self.__created_time__s = created_time__s + self.__key_modified['Created_Time__s'] = 1 + + def get_modified_time__s(self): + """ + The method to get the modified_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time__s + + def set_modified_time__s(self, modified_time__s): + """ + The method to set the value to modified_time__s + + Parameters: + modified_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if modified_time__s is not None and not isinstance(modified_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time__s EXPECTED TYPE: datetime', None, None) + + self.__modified_time__s = modified_time__s + self.__key_modified['Modified_Time__s'] = 1 + + def get_created_by__s(self): + """ + The method to get the created_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by__s + + def set_created_by__s(self, created_by__s): + """ + The method to set the value to created_by__s + + Parameters: + created_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by__s is not None and not isinstance(created_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by__s = created_by__s + self.__key_modified['Created_By__s'] = 1 + + def get_owner__s(self): + """ + The method to get the owner__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner__s + + def set_owner__s(self, owner__s): + """ + The method to set the value to owner__s + + Parameters: + owner__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner__s is not None and not isinstance(owner__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner__s = owner__s + self.__key_modified['Owner__s'] = 1 + + def get_modified_by__s(self): + """ + The method to get the modified_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by__s + + def set_modified_by__s(self, modified_by__s): + """ + The method to set the value to modified_by__s + + Parameters: + modified_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by__s is not None and not isinstance(modified_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by__s = modified_by__s + self.__key_modified['Modified_By__s'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/info.py new file mode 100644 index 0000000..1158d1e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/info.py @@ -0,0 +1,326 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__call = None + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__email = None + self.__more_records = None + self.__sort_by = None + self.__sort_order = None + self.__key_modified = dict() + + def get_call(self): + """ + The method to get the call + + Returns: + bool: A bool representing the call + """ + + return self.__call + + def set_call(self, call): + """ + The method to set the value to call + + Parameters: + call (bool) : A bool representing the call + """ + + if call is not None and not isinstance(call, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call EXPECTED TYPE: bool', None, None) + + self.__call = call + self.__key_modified['call'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + bool: A bool representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (bool) : A bool representing the email + """ + + if email is not None and not isinstance(email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: bool', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/line_item_product.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/line_item_product.py new file mode 100644 index 0000000..6f22b8e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/line_item_product.py @@ -0,0 +1,236 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class LineItemProduct(Record): + def __init__(self): + """Creates an instance of LineItemProduct""" + super().__init__() + + + def get_product_code(self): + """ + The method to get the product_code + + Returns: + string: A string representing the product_code + """ + + return self.get_key_value('Product_Code') + + def set_product_code(self, product_code): + """ + The method to set the value to product_code + + Parameters: + product_code (string) : A string representing the product_code + """ + + if product_code is not None and not isinstance(product_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: product_code EXPECTED TYPE: str', None, None) + + self.add_key_value('Product_Code', product_code) + + def get_currency(self): + """ + The method to get the currency + + Returns: + string: A string representing the currency + """ + + return self.get_key_value('Currency') + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (string) : A string representing the currency + """ + + if currency is not None and not isinstance(currency, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: str', None, None) + + self.add_key_value('Currency', currency) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/line_tax.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/line_tax.py new file mode 100644 index 0000000..48e17d3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/line_tax.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LineTax(object): + def __init__(self): + """Creates an instance of LineTax""" + + self.__percentage = None + self.__name = None + self.__id = None + self.__value = None + self.__display_name = None + self.__key_modified = dict() + + def get_percentage(self): + """ + The method to get the percentage + + Returns: + float: A float representing the percentage + """ + + return self.__percentage + + def set_percentage(self, percentage): + """ + The method to set the value to percentage + + Parameters: + percentage (float) : A float representing the percentage + """ + + if percentage is not None and not isinstance(percentage, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: percentage EXPECTED TYPE: float', None, None) + + self.__percentage = percentage + self.__key_modified['percentage'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + float: A float representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (float) : A float representing the value + """ + + if value is not None and not isinstance(value, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: float', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def get_display_name(self): + """ + The method to get the display_name + + Returns: + string: A string representing the display_name + """ + + return self.__display_name + + def set_display_name(self, display_name): + """ + The method to set the value to display_name + + Parameters: + display_name (string) : A string representing the display_name + """ + + if display_name is not None and not isinstance(display_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_name EXPECTED TYPE: str', None, None) + + self.__display_name = display_name + self.__key_modified['display_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update.py new file mode 100644 index 0000000..0b8a08b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update.py @@ -0,0 +1,177 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response import MassUpdateResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .mass_update_response import MassUpdateResponse + + +class MassUpdate(MassUpdateResponse): + def __init__(self): + """Creates an instance of MassUpdate""" + super().__init__() + + self.__status = None + self.__failed_count = None + self.__updated_count = None + self.__not_updated_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_updated_count(self): + """ + The method to get the updated_count + + Returns: + int: An int representing the updated_count + """ + + return self.__updated_count + + def set_updated_count(self, updated_count): + """ + The method to set the value to updated_count + + Parameters: + updated_count (int) : An int representing the updated_count + """ + + if updated_count is not None and not isinstance(updated_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updated_count EXPECTED TYPE: int', None, None) + + self.__updated_count = updated_count + self.__key_modified['Updated_Count'] = 1 + + def get_not_updated_count(self): + """ + The method to get the not_updated_count + + Returns: + int: An int representing the not_updated_count + """ + + return self.__not_updated_count + + 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 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_handler.py new file mode 100644 index 0000000..4d9126f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateActionHandler(ABC): + def __init__(self): + """Creates an instance of MassUpdateActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_response.py new file mode 100644 index 0000000..fc67129 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateActionResponse(ABC): + def __init__(self): + """Creates an instance of MassUpdateActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_wrapper.py new file mode 100644 index 0000000..5107719 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_handler import MassUpdateActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .mass_update_action_handler import MassUpdateActionHandler + + +class MassUpdateActionWrapper(MassUpdateActionHandler): + def __init__(self): + """Creates an instance of MassUpdateActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_body_wrapper.py new file mode 100644 index 0000000..41c0c8b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_body_wrapper.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MassUpdateBodyWrapper(object): + def __init__(self): + """Creates an instance of MassUpdateBodyWrapper""" + + self.__data = None + self.__cvid = None + self.__ids = None + self.__territory = None + self.__over_write = None + self.__criteria = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + string: A string representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (string) : A string representing the cvid + """ + + if cvid is not None and not isinstance(cvid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: str', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + MassUpdateTerritory: An instance of MassUpdateTerritory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (MassUpdateTerritory) : An instance of MassUpdateTerritory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_territory import MassUpdateTerritory + except Exception: + from .mass_update_territory import MassUpdateTerritory + + if territory is not None and not isinstance(territory, MassUpdateTerritory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: MassUpdateTerritory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def get_over_write(self): + """ + The method to get the over_write + + Returns: + bool: A bool representing the over_write + """ + + return self.__over_write + + def set_over_write(self, over_write): + """ + The method to set the value to over_write + + Parameters: + over_write (bool) : A bool representing the over_write + """ + + if over_write is not None and not isinstance(over_write, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: over_write EXPECTED TYPE: bool', None, None) + + self.__over_write = over_write + self.__key_modified['over_write'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + list: An instance of list + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (list) : An instance of list + """ + + if criteria is not None and not isinstance(criteria, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: list', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response.py new file mode 100644 index 0000000..ae0fcbd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateResponse(ABC): + def __init__(self): + """Creates an instance of MassUpdateResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_handler.py new file mode 100644 index 0000000..881be87 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateResponseHandler(ABC): + def __init__(self): + """Creates an instance of MassUpdateResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_wrapper.py new file mode 100644 index 0000000..6fec7e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response_handler import MassUpdateResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .mass_update_response_handler import MassUpdateResponseHandler + + +class MassUpdateResponseWrapper(MassUpdateResponseHandler): + def __init__(self): + """Creates an instance of MassUpdateResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_success_response.py new file mode 100644 index 0000000..a683600 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_response import MassUpdateActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .mass_update_action_response import MassUpdateActionResponse + + +class MassUpdateSuccessResponse(MassUpdateActionResponse): + def __init__(self): + """Creates an instance of MassUpdateSuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_territory.py new file mode 100644 index 0000000..f32e3a2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_territory.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MassUpdateTerritory(object): + def __init__(self): + """Creates an instance of MassUpdateTerritory""" + + self.__id = None + self.__include_child = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_include_child(self): + """ + The method to get the include_child + + Returns: + bool: A bool representing the include_child + """ + + return self.__include_child + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_lookup.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_lookup.py new file mode 100644 index 0000000..a326778 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_lookup.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiSelectLookup(object): + def __init__(self): + """Creates an instance of MultiSelectLookup""" + + self.__id = None + self.__fieldname = None + self.__has_more = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_fieldname(self): + """ + The method to get the fieldname + + Returns: + dict: An instance of dict + """ + + return self.__fieldname + + def set_fieldname(self, fieldname): + """ + The method to set the value to fieldname + + Parameters: + fieldname (dict) : An instance of dict + """ + + if fieldname is not None and not isinstance(fieldname, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fieldname EXPECTED TYPE: dict', None, None) + + self.__fieldname = fieldname + self.__key_modified['fieldName'] = 1 + + def get_has_more(self): + """ + The method to get the has_more + + Returns: + dict: An instance of dict + """ + + return self.__has_more + + def set_has_more(self, has_more): + """ + The method to set the value to has_more + + Parameters: + has_more (dict) : An instance of dict + """ + + if has_more is not None and not isinstance(has_more, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_more EXPECTED TYPE: dict', None, None) + + self.__has_more = has_more + self.__key_modified['$has_more'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_picklist.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_picklist.py new file mode 100644 index 0000000..95e01b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_picklist.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiSelectPicklist(object): + def __init__(self): + """Creates an instance of MultiSelectPicklist""" + + self.__id = None + self.__fieldname = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_fieldname(self): + """ + The method to get the fieldname + + Returns: + dict: An instance of dict + """ + + return self.__fieldname + + def set_fieldname(self, fieldname): + """ + The method to set the value to fieldname + + Parameters: + fieldname (dict) : An instance of dict + """ + + if fieldname is not None and not isinstance(fieldname, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fieldname EXPECTED TYPE: dict', None, None) + + self.__fieldname = fieldname + self.__key_modified['fieldName'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/options.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/options.py new file mode 100644 index 0000000..d09d8b2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/options.py @@ -0,0 +1,87 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Options(object): + def __init__(self): + """Creates an instance of Options""" + pass + + + + class RecordLockLockSourceS(object): + + @classmethod + def manual(cls): + return Choice('Manual') + + @classmethod + def automatic(cls): + return Choice('Automatic') + + + + + class UsersTimeFormat(object): + + @classmethod + def hhmm(cls): + return Choice('HH:mm') + + @classmethod + def hhmma(cls): + return Choice('hh:mm a') + + + + + class UsersDateFormat(object): + + @classmethod + def mmmdyyyy(cls): + return Choice('MMM d, yyyy') + + + + + class UsersDecimalSeparator(object): + + @classmethod + def comma(cls): + return Choice('Comma') + + @classmethod + def period(cls): + return Choice('Period') + + + + + class UsersNumberSeparator(object): + + @classmethod + def space(cls): + return Choice('Space') + + + + + class UsersNameFormatS(object): + + @classmethod + def salutationfirstnamelastname(cls): + return Choice('Salutation,First Name,Last Name') + + @classmethod + def saluationlastnamefirstname(cls): + return Choice('Saluation,Last Name,First Name') + + @classmethod + def firstnamelastnamesaluation(cls): + return Choice('First Name,Last Name,Saluation') + + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/participants.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/participants.py new file mode 100644 index 0000000..8d7b1bb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/participants.py @@ -0,0 +1,305 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class Participants(Record): + def __init__(self): + """Creates an instance of Participants""" + super().__init__() + + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.get_key_value('Email') + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.add_key_value('Email', email) + + def get_invited(self): + """ + The method to get the invited + + Returns: + bool: A bool representing the invited + """ + + return self.get_key_value('invited') + + def set_invited(self, invited): + """ + The method to set the value to invited + + Parameters: + invited (bool) : A bool representing the invited + """ + + if invited is not None and not isinstance(invited, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: invited EXPECTED TYPE: bool', None, None) + + self.add_key_value('invited', invited) + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.get_key_value('type') + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.add_key_value('type', type) + + def get_participant(self): + """ + The method to get the participant + + Returns: + string: A string representing the participant + """ + + return self.get_key_value('participant') + + def set_participant(self, participant): + """ + The method to set the value to participant + + Parameters: + participant (string) : A string representing the participant + """ + + if participant is not None and not isinstance(participant, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: participant EXPECTED TYPE: str', None, None) + + self.add_key_value('participant', participant) + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.get_key_value('status') + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.add_key_value('status', status) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/price_book.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/price_book.py new file mode 100644 index 0000000..9a7d579 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/price_book.py @@ -0,0 +1,190 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class PriceBook(Record): + def __init__(self): + """Creates an instance of PriceBook""" + super().__init__() + + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/pricing_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/pricing_details.py new file mode 100644 index 0000000..2d01619 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/pricing_details.py @@ -0,0 +1,259 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class PricingDetails(Record): + def __init__(self): + """Creates an instance of PricingDetails""" + super().__init__() + + + def get_to_range(self): + """ + The method to get the to_range + + Returns: + float: A float representing the to_range + """ + + return self.get_key_value('to_range') + + def set_to_range(self, to_range): + """ + The method to set the value to to_range + + Parameters: + to_range (float) : A float representing the to_range + """ + + if to_range is not None and not isinstance(to_range, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to_range EXPECTED TYPE: float', None, None) + + self.add_key_value('to_range', to_range) + + def get_discount(self): + """ + The method to get the discount + + Returns: + float: A float representing the discount + """ + + return self.get_key_value('discount') + + def set_discount(self, discount): + """ + The method to set the value to discount + + Parameters: + discount (float) : A float representing the discount + """ + + if discount is not None and not isinstance(discount, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: discount EXPECTED TYPE: float', None, None) + + self.add_key_value('discount', discount) + + def get_from_range(self): + """ + The method to get the from_range + + Returns: + float: A float representing the from_range + """ + + return self.get_key_value('from_range') + + def set_from_range(self, from_range): + """ + The method to set the value to from_range + + Parameters: + from_range (float) : A float representing the from_range + """ + + if from_range is not None and not isinstance(from_range, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_range EXPECTED TYPE: float', None, None) + + self.add_key_value('from_range', from_range) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/record.py new file mode 100644 index 0000000..8a65b5d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/record.py @@ -0,0 +1,288 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__key_values = dict() + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def add_field_value(self, field, value): + """ + The method to add field value + + Parameters: + field (Field) : An instance of Field + value (object) : An object + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.add_key_value(field.get_api_name(), value) + + def add_key_value(self, api_name, value): + """ + The method to add key value + + Parameters: + api_name (string) : A string representing the api_name + value (Object) : A Object representing the value + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__key_values[api_name] = value + self.__key_modified[api_name] = 1 + + def get_key_value(self, api_name): + """ + The method to get key value + + Parameters: + api_name (string) : A string representing the api_name + + Returns: + Object: A Object representing the key_value + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + if api_name in self.__key_values: + return self.__key_values.get(api_name) + + return None + + def get_key_values(self): + """ + The method to get key values + + Returns: + dict: An instance of dict + """ + + return self.__key_values + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/record_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/record_operations.py new file mode 100644 index 0000000..e563cb5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/record_operations.py @@ -0,0 +1,1290 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + from ..header import Header + + +class RecordOperations(object): + def __init__(self, module_api_name): + """ + Creates an instance of RecordOperations with the given parameters + + Parameters: + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__module_api_name = module_api_name + + + def get_record(self, id, param_instance=None, header_instance=None): + """ + The method to get record + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_record(self, id, request, header_instance=None): + """ + The method to update record + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_record(self, id, param_instance=None, header_instance=None): + """ + The method to delete record + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_records(self, param_instance=None, header_instance=None): + """ + The method to get records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_records(self, request, header_instance=None): + """ + The method to create records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + 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_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_records(self, request, header_instance=None): + """ + The method to update records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + 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.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_records(self, param_instance=None, header_instance=None): + """ + The method to delete records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def upsert_records(self, request, header_instance=None): + """ + The method to upsert records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/upsert' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_deleted_records(self, param_instance=None, header_instance=None): + """ + The method to get deleted records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/deleted' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.deleted_records_handler import DeletedRecordsHandler + except Exception: + from .deleted_records_handler import DeletedRecordsHandler + return handler_instance.api_call(DeletedRecordsHandler.__module__, 'application/json') + + def search_records(self, param_instance=None, header_instance=None): + """ + The method to search records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/search' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_photo(self, id): + """ + The method to get photo + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/photo' + 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) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.download_handler import DownloadHandler + except Exception: + from .download_handler import DownloadHandler + return handler_instance.api_call(DownloadHandler.__module__, 'application/x-download') + + def upload_photo(self, id, request, param_instance=None): + """ + The method to upload photo + + Parameters: + id (int) : An int representing the id + request (FileBodyWrapper) : An instance of FileBodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/photo' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + Utility.verify_photo_support(self.__module_api_name) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler + except Exception: + from .file_handler import FileHandler + return handler_instance.api_call(FileHandler.__module__, 'application/json') + + def delete_photo(self, id): + """ + The method to delete photo + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/photo' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler + except Exception: + from .file_handler import FileHandler + return handler_instance.api_call(FileHandler.__module__, 'application/json') + + def mass_update_records(self, request): + """ + The method to mass update records + + Parameters: + request (MassUpdateBodyWrapper) : An instance of MassUpdateBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_body_wrapper import MassUpdateBodyWrapper + except Exception: + from .mass_update_body_wrapper import MassUpdateBodyWrapper + + if request is not None and not isinstance(request, MassUpdateBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MassUpdateBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/mass_update' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_handler import MassUpdateActionHandler + except Exception: + from .mass_update_action_handler import MassUpdateActionHandler + return handler_instance.api_call(MassUpdateActionHandler.__module__, 'application/json') + + def get_mass_update_status(self, param_instance=None): + """ + The method to get mass update status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/mass_update' + 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.set_param(param_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response_handler import MassUpdateResponseHandler + except Exception: + from .mass_update_response_handler import MassUpdateResponseHandler + return handler_instance.api_call(MassUpdateResponseHandler.__module__, 'application/json') + + def assign_territories_to_multiple_records(self, request): + """ + The method to assign territories to multiple records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/assign_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def assign_territory_to_record(self, id, request): + """ + The method to assign territory to record + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/assign_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def remove_territories_from_multiple_records(self, request): + """ + The method to remove territories from multiple records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/remove_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def remove_territories_from_record(self, id, request): + """ + The method to remove territories from record + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/remove_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def record_count(self, param_instance=None): + """ + The method to record count + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/count' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.count_handler import CountHandler + except Exception: + from .count_handler import CountHandler + return handler_instance.api_call(CountHandler.__module__, 'application/json') + + def get_record_using_external_id(self, external_field_value, param_instance=None, header_instance=None): + """ + The method to get record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_record_using_external_id(self, external_field_value, request, header_instance=None): + """ + The method to update record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_record_using_external_id(self, external_field_value, param_instance=None, header_instance=None): + """ + The method to delete record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def clone_record(self, id): + """ + The method to clone record + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/clone' + 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_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +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') + on_demand_properties = Param('on_demand_properties', 'com.zoho.crm.api.Record.GetRecordParam') + + +class GetRecordHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordHeader') + + +class UpdateRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordHeader') + + +class DeleteRecordParam(object): + wf_trigger = Param('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordParam') + + +class DeleteRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordHeader') + + +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') + page_token = Param('page_token', 'com.zoho.crm.api.Record.GetRecordsParam') + + +class GetRecordsHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordsHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordsHeader') + + +class CreateRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.CreateRecordsHeader') + + +class UpdateRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordsHeader') + + +class DeleteRecordsParam(object): + ids = Param('ids', 'com.zoho.crm.api.Record.DeleteRecordsParam') + wf_trigger = Param('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordsParam') + + +class DeleteRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordsHeader') + + +class UpsertRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpsertRecordsHeader') + + +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 GetDeletedRecordsHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetDeletedRecordsHeader') + + +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') + fields = Param('fields', 'com.zoho.crm.api.Record.SearchRecordsParam') + cvid = Param('cvid', 'com.zoho.crm.api.Record.SearchRecordsParam') + + +class SearchRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.SearchRecordsHeader') + + +class UploadPhotoParam(object): + restrict_triggers = Param('restrict_triggers', 'com.zoho.crm.api.Record.UploadPhotoParam') + + +class GetMassUpdateStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.Record.GetMassUpdateStatusParam') + + +class RecordCountParam(object): + criteria = Param('criteria', 'com.zoho.crm.api.Record.RecordCountParam') + email = Param('email', 'com.zoho.crm.api.Record.RecordCountParam') + phone = Param('phone', 'com.zoho.crm.api.Record.RecordCountParam') + word = Param('word', 'com.zoho.crm.api.Record.RecordCountParam') + + +class GetRecordUsingExternalIDParam(object): + approved = Param('approved', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + converted = Param('converted', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + cvid = Param('cvid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + uid = Param('uid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + fields = Param('fields', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + startdatetime = Param('startDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + enddatetime = Param('endDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + territory_id = Param('territory_id', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + include_child = Param('include_child', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + + +class GetRecordUsingExternalIDHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader') + + +class UpdateRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordUsingExternalIDHeader') + + +class DeleteRecordUsingExternalIDParam(object): + wf_trigger = Param('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDParam') + + +class DeleteRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDHeader') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/recurring_activity.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/recurring_activity.py new file mode 100644 index 0000000..1c927f6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/recurring_activity.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RecurringActivity(object): + def __init__(self): + """Creates an instance of RecurringActivity""" + + self.__rrule = None + self.__exdate = None + self.__key_modified = dict() + + def get_rrule(self): + """ + The method to get the rrule + + Returns: + string: A string representing the rrule + """ + + return self.__rrule + + def set_rrule(self, rrule): + """ + The method to set the value to rrule + + Parameters: + rrule (string) : A string representing the rrule + """ + + if rrule is not None and not isinstance(rrule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rrule EXPECTED TYPE: str', None, None) + + self.__rrule = rrule + self.__key_modified['RRULE'] = 1 + + def get_exdate(self): + """ + The method to get the exdate + + Returns: + string: A string representing the exdate + """ + + return self.__exdate + + def set_exdate(self, exdate): + """ + The method to set the value to exdate + + Parameters: + exdate (string) : A string representing the exdate + """ + + if exdate is not None and not isinstance(exdate, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exdate EXPECTED TYPE: str', None, None) + + self.__exdate = exdate + self.__key_modified['EXDATE'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/remind_at.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/remind_at.py new file mode 100644 index 0000000..75290e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/remind_at.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RemindAt(object): + def __init__(self): + """Creates an instance of RemindAt""" + + self.__alarm = None + self.__key_modified = dict() + + def get_alarm(self): + """ + The method to get the alarm + + Returns: + string: A string representing the alarm + """ + + return self.__alarm + + def set_alarm(self, alarm): + """ + The method to set the value to alarm + + Parameters: + alarm (string) : A string representing the alarm + """ + + if alarm is not None and not isinstance(alarm, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alarm EXPECTED TYPE: str', None, None) + + self.__alarm = alarm + self.__key_modified['ALARM'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/reminder.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/reminder.py new file mode 100644 index 0000000..f6bba1c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/reminder.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Reminder(object): + def __init__(self): + """Creates an instance of Reminder""" + + self.__period = None + self.__unit = None + self.__time = None + self.__key_modified = dict() + + def get_period(self): + """ + The method to get the period + + Returns: + string: A string representing the period + """ + + return self.__period + + def set_period(self, period): + """ + The method to set the value to period + + Parameters: + period (string) : A string representing the period + """ + + if period is not None and not isinstance(period, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: period EXPECTED TYPE: str', None, None) + + self.__period = period + self.__key_modified['period'] = 1 + + def get_unit(self): + """ + The method to get the unit + + Returns: + int: An int representing the unit + """ + + return self.__unit + + def set_unit(self, unit): + """ + The method to set the value to unit + + Parameters: + unit (int) : An int representing the unit + """ + + if unit is not None and not isinstance(unit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unit EXPECTED TYPE: int', None, None) + + self.__unit = unit + self.__key_modified['unit'] = 1 + + def get_time(self): + """ + The method to get the time + + Returns: + string: A string representing the time + """ + + return self.__time + + def set_time(self, time): + """ + The method to set the value to time + + Parameters: + time (string) : A string representing the time + """ + + if time is not None and not isinstance(time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time EXPECTED TYPE: str', None, None) + + self.__time = time + self.__key_modified['time'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/response_wrapper.py new file mode 100644 index 0000000..9ec8d19 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/success_response.py new file mode 100644 index 0000000..5877fa7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/success_response.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .file_handler import FileHandler + + +class SuccessResponse(ActionResponse, FileHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__duplicate_field = None + self.__action = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_duplicate_field(self): + """ + The method to get the duplicate_field + + Returns: + string: A string representing the duplicate_field + """ + + return self.__duplicate_field + + def set_duplicate_field(self, duplicate_field): + """ + The method to set the value to duplicate_field + + Parameters: + duplicate_field (string) : A string representing the duplicate_field + """ + + if duplicate_field is not None and not isinstance(duplicate_field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_field EXPECTED TYPE: str', None, None) + + self.__duplicate_field = duplicate_field + self.__key_modified['duplicate_field'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + Choice: An instance of Choice + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (Choice) : An instance of Choice + """ + + if action is not None and not isinstance(action, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: Choice', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/tax.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/tax.py new file mode 100644 index 0000000..01b384f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/tax.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tax(object): + def __init__(self): + """Creates an instance of Tax""" + + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/territory.py new file mode 100644 index 0000000..dc0aa0a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/territory.py @@ -0,0 +1,181 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__assigned = None + self.__name = None + self.__id = None + self.__assigned_time = None + self.__assigned_by = None + self.__key_modified = dict() + + def get_assigned(self): + """ + The method to get the assigned + + Returns: + string: A string representing the assigned + """ + + return self.__assigned + + def set_assigned(self, assigned): + """ + The method to set the value to assigned + + Parameters: + assigned (string) : A string representing the assigned + """ + + if assigned is not None and not isinstance(assigned, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assigned EXPECTED TYPE: str', None, None) + + self.__assigned = assigned + self.__key_modified['$assigned'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_assigned_time(self): + """ + The method to get the assigned_time + + Returns: + datetime: An instance of datetime + """ + + return self.__assigned_time + + def set_assigned_time(self, assigned_time): + """ + The method to set the value to assigned_time + + Parameters: + assigned_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if assigned_time is not None and not isinstance(assigned_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assigned_time EXPECTED TYPE: datetime', None, None) + + self.__assigned_time = assigned_time + self.__key_modified['$assigned_time'] = 1 + + def get_assigned_by(self): + """ + The method to get the assigned_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__assigned_by + + def set_assigned_by(self, assigned_by): + """ + The method to set the value to assigned_by + + Parameters: + assigned_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if assigned_by is not None and not isinstance(assigned_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assigned_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__assigned_by = assigned_by + self.__key_modified['$assigned_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/time_range.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/time_range.py new file mode 100644 index 0000000..1230a55 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/time_range.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TimeRange(object): + def __init__(self): + """Creates an instance of TimeRange""" + + self.__from_1 = None + self.__to = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + string: A string representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (string) : A string representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: str', None, None) + + self.__from_1 = from_1 + self.__key_modified['From'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + string: A string representing the to + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (string) : A string representing the to + """ + + if to is not None and not isinstance(to, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: str', None, None) + + self.__to = to + self.__key_modified['To'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/widget.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/widget.py new file mode 100644 index 0000000..8a3d04b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/widget.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Widget(object): + def __init__(self): + """Creates an instance of Widget""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/wizard.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/wizard.py new file mode 100644 index 0000000..5edbd89 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record/wizard.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wizard(object): + def __init__(self): + """Creates an instance of Wizard""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/__init__.py new file mode 100644 index 0000000..337f82d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/__init__.py @@ -0,0 +1,13 @@ +from .action_wrapper import ActionWrapper +from .record_locking_operations import RecordLockingOperations, GetRecordLockingInformationsParam, GetRecordLockingInformationParam +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .locked_for_s import LockedForS +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .record_lock import RecordLock +from .lock_record import LockRecord +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_wrapper.py new file mode 100644 index 0000000..9189b26 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/api_exception.py new file mode 100644 index 0000000..4939b53 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/info.py new file mode 100644 index 0000000..1158d1e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/info.py @@ -0,0 +1,326 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__call = None + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__email = None + self.__more_records = None + self.__sort_by = None + self.__sort_order = None + self.__key_modified = dict() + + def get_call(self): + """ + The method to get the call + + Returns: + bool: A bool representing the call + """ + + return self.__call + + def set_call(self, call): + """ + The method to set the value to call + + Parameters: + call (bool) : A bool representing the call + """ + + if call is not None and not isinstance(call, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call EXPECTED TYPE: bool', None, None) + + self.__call = call + self.__key_modified['call'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + bool: A bool representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (bool) : A bool representing the email + """ + + if email is not None and not isinstance(email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: bool', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/lock_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/lock_record.py new file mode 100644 index 0000000..27d2437 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/lock_record.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockRecord(object): + def __init__(self): + """Creates an instance of LockRecord""" + + self.__locked_reason__s = None + self.__key_modified = dict() + + def get_locked_reason__s(self): + """ + The method to get the locked_reason__s + + Returns: + string: A string representing the locked_reason__s + """ + + return self.__locked_reason__s + + def set_locked_reason__s(self, locked_reason__s): + """ + The method to set the value to locked_reason__s + + Parameters: + locked_reason__s (string) : A string representing the locked_reason__s + """ + + if locked_reason__s is not None and not isinstance(locked_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_reason__s EXPECTED TYPE: str', None, None) + + self.__locked_reason__s = locked_reason__s + self.__key_modified['Locked_Reason__s'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/locked_for_s.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/locked_for_s.py new file mode 100644 index 0000000..aa16775 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/locked_for_s.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockedForS(object): + def __init__(self): + """Creates an instance of LockedForS""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + dict: An instance of dict + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (dict) : An instance of dict + """ + + if module is not None and not isinstance(module, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: dict', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_lock.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_lock.py new file mode 100644 index 0000000..f5a9831 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_lock.py @@ -0,0 +1,361 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record import Record +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from ..record import Record + + +class RecordLock(Record): + def __init__(self): + """Creates an instance of RecordLock""" + super().__init__() + + + def get_lock_source__s(self): + """ + The method to get the lock_source__s + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('lock_source__s') + + def set_lock_source__s(self, lock_source__s): + """ + The method to set the value to lock_source__s + + Parameters: + lock_source__s (Choice) : An instance of Choice + """ + + if lock_source__s is not None and not isinstance(lock_source__s, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_source__s EXPECTED TYPE: Choice', None, None) + + self.add_key_value('lock_source__s', lock_source__s) + + def get_locked_by__s(self): + """ + The method to get the locked_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('locked_by__s') + + def set_locked_by__s(self, locked_by__s): + """ + The method to set the value to locked_by__s + + Parameters: + locked_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if locked_by__s is not None and not isinstance(locked_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('locked_by__s', locked_by__s) + + def get_locked_for_s(self): + """ + The method to get the locked_for_s + + Returns: + LockedForS: An instance of LockedForS + """ + + return self.get_key_value('locked_for_s') + + def set_locked_for_s(self, locked_for_s): + """ + The method to set the value to locked_for_s + + Parameters: + locked_for_s (LockedForS) : An instance of LockedForS + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.locked_for_s import LockedForS + except Exception: + from .locked_for_s import LockedForS + + if locked_for_s is not None and not isinstance(locked_for_s, LockedForS): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_for_s EXPECTED TYPE: LockedForS', None, None) + + self.add_key_value('locked_for_s', locked_for_s) + + def get_locked_reason__s(self): + """ + The method to get the locked_reason__s + + Returns: + string: A string representing the locked_reason__s + """ + + return self.get_key_value('locked_reason__s') + + def set_locked_reason__s(self, locked_reason__s): + """ + The method to set the value to locked_reason__s + + Parameters: + locked_reason__s (string) : A string representing the locked_reason__s + """ + + if locked_reason__s is not None and not isinstance(locked_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_reason__s EXPECTED TYPE: str', None, None) + + self.add_key_value('locked_reason__s', locked_reason__s) + + def get_locked_time__s(self): + """ + The method to get the locked_time__s + + Returns: + string: A string representing the locked_time__s + """ + + return self.get_key_value('Locked_time__s') + + def set_locked_time__s(self, locked_time__s): + """ + The method to set the value to locked_time__s + + Parameters: + locked_time__s (string) : A string representing the locked_time__s + """ + + if locked_time__s is not None and not isinstance(locked_time__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_time__s EXPECTED TYPE: str', None, None) + + self.add_key_value('Locked_time__s', locked_time__s) + + def get_record_locking_configuration_id__s(self): + """ + The method to get the record_locking_configuration_id__s + + Returns: + int: An int representing the record_locking_configuration_id__s + """ + + return self.get_key_value('record_locking_configuration_id__s') + + def set_record_locking_configuration_id__s(self, record_locking_configuration_id__s): + """ + The method to set the value to record_locking_configuration_id__s + + Parameters: + record_locking_configuration_id__s (int) : An int representing the record_locking_configuration_id__s + """ + + if record_locking_configuration_id__s is not None and not isinstance(record_locking_configuration_id__s, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configuration_id__s EXPECTED TYPE: int', None, None) + + self.add_key_value('record_locking_configuration_id__s', record_locking_configuration_id__s) + + def get_record_locking_rule_id__s(self): + """ + The method to get the record_locking_rule_id__s + + Returns: + int: An int representing the record_locking_rule_id__s + """ + + return self.get_key_value('record_locking_rule_id__s') + + def set_record_locking_rule_id__s(self, record_locking_rule_id__s): + """ + The method to set the value to record_locking_rule_id__s + + Parameters: + record_locking_rule_id__s (int) : An int representing the record_locking_rule_id__s + """ + + if record_locking_rule_id__s is not None and not isinstance(record_locking_rule_id__s, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_rule_id__s EXPECTED TYPE: int', None, None) + + self.add_key_value('record_locking_rule_id__s', record_locking_rule_id__s) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_locking_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_locking_operations.py new file mode 100644 index 0000000..2e3eb27 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_locking_operations.py @@ -0,0 +1,252 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + + +class RecordLockingOperations(object): + def __init__(self, record_id, module_name): + """ + Creates an instance of RecordLockingOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module_name (string) : A string representing the module_name + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module_name = module_name + + + def get_record_locking_informations(self, param_instance=None): + """ + The method to get record locking informations + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s' + 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.set_param(param_instance) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def lock_records(self, request): + """ + The method to lock records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s' + 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.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_record_locking_information(self, lock_id, param_instance=None): + """ + The method to get record locking information + + Parameters: + lock_id (int) : An int representing the lock_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(lock_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_id EXPECTED TYPE: int', None, None) + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s/' + api_path = api_path + str(lock_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.set_param(param_instance) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_record_locking_information(self, lock_id, request): + """ + The method to update record locking information + + Parameters: + lock_id (int) : An int representing the lock_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(lock_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s/' + api_path = api_path + str(lock_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.set_mandatory_checker(True) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def unlock_record(self, lock_id): + """ + The method to unlock record + + Parameters: + lock_id (int) : An int representing the lock_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(lock_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s/' + api_path = api_path + str(lock_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetRecordLockingInformationsParam(object): + fields = Param('fields', 'com.zoho.crm.api.RecordLocking.GetRecordLockingInformationsParam') + ids = Param('ids', 'com.zoho.crm.api.RecordLocking.GetRecordLockingInformationsParam') + + +class GetRecordLockingInformationParam(object): + fields = Param('fields', 'com.zoho.crm.api.RecordLocking.GetRecordLockingInformationParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_wrapper.py new file mode 100644 index 0000000..e940333 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/success_response.py new file mode 100644 index 0000000..91d9911 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking/success_response.py @@ -0,0 +1,202 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__duplicate_field = None + self.__action = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_duplicate_field(self): + """ + The method to get the duplicate_field + + Returns: + string: A string representing the duplicate_field + """ + + return self.__duplicate_field + + def set_duplicate_field(self, duplicate_field): + """ + The method to set the value to duplicate_field + + Parameters: + duplicate_field (string) : A string representing the duplicate_field + """ + + if duplicate_field is not None and not isinstance(duplicate_field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_field EXPECTED TYPE: str', None, None) + + self.__duplicate_field = duplicate_field + self.__key_modified['duplicate_field'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + Choice: An instance of Choice + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (Choice) : An instance of Choice + """ + + if action is not None and not isinstance(action, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: Choice', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/__init__.py new file mode 100644 index 0000000..9d3c651 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/__init__.py @@ -0,0 +1,13 @@ +from .dependee import Dependee +from .action_wrapper import ActionWrapper +from .criteria import Criteria +from .body_wrapper import BodyWrapper +from .lock_excluded_profile import LockExcludedProfile +from .locking_rules import LockingRules +from .api_exception import APIException +from .action_response import ActionResponse +from .field import Field +from .restricted_custom_button import RestrictedCustomButton +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .record_lock import RecordLock diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_wrapper.py new file mode 100644 index 0000000..a0047a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__record_locking_configurations = None + self.__key_modified = dict() + + def get_record_locking_configurations(self): + """ + The method to get the record_locking_configurations + + Returns: + list: An instance of list + """ + + return self.__record_locking_configurations + + def set_record_locking_configurations(self, record_locking_configurations): + """ + The method to set the value to record_locking_configurations + + Parameters: + record_locking_configurations (list) : An instance of list + """ + + if record_locking_configurations is not None and not isinstance(record_locking_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configurations EXPECTED TYPE: list', None, None) + + self.__record_locking_configurations = record_locking_configurations + self.__key_modified['record_locking_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/api_exception.py new file mode 100644 index 0000000..49d630f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class APIException(ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/body_wrapper.py new file mode 100644 index 0000000..26a229e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__record_locking_configurations = None + self.__key_modified = dict() + + def get_record_locking_configurations(self): + """ + The method to get the record_locking_configurations + + Returns: + list: An instance of list + """ + + return self.__record_locking_configurations + + def set_record_locking_configurations(self, record_locking_configurations): + """ + The method to set the value to record_locking_configurations + + Parameters: + record_locking_configurations (list) : An instance of list + """ + + if record_locking_configurations is not None and not isinstance(record_locking_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configurations EXPECTED TYPE: list', None, None) + + self.__record_locking_configurations = record_locking_configurations + self.__key_modified['record_locking_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/criteria.py new file mode 100644 index 0000000..2ff3aa4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/dependee.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/dependee.py new file mode 100644 index 0000000..fb318b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/dependee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Dependee(object): + def __init__(self): + """Creates an instance of Dependee""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/lock_excluded_profile.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/lock_excluded_profile.py new file mode 100644 index 0000000..94b33e0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/lock_excluded_profile.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockExcludedProfile(object): + def __init__(self): + """Creates an instance of LockExcludedProfile""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/locking_rules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/locking_rules.py new file mode 100644 index 0000000..33d7e66 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/locking_rules.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockingRules(object): + def __init__(self): + """Creates an instance of LockingRules""" + + self.__name = None + self.__id = None + self.__lock_existing_records = None + self.__criteria = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_lock_existing_records(self): + """ + The method to get the lock_existing_records + + Returns: + bool: A bool representing the lock_existing_records + """ + + return self.__lock_existing_records + + def set_lock_existing_records(self, lock_existing_records): + """ + The method to set the value to lock_existing_records + + Parameters: + lock_existing_records (bool) : A bool representing the lock_existing_records + """ + + if lock_existing_records is not None and not isinstance(lock_existing_records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_existing_records EXPECTED TYPE: bool', None, None) + + self.__lock_existing_records = lock_existing_records + self.__key_modified['lock_existing_records'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/record_lock.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/record_lock.py new file mode 100644 index 0000000..57c1696 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/record_lock.py @@ -0,0 +1,463 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class RecordLock(object): + def __init__(self): + """Creates an instance of RecordLock""" + + self.__created_time = None + self.__locked_for = None + self.__excluded_fields = None + self.__created_by = None + self.__feature_type = None + self.__locking_rules = None + self.__restricted_actions = None + self.__lock_for_portal_users = None + self.__modified_time = None + self.__restricted_communications = None + self.__system_defined = None + self.__modified_by = None + self.__id = None + self.__lock_type = None + self.__restricted_custom_buttons = None + self.__lock_excluded_profiles = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_locked_for(self): + """ + The method to get the locked_for + + Returns: + string: A string representing the locked_for + """ + + return self.__locked_for + + def set_locked_for(self, locked_for): + """ + The method to set the value to locked_for + + Parameters: + locked_for (string) : A string representing the locked_for + """ + + if locked_for is not None and not isinstance(locked_for, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_for EXPECTED TYPE: str', None, None) + + self.__locked_for = locked_for + self.__key_modified['locked_for'] = 1 + + def get_excluded_fields(self): + """ + The method to get the excluded_fields + + Returns: + list: An instance of list + """ + + return self.__excluded_fields + + def set_excluded_fields(self, excluded_fields): + """ + The method to set the value to excluded_fields + + Parameters: + excluded_fields (list) : An instance of list + """ + + if excluded_fields is not None and not isinstance(excluded_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: excluded_fields EXPECTED TYPE: list', None, None) + + self.__excluded_fields = excluded_fields + self.__key_modified['excluded_fields'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_feature_type(self): + """ + The method to get the feature_type + + Returns: + string: A string representing the feature_type + """ + + return self.__feature_type + + def set_feature_type(self, feature_type): + """ + The method to set the value to feature_type + + Parameters: + feature_type (string) : A string representing the feature_type + """ + + if feature_type is not None and not isinstance(feature_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_type EXPECTED TYPE: str', None, None) + + self.__feature_type = feature_type + self.__key_modified['feature_type'] = 1 + + def get_locking_rules(self): + """ + The method to get the locking_rules + + Returns: + list: An instance of list + """ + + return self.__locking_rules + + def set_locking_rules(self, locking_rules): + """ + The method to set the value to locking_rules + + Parameters: + locking_rules (list) : An instance of list + """ + + if locking_rules is not None and not isinstance(locking_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locking_rules EXPECTED TYPE: list', None, None) + + self.__locking_rules = locking_rules + self.__key_modified['locking_rules'] = 1 + + def get_restricted_actions(self): + """ + The method to get the restricted_actions + + Returns: + list: An instance of list + """ + + return self.__restricted_actions + + def set_restricted_actions(self, restricted_actions): + """ + The method to set the value to restricted_actions + + Parameters: + restricted_actions (list) : An instance of list + """ + + if restricted_actions is not None and not isinstance(restricted_actions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_actions EXPECTED TYPE: list', None, None) + + self.__restricted_actions = restricted_actions + self.__key_modified['restricted_actions'] = 1 + + def get_lock_for_portal_users(self): + """ + The method to get the lock_for_portal_users + + Returns: + bool: A bool representing the lock_for_portal_users + """ + + return self.__lock_for_portal_users + + def set_lock_for_portal_users(self, lock_for_portal_users): + """ + The method to set the value to lock_for_portal_users + + Parameters: + lock_for_portal_users (bool) : A bool representing the lock_for_portal_users + """ + + if lock_for_portal_users is not None and not isinstance(lock_for_portal_users, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_for_portal_users EXPECTED TYPE: bool', None, None) + + self.__lock_for_portal_users = lock_for_portal_users + self.__key_modified['lock_for_portal_users'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_restricted_communications(self): + """ + The method to get the restricted_communications + + Returns: + list: An instance of list + """ + + return self.__restricted_communications + + def set_restricted_communications(self, restricted_communications): + """ + The method to set the value to restricted_communications + + Parameters: + restricted_communications (list) : An instance of list + """ + + if restricted_communications is not None and not isinstance(restricted_communications, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_communications EXPECTED TYPE: list', None, None) + + self.__restricted_communications = restricted_communications + self.__key_modified['restricted_communications'] = 1 + + def get_system_defined(self): + """ + The method to get the system_defined + + Returns: + bool: A bool representing the system_defined + """ + + return self.__system_defined + + def set_system_defined(self, system_defined): + """ + The method to set the value to system_defined + + Parameters: + system_defined (bool) : A bool representing the system_defined + """ + + if system_defined is not None and not isinstance(system_defined, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: bool', None, None) + + self.__system_defined = system_defined + self.__key_modified['system_defined'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_lock_type(self): + """ + The method to get the lock_type + + Returns: + Choice: An instance of Choice + """ + + return self.__lock_type + + def set_lock_type(self, lock_type): + """ + The method to set the value to lock_type + + Parameters: + lock_type (Choice) : An instance of Choice + """ + + if lock_type is not None and not isinstance(lock_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_type EXPECTED TYPE: Choice', None, None) + + self.__lock_type = lock_type + self.__key_modified['lock_type'] = 1 + + def get_restricted_custom_buttons(self): + """ + The method to get the restricted_custom_buttons + + Returns: + list: An instance of list + """ + + return self.__restricted_custom_buttons + + def set_restricted_custom_buttons(self, restricted_custom_buttons): + """ + The method to set the value to restricted_custom_buttons + + Parameters: + restricted_custom_buttons (list) : An instance of list + """ + + if restricted_custom_buttons is not None and not isinstance(restricted_custom_buttons, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_custom_buttons EXPECTED TYPE: list', None, None) + + self.__restricted_custom_buttons = restricted_custom_buttons + self.__key_modified['restricted_custom_buttons'] = 1 + + def get_lock_excluded_profiles(self): + """ + The method to get the lock_excluded_profiles + + Returns: + list: An instance of list + """ + + return self.__lock_excluded_profiles + + def set_lock_excluded_profiles(self, lock_excluded_profiles): + """ + The method to set the value to lock_excluded_profiles + + Parameters: + lock_excluded_profiles (list) : An instance of list + """ + + if lock_excluded_profiles is not None and not isinstance(lock_excluded_profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_excluded_profiles EXPECTED TYPE: list', None, None) + + self.__lock_excluded_profiles = lock_excluded_profiles + self.__key_modified['lock_excluded_profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/response_wrapper.py new file mode 100644 index 0000000..e190173 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__record_locking_configurations = None + self.__key_modified = dict() + + def get_record_locking_configurations(self): + """ + The method to get the record_locking_configurations + + Returns: + list: An instance of list + """ + + return self.__record_locking_configurations + + def set_record_locking_configurations(self, record_locking_configurations): + """ + The method to set the value to record_locking_configurations + + Parameters: + record_locking_configurations (list) : An instance of list + """ + + if record_locking_configurations is not None and not isinstance(record_locking_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configurations EXPECTED TYPE: list', None, None) + + self.__record_locking_configurations = record_locking_configurations + self.__key_modified['record_locking_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/restricted_custom_button.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/restricted_custom_button.py new file mode 100644 index 0000000..751948d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/restricted_custom_button.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RestrictedCustomButton(object): + def __init__(self): + """Creates an instance of RestrictedCustomButton""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/success_response.py new file mode 100644 index 0000000..ae8c634 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/__init__.py new file mode 100644 index 0000000..b84fcd2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/__init__.py @@ -0,0 +1,7 @@ +from .related_lists_operations import RelatedListsOperations, GetRelatedListsParam, GetRelatedListParam +from .api_exception import APIException +from .response_handler import ResponseHandler +from .field import Field +from .response_wrapper import ResponseWrapper +from .related_list import RelatedList +from .module_map import ModuleMap diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/api_exception.py new file mode 100644 index 0000000..9e9f19b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/module_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/module_map.py new file mode 100644 index 0000000..cec4563 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/module_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleMap(object): + def __init__(self): + """Creates an instance of ModuleMap""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_list.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_list.py new file mode 100644 index 0000000..902ab93 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_list.py @@ -0,0 +1,534 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class RelatedList(object): + def __init__(self): + """Creates an instance of RelatedList""" + + self.__id = None + self.__sequence_number = None + self.__display_label = None + self.__api_name = None + self.__module = None + self.__name = None + self.__action = None + self.__href = None + self.__type = None + self.__connectedmodule = None + self.__linkingmodule = None + self.__visible = None + self.__customize_sort = None + self.__customize_fields = None + self.__customize_display_label = None + self.__sort_by = None + self.__sort_order = None + self.__fields = None + self.__status = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + string: A string representing the sequence_number + """ + + return self.__sequence_number + + def set_sequence_number(self, sequence_number): + """ + The method to set the value to sequence_number + + Parameters: + sequence_number (string) : A string representing the sequence_number + """ + + if sequence_number is not None and not isinstance(sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: str', None, None) + + self.__sequence_number = sequence_number + self.__key_modified['sequence_number'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + string: A string representing the action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (string) : A string representing the action + """ + + if action is not None and not isinstance(action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: str', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_href(self): + """ + The method to get the href + + Returns: + string: A string representing the href + """ + + return self.__href + + def set_href(self, href): + """ + The method to set the value to href + + Parameters: + href (string) : A string representing the href + """ + + if href is not None and not isinstance(href, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: href EXPECTED TYPE: str', None, None) + + self.__href = href + self.__key_modified['href'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_connectedmodule(self): + """ + The method to get the connectedmodule + + Returns: + string: A string representing the connectedmodule + """ + + return self.__connectedmodule + + def set_connectedmodule(self, connectedmodule): + """ + The method to set the value to connectedmodule + + Parameters: + connectedmodule (string) : A string representing the connectedmodule + """ + + if connectedmodule is not None and not isinstance(connectedmodule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: connectedmodule EXPECTED TYPE: str', None, None) + + self.__connectedmodule = connectedmodule + self.__key_modified['connectedmodule'] = 1 + + def get_linkingmodule(self): + """ + The method to get the linkingmodule + + Returns: + string: A string representing the linkingmodule + """ + + return self.__linkingmodule + + def set_linkingmodule(self, linkingmodule): + """ + The method to set the value to linkingmodule + + Parameters: + linkingmodule (string) : A string representing the linkingmodule + """ + + if linkingmodule is not None and not isinstance(linkingmodule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linkingmodule EXPECTED TYPE: str', None, None) + + self.__linkingmodule = linkingmodule + self.__key_modified['linkingmodule'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_customize_sort(self): + """ + The method to get the customize_sort + + Returns: + bool: A bool representing the customize_sort + """ + + return self.__customize_sort + + def set_customize_sort(self, customize_sort): + """ + The method to set the value to customize_sort + + Parameters: + customize_sort (bool) : A bool representing the customize_sort + """ + + if customize_sort is not None and not isinstance(customize_sort, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_sort EXPECTED TYPE: bool', None, None) + + self.__customize_sort = customize_sort + self.__key_modified['customize_sort'] = 1 + + def get_customize_fields(self): + """ + The method to get the customize_fields + + Returns: + bool: A bool representing the customize_fields + """ + + return self.__customize_fields + + def set_customize_fields(self, customize_fields): + """ + The method to set the value to customize_fields + + Parameters: + customize_fields (bool) : A bool representing the customize_fields + """ + + if customize_fields is not None and not isinstance(customize_fields, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_fields EXPECTED TYPE: bool', None, None) + + self.__customize_fields = customize_fields + self.__key_modified['customize_fields'] = 1 + + def get_customize_display_label(self): + """ + The method to get the customize_display_label + + Returns: + bool: A bool representing the customize_display_label + """ + + return self.__customize_display_label + + def set_customize_display_label(self, customize_display_label): + """ + The method to set the value to customize_display_label + + Parameters: + customize_display_label (bool) : A bool representing the customize_display_label + """ + + if customize_display_label is not None and not isinstance(customize_display_label, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_display_label EXPECTED TYPE: bool', None, None) + + self.__customize_display_label = customize_display_label + self.__key_modified['customize_display_label'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + Field: An instance of Field + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.field import Field + except Exception: + from .field import Field + + if sort_by is not None and not isinstance(sort_by, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: Field', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_lists_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_lists_operations.py new file mode 100644 index 0000000..0dedf0f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_lists_operations.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class RelatedListsOperations(object): + def __init__(self, layout_id=None): + """ + Creates an instance of RelatedListsOperations with the given parameters + + Parameters: + layout_id (int) : An int representing the layout_id + """ + + if layout_id is not None and not isinstance(layout_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: int', None, None) + + self.__layout_id = layout_id + + + def get_related_lists(self, param_instance=None): + """ + The method to get related lists + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/related_lists' + 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('layout_id', 'com.zoho.crm.api.RelatedLists.GetRelatedListsParam'), self.__layout_id) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_related_list(self, id, param_instance=None): + """ + The method to get related list + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/related_lists/' + 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('layout_id', 'com.zoho.crm.api.RelatedLists.GetRelatedListParam'), self.__layout_id) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetRelatedListsParam(object): + module = Param('module', 'com.zoho.crm.api.RelatedLists.GetRelatedListsParam') + + +class GetRelatedListParam(object): + module = Param('module', 'com.zoho.crm.api.RelatedLists.GetRelatedListParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_wrapper.py new file mode 100644 index 0000000..bc30bbf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__related_lists = None + self.__key_modified = dict() + + def get_related_lists(self): + """ + The method to get the related_lists + + Returns: + list: An instance of list + """ + + return self.__related_lists + + def set_related_lists(self, related_lists): + """ + The method to set the value to related_lists + + Parameters: + related_lists (list) : An instance of list + """ + + if related_lists is not None and not isinstance(related_lists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_lists EXPECTED TYPE: list', None, None) + + self.__related_lists = related_lists + self.__key_modified['related_lists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/__init__.py new file mode 100644 index 0000000..274a90f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .file_body_wrapper import FileBodyWrapper +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .related_records_operations import RelatedRecordsOperations, GetRelatedRecordsParam, GetRelatedRecordsHeader, UpdateRelatedRecordsHeader, DelinkRecordsParam, DelinkRecordsHeader, GetRelatedRecordsUsingExternalIDParam, GetRelatedRecordsUsingExternalIDHeader, UpdateRelatedRecordsUsingExternalIDHeader, DeleteRelatedRecordsUsingExternalIDParam, DeleteRelatedRecordsUsingExternalIDHeader, GetRelatedRecordParam, GetRelatedRecordHeader, UpdateRelatedRecordHeader, DelinkRecordHeader, GetRelatedRecordUsingExternalIDParam, GetRelatedRecordUsingExternalIDHeader, UpdateRelatedRecordUsingExternalIDHeader, DeleteRelatedRecordUsingExternalIDHeader, GetDeletedParentRecordsRelatedRecordParam diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_wrapper.py new file mode 100644 index 0000000..93e99a0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/api_exception.py new file mode 100644 index 0000000..182b2be --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/file_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/file_body_wrapper.py new file mode 100644 index 0000000..fcfdf6c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/related_records_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/related_records_operations.py new file mode 100644 index 0000000..e477259 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/related_records_operations.py @@ -0,0 +1,845 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + from ..header import Header + + +class RelatedRecordsOperations(object): + def __init__(self, related_list_api_name, module_api_name): + """ + Creates an instance of RelatedRecordsOperations with the given parameters + + Parameters: + related_list_api_name (string) : A string representing the related_list_api_name + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(related_list_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_list_api_name EXPECTED TYPE: str', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__related_list_api_name = related_list_api_name + self.__module_api_name = module_api_name + + + def get_related_records(self, record_id, param_instance=None, header_instance=None): + """ + The method to get related records + + Parameters: + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_records(self, record_id, request, header_instance=None): + """ + The method to update related records + + Parameters: + record_id (int) : An int representing the record_id + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delink_records(self, record_id, param_instance=None, header_instance=None): + """ + The method to delink records + + Parameters: + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_related_records_using_external_id(self, external_value, param_instance=None, header_instance=None): + """ + The method to get related records using external id + + Parameters: + external_value (string) : A string representing the external_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_records_using_external_id(self, external_value, request, header_instance=None): + """ + The method to update related records using external id + + Parameters: + external_value (string) : A string representing the external_value + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_related_records_using_external_id(self, external_value, param_instance=None, header_instance=None): + """ + The method to delete related records using external id + + Parameters: + external_value (string) : A string representing the external_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_related_record(self, related_record_id, record_id, param_instance=None, header_instance=None): + """ + The method to get related record + + Parameters: + related_record_id (int) : An int representing the related_record_id + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(related_record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: int', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(related_record_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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_record(self, related_record_id, record_id, request, header_instance=None): + """ + The method to update related record + + Parameters: + related_record_id (int) : An int representing the related_record_id + record_id (int) : An int representing the record_id + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(related_record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: int', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(related_record_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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delink_record(self, related_record_id, record_id, header_instance=None): + """ + The method to delink record + + Parameters: + related_record_id (int) : An int representing the related_record_id + record_id (int) : An int representing the record_id + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(related_record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: int', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(related_record_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_related_record_using_external_id(self, external_field_value, external_value, param_instance=None, header_instance=None): + """ + The method to get related record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + external_value (string) : A string representing the external_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_record_using_external_id(self, external_field_value, external_value, request, header_instance=None): + """ + The method to update related record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + external_value (string) : A string representing the external_value + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_related_record_using_external_id(self, external_field_value, external_value, header_instance=None): + """ + The method to delete related record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + external_value (string) : A string representing the external_value + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_deleted_parent_records_related_record(self, record_id, param_instance=None): + """ + The method to get deleted parent records related record + + Parameters: + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/deleted/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_param(param_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetRelatedRecordsParam(object): + page = Param('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam') + per_page = Param('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam') + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam') + + +class GetRelatedRecordsHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader') + + +class UpdateRelatedRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordsHeader') + + +class DelinkRecordsParam(object): + ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsParam') + + +class DelinkRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsHeader') + + +class GetRelatedRecordsUsingExternalIDParam(object): + page = Param('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam') + per_page = Param('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam') + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam') + + +class GetRelatedRecordsUsingExternalIDHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDHeader') + + +class UpdateRelatedRecordsUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordsUsingExternalIDHeader') + + +class DeleteRelatedRecordsUsingExternalIDParam(object): + ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordsUsingExternalIDParam') + + +class DeleteRelatedRecordsUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordsUsingExternalIDHeader') + + +class GetRelatedRecordParam(object): + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordParam') + + +class GetRelatedRecordHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader') + + +class UpdateRelatedRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordHeader') + + +class DelinkRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordHeader') + + +class GetRelatedRecordUsingExternalIDParam(object): + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDParam') + + +class GetRelatedRecordUsingExternalIDHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDHeader') + + +class UpdateRelatedRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordUsingExternalIDHeader') + + +class DeleteRelatedRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordUsingExternalIDHeader') + + +class GetDeletedParentRecordsRelatedRecordParam(object): + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') + page = Param('page', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') + per_page = Param('per_page', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') + ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/response_wrapper.py new file mode 100644 index 0000000..32f102c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Info + except Exception: + from ..record import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/success_response.py new file mode 100644 index 0000000..87ebd71 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/related_records/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/request_proxy.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/request_proxy.py new file mode 100755 index 0000000..7419864 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/request_proxy.py @@ -0,0 +1,66 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +except Exception: + from .exception import SDKException + from .util import Constants + + +class RequestProxy(object): + def __init__(self, host, port, user=None, password=""): + + """ + Creates a RequestProxy class instance with the specified parameters. + + Parameters: + host(str): A String containing the hostname or address of the proxy server + port(int): An Integer containing The port number of the proxy server + user(str): A String containing the user name of the proxy server + password(str) : A String containing the password of the proxy server. Default value is an empty string + + Raises: + SDKException + """ + + if host is None: + raise SDKException(Constants.USER_PROXY_ERROR, Constants.HOST_ERROR_MESSAGE) + + if port is None: + raise SDKException(Constants.USER_PROXY_ERROR, Constants.PORT_ERROR_MESSAGE) + + self.__host = host + self.__port = port + self.__user = user + self.__password = password + + def get_host(self): + """ + This is a getter method to get __host. + + Returns: + string: A string representing __host + """ + + def get_port(self): + """ + This is a getter method to get __port. + + Returns: + string: A string representing __port + """ + + def get_user(self): + """ + This is a getter method to get __user. + + Returns: + string: A string representing __user + """ + + def get_password(self): + """ + This is a getter method to get __password. + + Returns: + string: A string representing __password + """ \ No newline at end of file diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/__init__.py new file mode 100644 index 0000000..53e9483 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .reschedule_history import RescheduleHistory +from .approval import Approval +from .appointment_name import AppointmentName +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .user import User +from .reschedule_history_operations import RescheduleHistoryOperations, GetAppointmentsRescheduledHistoryParam, GetAppointmentRescheduledHistoryParam +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_wrapper.py new file mode 100644 index 0000000..433d399 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/api_exception.py new file mode 100644 index 0000000..3c3dc1e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/appointment_name.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/appointment_name.py new file mode 100644 index 0000000..f415c32 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/appointment_name.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AppointmentName(object): + def __init__(self): + """Creates an instance of AppointmentName""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/approval.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/approval.py new file mode 100644 index 0000000..fc87dfb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/approval.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Approval(object): + def __init__(self): + """Creates an instance of Approval""" + + self.__delegate = None + self.__approve = None + self.__reject = None + self.__resubmit = None + self.__key_modified = dict() + + def get_delegate(self): + """ + The method to get the delegate + + Returns: + bool: A bool representing the delegate + """ + + return self.__delegate + + def set_delegate(self, delegate): + """ + The method to set the value to delegate + + Parameters: + delegate (bool) : A bool representing the delegate + """ + + if delegate is not None and not isinstance(delegate, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delegate EXPECTED TYPE: bool', None, None) + + self.__delegate = delegate + self.__key_modified['delegate'] = 1 + + def get_approve(self): + """ + The method to get the approve + + Returns: + bool: A bool representing the approve + """ + + return self.__approve + + def set_approve(self, approve): + """ + The method to set the value to approve + + Parameters: + approve (bool) : A bool representing the approve + """ + + if approve is not None and not isinstance(approve, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approve EXPECTED TYPE: bool', None, None) + + self.__approve = approve + self.__key_modified['approve'] = 1 + + def get_reject(self): + """ + The method to get the reject + + Returns: + bool: A bool representing the reject + """ + + return self.__reject + + def set_reject(self, reject): + """ + The method to set the value to reject + + Parameters: + reject (bool) : A bool representing the reject + """ + + if reject is not None and not isinstance(reject, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reject EXPECTED TYPE: bool', None, None) + + self.__reject = reject + self.__key_modified['reject'] = 1 + + def get_resubmit(self): + """ + The method to get the resubmit + + Returns: + bool: A bool representing the resubmit + """ + + return self.__resubmit + + def set_resubmit(self, resubmit): + """ + The method to set the value to resubmit + + Parameters: + resubmit (bool) : A bool representing the resubmit + """ + + if resubmit is not None and not isinstance(resubmit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resubmit EXPECTED TYPE: bool', None, None) + + self.__resubmit = resubmit + self.__key_modified['resubmit'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/info.py new file mode 100644 index 0000000..cbb4d4c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/info.py @@ -0,0 +1,226 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history.py new file mode 100644 index 0000000..8516070 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history.py @@ -0,0 +1,759 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RescheduleHistory(object): + def __init__(self): + """Creates an instance of RescheduleHistory""" + + self.__currency_symbol = None + self.__rescheduled_to = None + self.__review_process = None + self.__reschedule_reason = None + self.__sharing_permission = None + self.__name = None + self.__modified_by = None + self.__review = None + self.__rescheduled_by = None + self.__state = None + self.__canvas_id = None + self.__process_flow = None + self.__id = None + self.__rescheduled_time = None + self.__zia_visions = None + self.__approved = None + self.__modified_time = None + self.__approval = None + self.__created_time = None + self.__rescheduled_from = None + self.__appointment_name = None + self.__editable = None + self.__orchestration = None + self.__in_merge = None + self.__created_by = None + self.__approval_state = None + self.__reschedule_note = None + self.__key_modified = dict() + + def get_currency_symbol(self): + """ + The method to get the currency_symbol + + Returns: + string: A string representing the currency_symbol + """ + + return self.__currency_symbol + + def set_currency_symbol(self, currency_symbol): + """ + The method to set the value to currency_symbol + + Parameters: + currency_symbol (string) : A string representing the currency_symbol + """ + + if currency_symbol is not None and not isinstance(currency_symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency_symbol EXPECTED TYPE: str', None, None) + + self.__currency_symbol = currency_symbol + self.__key_modified['$currency_symbol'] = 1 + + def get_rescheduled_to(self): + """ + The method to get the rescheduled_to + + Returns: + datetime: An instance of datetime + """ + + return self.__rescheduled_to + + def set_rescheduled_to(self, rescheduled_to): + """ + The method to set the value to rescheduled_to + + Parameters: + rescheduled_to (datetime) : An instance of datetime + """ + + from datetime import datetime + + if rescheduled_to is not None and not isinstance(rescheduled_to, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_to EXPECTED TYPE: datetime', None, None) + + self.__rescheduled_to = rescheduled_to + self.__key_modified['Rescheduled_To'] = 1 + + def get_review_process(self): + """ + The method to get the review_process + + Returns: + bool: A bool representing the review_process + """ + + return self.__review_process + + def set_review_process(self, review_process): + """ + The method to set the value to review_process + + Parameters: + review_process (bool) : A bool representing the review_process + """ + + if review_process is not None and not isinstance(review_process, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: review_process EXPECTED TYPE: bool', None, None) + + self.__review_process = review_process + self.__key_modified['$review_process'] = 1 + + def get_reschedule_reason(self): + """ + The method to get the reschedule_reason + + Returns: + string: A string representing the reschedule_reason + """ + + return self.__reschedule_reason + + def set_reschedule_reason(self, reschedule_reason): + """ + The method to set the value to reschedule_reason + + Parameters: + reschedule_reason (string) : A string representing the reschedule_reason + """ + + if reschedule_reason is not None and not isinstance(reschedule_reason, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reschedule_reason EXPECTED TYPE: str', None, None) + + self.__reschedule_reason = reschedule_reason + self.__key_modified['Reschedule_Reason'] = 1 + + def get_sharing_permission(self): + """ + The method to get the sharing_permission + + Returns: + string: A string representing the sharing_permission + """ + + return self.__sharing_permission + + def set_sharing_permission(self, sharing_permission): + """ + The method to set the value to sharing_permission + + Parameters: + sharing_permission (string) : A string representing the sharing_permission + """ + + if sharing_permission is not None and not isinstance(sharing_permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: str', None, None) + + self.__sharing_permission = sharing_permission + self.__key_modified['$sharing_permission'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['Modified_By'] = 1 + + def get_review(self): + """ + The method to get the review + + Returns: + bool: A bool representing the review + """ + + return self.__review + + def set_review(self, review): + """ + The method to set the value to review + + Parameters: + review (bool) : A bool representing the review + """ + + if review is not None and not isinstance(review, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: review EXPECTED TYPE: bool', None, None) + + self.__review = review + self.__key_modified['$review'] = 1 + + def get_rescheduled_by(self): + """ + The method to get the rescheduled_by + + Returns: + User: An instance of User + """ + + return self.__rescheduled_by + + def set_rescheduled_by(self, rescheduled_by): + """ + The method to set the value to rescheduled_by + + Parameters: + rescheduled_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.user import User + except Exception: + from .user import User + + if rescheduled_by is not None and not isinstance(rescheduled_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_by EXPECTED TYPE: User', None, None) + + self.__rescheduled_by = rescheduled_by + self.__key_modified['Rescheduled_By'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['$state'] = 1 + + def get_canvas_id(self): + """ + The method to get the canvas_id + + Returns: + string: A string representing the canvas_id + """ + + return self.__canvas_id + + def set_canvas_id(self, canvas_id): + """ + The method to set the value to canvas_id + + Parameters: + canvas_id (string) : A string representing the canvas_id + """ + + if canvas_id is not None and not isinstance(canvas_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: canvas_id EXPECTED TYPE: str', None, None) + + self.__canvas_id = canvas_id + self.__key_modified['$canvas_id'] = 1 + + def get_process_flow(self): + """ + The method to get the process_flow + + Returns: + bool: A bool representing the process_flow + """ + + return self.__process_flow + + def set_process_flow(self, process_flow): + """ + The method to set the value to process_flow + + Parameters: + process_flow (bool) : A bool representing the process_flow + """ + + if process_flow is not None and not isinstance(process_flow, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_flow EXPECTED TYPE: bool', None, None) + + self.__process_flow = process_flow + self.__key_modified['$process_flow'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_rescheduled_time(self): + """ + The method to get the rescheduled_time + + Returns: + datetime: An instance of datetime + """ + + return self.__rescheduled_time + + def set_rescheduled_time(self, rescheduled_time): + """ + The method to set the value to rescheduled_time + + Parameters: + rescheduled_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if rescheduled_time is not None and not isinstance(rescheduled_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_time EXPECTED TYPE: datetime', None, None) + + self.__rescheduled_time = rescheduled_time + self.__key_modified['Rescheduled_Time'] = 1 + + def get_zia_visions(self): + """ + The method to get the zia_visions + + Returns: + bool: A bool representing the zia_visions + """ + + return self.__zia_visions + + def set_zia_visions(self, zia_visions): + """ + The method to set the value to zia_visions + + Parameters: + zia_visions (bool) : A bool representing the zia_visions + """ + + if zia_visions is not None and not isinstance(zia_visions, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_visions EXPECTED TYPE: bool', None, None) + + self.__zia_visions = zia_visions + self.__key_modified['$zia_visions'] = 1 + + def get_approved(self): + """ + The method to get the approved + + Returns: + bool: A bool representing the approved + """ + + return self.__approved + + def set_approved(self, approved): + """ + The method to set the value to approved + + Parameters: + approved (bool) : A bool representing the approved + """ + + if approved is not None and not isinstance(approved, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approved EXPECTED TYPE: bool', None, None) + + self.__approved = approved + self.__key_modified['$approved'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_approval(self): + """ + The method to get the approval + + Returns: + Approval: An instance of Approval + """ + + return self.__approval + + def set_approval(self, approval): + """ + The method to set the value to approval + + Parameters: + approval (Approval) : An instance of Approval + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.approval import Approval + except Exception: + from .approval import Approval + + if approval is not None and not isinstance(approval, Approval): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approval EXPECTED TYPE: Approval', None, None) + + self.__approval = approval + self.__key_modified['$approval'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['Created_Time'] = 1 + + def get_rescheduled_from(self): + """ + The method to get the rescheduled_from + + Returns: + datetime: An instance of datetime + """ + + return self.__rescheduled_from + + def set_rescheduled_from(self, rescheduled_from): + """ + The method to set the value to rescheduled_from + + Parameters: + rescheduled_from (datetime) : An instance of datetime + """ + + from datetime import datetime + + if rescheduled_from is not None and not isinstance(rescheduled_from, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_from EXPECTED TYPE: datetime', None, None) + + self.__rescheduled_from = rescheduled_from + self.__key_modified['Rescheduled_From'] = 1 + + def get_appointment_name(self): + """ + The method to get the appointment_name + + Returns: + AppointmentName: An instance of AppointmentName + """ + + return self.__appointment_name + + def set_appointment_name(self, appointment_name): + """ + The method to set the value to appointment_name + + Parameters: + appointment_name (AppointmentName) : An instance of AppointmentName + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.appointment_name import AppointmentName + except Exception: + from .appointment_name import AppointmentName + + if appointment_name is not None and not isinstance(appointment_name, AppointmentName): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_name EXPECTED TYPE: AppointmentName', None, None) + + self.__appointment_name = appointment_name + self.__key_modified['Appointment_Name'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['$editable'] = 1 + + def get_orchestration(self): + """ + The method to get the orchestration + + Returns: + bool: A bool representing the orchestration + """ + + return self.__orchestration + + def set_orchestration(self, orchestration): + """ + The method to set the value to orchestration + + Parameters: + orchestration (bool) : A bool representing the orchestration + """ + + if orchestration is not None and not isinstance(orchestration, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: orchestration EXPECTED TYPE: bool', None, None) + + self.__orchestration = orchestration + self.__key_modified['$orchestration'] = 1 + + def get_in_merge(self): + """ + The method to get the in_merge + + Returns: + bool: A bool representing the in_merge + """ + + return self.__in_merge + + def set_in_merge(self, in_merge): + """ + The method to set the value to in_merge + + Parameters: + in_merge (bool) : A bool representing the in_merge + """ + + if in_merge is not None and not isinstance(in_merge, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: in_merge EXPECTED TYPE: bool', None, None) + + self.__in_merge = in_merge + self.__key_modified['$in_merge'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['Created_By'] = 1 + + def get_approval_state(self): + """ + The method to get the approval_state + + Returns: + string: A string representing the approval_state + """ + + return self.__approval_state + + def set_approval_state(self, approval_state): + """ + The method to set the value to approval_state + + Parameters: + approval_state (string) : A string representing the approval_state + """ + + if approval_state is not None and not isinstance(approval_state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approval_state EXPECTED TYPE: str', None, None) + + self.__approval_state = approval_state + self.__key_modified['$approval_state'] = 1 + + def get_reschedule_note(self): + """ + The method to get the reschedule_note + + Returns: + string: A string representing the reschedule_note + """ + + return self.__reschedule_note + + def set_reschedule_note(self, reschedule_note): + """ + The method to set the value to reschedule_note + + Parameters: + reschedule_note (string) : A string representing the reschedule_note + """ + + if reschedule_note is not None and not isinstance(reschedule_note, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reschedule_note EXPECTED TYPE: str', None, None) + + self.__reschedule_note = reschedule_note + self.__key_modified['Reschedule_Note'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.py new file mode 100644 index 0000000..88b2463 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.py @@ -0,0 +1,247 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class RescheduleHistoryOperations(object): + def __init__(self): + """Creates an instance of RescheduleHistoryOperations""" + pass + + def add_appointments_rescheduled_history(self, request): + """ + The method to add appointments rescheduled history + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Appointments_Rescheduled_History__s' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_appointments_rescheduled_history(self, request): + """ + The method to update appointments rescheduled history + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Appointments_Rescheduled_History__s' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_appointments_rescheduled_history(self, param_instance=None): + """ + The method to get appointments rescheduled history + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Appointments_Rescheduled_History__s' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_appointment_rescheduled_history(self, id, request): + """ + The method to update appointment rescheduled history + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/Appointments_Rescheduled_History__s/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_appointment_rescheduled_history(self, id, param_instance=None): + """ + The method to get appointment rescheduled history + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/Appointments_Rescheduled_History__s/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_appointments_rescheduled_history(self, id): + """ + The method to delete appointments rescheduled history + + 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/v7/Appointments_Rescheduled_History__s/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAppointmentsRescheduledHistoryParam(object): + fields = Param('fields', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + page = Param('page', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + per_page = Param('per_page', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + ids = Param('ids', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + + +class GetAppointmentRescheduledHistoryParam(object): + fields = Param('fields', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentRescheduledHistoryParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_wrapper.py new file mode 100644 index 0000000..9f6af18 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/success_response.py new file mode 100644 index 0000000..eabbba2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/user.py new file mode 100644 index 0000000..bf4dd24 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/__init__.py new file mode 100644 index 0000000..9e6098e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/__init__.py @@ -0,0 +1,11 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .role import Role +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .roles_operations import RolesOperations, DeleteRoleParam +from .reporting_to import ReportingTo diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_wrapper.py new file mode 100644 index 0000000..7bc8f5d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__roles = None + self.__key_modified = dict() + + def get_roles(self): + """ + The method to get the roles + + Returns: + list: An instance of list + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (list) : An instance of list + """ + + if roles is not None and not isinstance(roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: list', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/api_exception.py new file mode 100644 index 0000000..c80d827 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/body_wrapper.py new file mode 100644 index 0000000..a5559da --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__roles = None + self.__key_modified = dict() + + def get_roles(self): + """ + The method to get the roles + + Returns: + list: An instance of list + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (list) : An instance of list + """ + + if roles is not None and not isinstance(roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: list', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/reporting_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/reporting_to.py new file mode 100644 index 0000000..44dcbf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/reporting_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReportingTo(object): + def __init__(self): + """Creates an instance of ReportingTo""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/response_wrapper.py new file mode 100644 index 0000000..305361b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__roles = None + self.__key_modified = dict() + + def get_roles(self): + """ + The method to get the roles + + Returns: + list: An instance of list + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (list) : An instance of list + """ + + if roles is not None and not isinstance(roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: list', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/role.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/role.py new file mode 100644 index 0000000..1e2b0bf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/role.py @@ -0,0 +1,373 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Role(object): + def __init__(self): + """Creates an instance of Role""" + + self.__display_label = None + self.__forecast_manager = None + self.__reporting_to = None + self.__share_with_peers = None + self.__description = None + self.__id = None + self.__name = None + self.__created_by__s = None + self.__modified_by__s = None + self.__modified_time__s = None + self.__created_time__s = None + self.__admin_user = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_forecast_manager(self): + """ + The method to get the forecast_manager + + Returns: + ReportingTo: An instance of ReportingTo + """ + + return self.__forecast_manager + + def set_forecast_manager(self, forecast_manager): + """ + The method to set the value to forecast_manager + + Parameters: + forecast_manager (ReportingTo) : An instance of ReportingTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.reporting_to import ReportingTo + except Exception: + from .reporting_to import ReportingTo + + if forecast_manager is not None and not isinstance(forecast_manager, ReportingTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_manager EXPECTED TYPE: ReportingTo', None, None) + + self.__forecast_manager = forecast_manager + self.__key_modified['forecast_manager'] = 1 + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + ReportingTo: An instance of ReportingTo + """ + + return self.__reporting_to + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (ReportingTo) : An instance of ReportingTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.reporting_to import ReportingTo + except Exception: + from .reporting_to import ReportingTo + + if reporting_to is not None and not isinstance(reporting_to, ReportingTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: ReportingTo', None, None) + + self.__reporting_to = reporting_to + self.__key_modified['reporting_to'] = 1 + + def get_share_with_peers(self): + """ + The method to get the share_with_peers + + Returns: + bool: A bool representing the share_with_peers + """ + + return self.__share_with_peers + + def set_share_with_peers(self, share_with_peers): + """ + The method to set the value to share_with_peers + + Parameters: + share_with_peers (bool) : A bool representing the share_with_peers + """ + + if share_with_peers is not None and not isinstance(share_with_peers, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_with_peers EXPECTED TYPE: bool', None, None) + + self.__share_with_peers = share_with_peers + self.__key_modified['share_with_peers'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_created_by__s(self): + """ + The method to get the created_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by__s + + def set_created_by__s(self, created_by__s): + """ + The method to set the value to created_by__s + + Parameters: + created_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by__s is not None and not isinstance(created_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by__s = created_by__s + self.__key_modified['created_by__s'] = 1 + + def get_modified_by__s(self): + """ + The method to get the modified_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by__s + + def set_modified_by__s(self, modified_by__s): + """ + The method to set the value to modified_by__s + + Parameters: + modified_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by__s is not None and not isinstance(modified_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by__s = modified_by__s + self.__key_modified['modified_by__s'] = 1 + + def get_modified_time__s(self): + """ + The method to get the modified_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time__s + + def set_modified_time__s(self, modified_time__s): + """ + The method to set the value to modified_time__s + + Parameters: + modified_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if modified_time__s is not None and not isinstance(modified_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time__s EXPECTED TYPE: datetime', None, None) + + self.__modified_time__s = modified_time__s + self.__key_modified['modified_time__s'] = 1 + + def get_created_time__s(self): + """ + The method to get the created_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time__s + + def set_created_time__s(self, created_time__s): + """ + The method to set the value to created_time__s + + Parameters: + created_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time__s is not None and not isinstance(created_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time__s EXPECTED TYPE: datetime', None, None) + + self.__created_time__s = created_time__s + self.__key_modified['created_time__s'] = 1 + + def get_admin_user(self): + """ + The method to get the admin_user + + Returns: + bool: A bool representing the admin_user + """ + + return self.__admin_user + + def set_admin_user(self, admin_user): + """ + The method to set the value to admin_user + + Parameters: + admin_user (bool) : A bool representing the admin_user + """ + + if admin_user is not None and not isinstance(admin_user, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: admin_user EXPECTED TYPE: bool', None, None) + + self.__admin_user = admin_user + self.__key_modified['admin_user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/roles_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/roles_operations.py new file mode 100644 index 0000000..1e6cbbb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/roles_operations.py @@ -0,0 +1,227 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class RolesOperations(object): + def __init__(self): + """Creates an instance of RolesOperations""" + pass + + def get_roles(self): + """ + The method to get roles + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_roles(self, request): + """ + The method to create roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_roles(self, request): + """ + The method to update roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/roles' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_role(self, role_id): + """ + The method to get role + + Parameters: + role_id (int) : An int representing the role_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(role_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/roles/' + api_path = api_path + str(role_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_role(self, role_id, request): + """ + The method to update role + + Parameters: + role_id (int) : An int representing the role_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(role_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role_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/v7/settings/roles/' + api_path = api_path + str(role_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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_role(self, role_id, param_instance=None): + """ + The method to delete role + + Parameters: + role_id (int) : An int representing the role_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(role_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role_id EXPECTED TYPE: int', None, None) + + 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/v7/settings/roles/' + api_path = api_path + str(role_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class DeleteRoleParam(object): + transfer_to_id = Param('transfer_to_id', 'com.zoho.crm.api.Roles.DeleteRoleParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/success_response.py new file mode 100644 index 0000000..9877ae0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/roles/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/__init__.py new file mode 100644 index 0000000..e157ef4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/__init__.py @@ -0,0 +1,20 @@ +from .action_wrapper import ActionWrapper +from .field_rule import FieldRule +from .scoring_rule import ScoringRule +from .criteria import Criteria +from .layout_request_wrapper import LayoutRequestWrapper +from .body_wrapper import BodyWrapper +from .expected_field import ExpectedField +from .signal_rule import SignalRule +from .layout import Layout +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .scoring_rules_operations import ScoringRulesOperations, GetScoringRulesParam, DeleteScoringRulesParam, GetScoringRuleParam +from .field import Field +from .success_response import SuccessResponse +from .role_request_wrapper import RoleRequestWrapper +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .signal import Signal +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_wrapper.py new file mode 100644 index 0000000..360bf4a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__scoring_rules = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/api_exception.py new file mode 100644 index 0000000..6bdc9b2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/body_wrapper.py new file mode 100644 index 0000000..1920c40 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__scoring_rules = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/criteria.py new file mode 100644 index 0000000..29b13d6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/expected_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/expected_field.py new file mode 100644 index 0000000..f7bbab1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/expected_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExpectedField(object): + def __init__(self): + """Creates an instance of ExpectedField""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field_rule.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field_rule.py new file mode 100644 index 0000000..68cff56 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field_rule.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldRule(object): + def __init__(self): + """Creates an instance of FieldRule""" + + self.__score = None + self.__criteria = None + self.__id = None + self.__key_modified = dict() + + def get_score(self): + """ + The method to get the score + + Returns: + int: An int representing the score + """ + + return self.__score + + def set_score(self, score): + """ + The method to set the value to score + + Parameters: + score (int) : An int representing the score + """ + + if score is not None and not isinstance(score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: score EXPECTED TYPE: int', None, None) + + self.__score = score + self.__key_modified['score'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/info.py new file mode 100644 index 0000000..94c5980 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/info.py @@ -0,0 +1,276 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__call = None + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__email = None + self.__more_records = None + self.__key_modified = dict() + + def get_call(self): + """ + The method to get the call + + Returns: + bool: A bool representing the call + """ + + return self.__call + + def set_call(self, call): + """ + The method to set the value to call + + Parameters: + call (bool) : A bool representing the call + """ + + if call is not None and not isinstance(call, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call EXPECTED TYPE: bool', None, None) + + self.__call = call + self.__key_modified['call'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + bool: A bool representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (bool) : A bool representing the email + """ + + if email is not None and not isinstance(email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: bool', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout.py new file mode 100644 index 0000000..b8c4ce2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout_request_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout_request_wrapper.py new file mode 100644 index 0000000..7b3cf1e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout_request_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LayoutRequestWrapper(object): + def __init__(self): + """Creates an instance of LayoutRequestWrapper""" + + self.__layout = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_wrapper.py new file mode 100644 index 0000000..9cda57b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__scoring_rules = None + self.__info = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/role_request_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/role_request_wrapper.py new file mode 100644 index 0000000..522f447 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/role_request_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RoleRequestWrapper(object): + def __init__(self): + """Creates an instance of RoleRequestWrapper""" + + self.__scoring_rules = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rule.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rule.py new file mode 100644 index 0000000..c5dfebc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rule.py @@ -0,0 +1,369 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScoringRule(object): + def __init__(self): + """Creates an instance of ScoringRule""" + + self.__name = None + self.__description = None + self.__id = None + self.__layout = None + self.__created_time = None + self.__modified_time = None + self.__module = None + self.__modified_by = None + self.__active = None + self.__created_by = None + self.__field_rules = None + self.__signal_rules = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + string: A string representing the modified_time + """ + + return self.__modified_time + + def set_modified_time(self, modified_time): + """ + The method to set the value to modified_time + + Parameters: + modified_time (string) : A string representing the modified_time + """ + + if modified_time is not None and not isinstance(modified_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: str', None, None) + + self.__modified_time = modified_time + self.__key_modified['modified_time'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Modules: An instance of Modules + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import Modules + except Exception: + from ..modules import Modules + + if module is not None and not isinstance(module, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Modules', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_field_rules(self): + """ + The method to get the field_rules + + Returns: + list: An instance of list + """ + + return self.__field_rules + + def set_field_rules(self, field_rules): + """ + The method to set the value to field_rules + + Parameters: + field_rules (list) : An instance of list + """ + + if field_rules is not None and not isinstance(field_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_rules EXPECTED TYPE: list', None, None) + + self.__field_rules = field_rules + self.__key_modified['field_rules'] = 1 + + def get_signal_rules(self): + """ + The method to get the signal_rules + + Returns: + list: An instance of list + """ + + return self.__signal_rules + + def set_signal_rules(self, signal_rules): + """ + The method to set the value to signal_rules + + Parameters: + signal_rules (list) : An instance of list + """ + + if signal_rules is not None and not isinstance(signal_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signal_rules EXPECTED TYPE: list', None, None) + + self.__signal_rules = signal_rules + self.__key_modified['signal_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rules_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rules_operations.py new file mode 100644 index 0000000..d65f07d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rules_operations.py @@ -0,0 +1,469 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class ScoringRulesOperations(object): + def __init__(self): + """Creates an instance of ScoringRulesOperations""" + pass + + def create_scoring_rules(self, request): + """ + The method to create scoring rules + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/automation/scoring_rules' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_scoring_rules(self, param_instance=None): + """ + The method to get scoring rules + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/automation/scoring_rules' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_scoring_rules(self, request): + """ + The method to update scoring rules + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/automation/scoring_rules' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_scoring_rules(self, param_instance=None): + """ + The method to delete scoring rules + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/automation/scoring_rules' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_scoring_rule(self, id, request): + """ + The method to update scoring rule + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_scoring_rule(self, module, id, param_instance=None): + """ + The method to get scoring rule + + Parameters: + module (string) : A string representing the module + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/automation/scoring_rules/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_scoring_rule(self, id): + """ + The method to delete scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def activate_scoring_rule(self, id): + """ + The method to activate scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + api_path = api_path + '/actions/activate' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def deactivate_scoring_rule(self, id): + """ + The method to deactivate scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + api_path = api_path + '/actions/activate' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def clone_scoring_rule(self, id): + """ + The method to clone scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + api_path = api_path + '/actions/clone' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def scoring_rule_execution_using_layout_id(self, module, request): + """ + The method to scoring rule execution using layout id + + Parameters: + module (string) : A string representing the module + request (LayoutRequestWrapper) : An instance of LayoutRequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.layout_request_wrapper import LayoutRequestWrapper + except Exception: + from .layout_request_wrapper import LayoutRequestWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, LayoutRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: LayoutRequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/run_scoring_rules' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def scoring_rule_execution_using_rule_ids(self, module, request): + """ + The method to scoring rule execution using rule ids + + Parameters: + module (string) : A string representing the module + request (RoleRequestWrapper) : An instance of RoleRequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.role_request_wrapper import RoleRequestWrapper + except Exception: + from .role_request_wrapper import RoleRequestWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, RoleRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RoleRequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/run_scoring_rules' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetScoringRulesParam(object): + module = Param('module', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + layout_id = Param('layout_id', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + active = Param('active', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + name = Param('name', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + page = Param('page', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + per_page = Param('per_page', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + + +class DeleteScoringRulesParam(object): + ids = Param('ids', 'com.zoho.crm.api.ScoringRules.DeleteScoringRulesParam') + + +class GetScoringRuleParam(object): + layout_id = Param('layout_id', 'com.zoho.crm.api.ScoringRules.GetScoringRuleParam') + active = Param('active', 'com.zoho.crm.api.ScoringRules.GetScoringRuleParam') + name = Param('name', 'com.zoho.crm.api.ScoringRules.GetScoringRuleParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal.py new file mode 100644 index 0000000..85e5fd7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Signal(object): + def __init__(self): + """Creates an instance of Signal""" + + self.__namespace = None + self.__id = None + self.__key_modified = dict() + + def get_namespace(self): + """ + The method to get the namespace + + Returns: + string: A string representing the namespace + """ + + return self.__namespace + + def set_namespace(self, namespace): + """ + The method to set the value to namespace + + Parameters: + namespace (string) : A string representing the namespace + """ + + if namespace is not None and not isinstance(namespace, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: namespace EXPECTED TYPE: str', None, None) + + self.__namespace = namespace + self.__key_modified['namespace'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal_rule.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal_rule.py new file mode 100644 index 0000000..1c1fbe1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal_rule.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SignalRule(object): + def __init__(self): + """Creates an instance of SignalRule""" + + self.__score = None + self.__signal = None + self.__id = None + self.__key_modified = dict() + + def get_score(self): + """ + The method to get the score + + Returns: + int: An int representing the score + """ + + return self.__score + + def set_score(self, score): + """ + The method to set the value to score + + Parameters: + score (int) : An int representing the score + """ + + if score is not None and not isinstance(score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: score EXPECTED TYPE: int', None, None) + + self.__score = score + self.__key_modified['score'] = 1 + + def get_signal(self): + """ + The method to get the signal + + Returns: + Signal: An instance of Signal + """ + + return self.__signal + + def set_signal(self, signal): + """ + The method to set the value to signal + + Parameters: + signal (Signal) : An instance of Signal + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.signal import Signal + except Exception: + from .signal import Signal + + if signal is not None and not isinstance(signal, Signal): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signal EXPECTED TYPE: Signal', None, None) + + self.__signal = signal + self.__key_modified['signal'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/success_response.py new file mode 100644 index 0000000..42c3860 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class SuccessResponse(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/sdk_config.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/sdk_config.py new file mode 100755 index 0000000..5132e7b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/sdk_config.py @@ -0,0 +1,55 @@ +class SDKConfig(object): + """ + The class to configure the SDK. + """ + + def __init__(self, auto_refresh_fields=False, pick_list_validation=True, read_timeout=None, connect_timeout=None): + """ + Creates an instance of SDKConfig with the following parameters + + Parameters: + auto_refresh_fields(bool): A bool representing auto_refresh_fields + pick_list_validation(bool): A bool representing pick_list_validation + read_timeout(float): A Float representing read_timeout + connect_timeout(float): A Float representing connect_timeout + """ + self.__auto_refresh_fields = auto_refresh_fields + self.__pick_list_validation = pick_list_validation + self.__read_timeout = read_timeout + self.__connect_timeout = connect_timeout + + def get_auto_refresh_fields(self): + """ + This is a getter method to get auto_refresh_fields. + + Returns: + bool: A bool representing auto_refresh_fields + """ + return self.__auto_refresh_fields + + def get_pick_list_validation(self): + """ + This is a getter method to get pick_list_validation. + + Returns: + bool: A bool representing pick_list_validation + """ + return self.__pick_list_validation + + def get_read_timeout(self): + """ + This is a getter method to get read_timeout. + + Returns: + Float: A Float representing read_timeout + """ + return self.__read_timeout + + def get_connect_timeout(self): + """ + This is a getter method to get connect_timeout. + + Returns: + Float: A Float representing connect_timeout + """ + return self.__connect_timeout diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/__init__.py new file mode 100644 index 0000000..6fad2ef --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/__init__.py @@ -0,0 +1,21 @@ +from .cc import Cc +from .owner import Owner +from .action_wrapper import ActionWrapper +from .template import Template +from .data_subject_request import DataSubjectRequest +from .data import Data +from .send_mail_operations import SendMailOperations +from .body_wrapper import BodyWrapper +from .in_reply_to import InReplyTo +from .blocked_email_address import BlockedEmailAddress +from .linked_record import LinkedRecord +from .api_exception import APIException +from .action_response import ActionResponse +from .attachment import Attachment +from .success_response import SuccessResponse +from .inventory_details import InventoryDetails +from .linked_module import LinkedModule +from .from1 import From +from .action_handler import ActionHandler +from .to import To +from .inventory_template import InventoryTemplate diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_wrapper.py new file mode 100644 index 0000000..239b739 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/api_exception.py new file mode 100644 index 0000000..685af3b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/attachment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/attachment.py new file mode 100644 index 0000000..a81642f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/attachment.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachment(object): + def __init__(self): + """Creates an instance of Attachment""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/blocked_email_address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/blocked_email_address.py new file mode 100644 index 0000000..b8d1734 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/blocked_email_address.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BlockedEmailAddress(object): + def __init__(self): + """Creates an instance of BlockedEmailAddress""" + + self.__email = None + self.__reason = None + self.__key_modified = dict() + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_reason(self): + """ + The method to get the reason + + Returns: + string: A string representing the reason + """ + + return self.__reason + + def set_reason(self, reason): + """ + The method to set the value to reason + + Parameters: + reason (string) : A string representing the reason + """ + + if reason is not None and not isinstance(reason, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reason EXPECTED TYPE: str', None, None) + + self.__reason = reason + self.__key_modified['reason'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/cc.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/cc.py new file mode 100644 index 0000000..09430ce --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/cc.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Cc(object): + def __init__(self): + """Creates an instance of Cc""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/data.py new file mode 100644 index 0000000..6d252c9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/data.py @@ -0,0 +1,511 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Data(object): + def __init__(self): + """Creates an instance of Data""" + + self.__from_1 = None + self.__to = None + self.__cc = None + self.__bcc = None + self.__reply_to = None + self.__org_email = None + self.__scheduled_time = None + self.__mail_format = None + self.__consent_email = None + self.__content = None + self.__subject = None + self.__in_reply_to = None + self.__template = None + self.__inventory_details = None + self.__data_subject_request = None + self.__attachments = None + self.__linked_record = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + From: An instance of From + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (From) : An instance of From + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.from1 import From + except Exception: + from .from1 import From + + if from_1 is not None and not isinstance(from_1, From): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: From', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_bcc(self): + """ + The method to get the bcc + + Returns: + list: An instance of list + """ + + return self.__bcc + + def set_bcc(self, bcc): + """ + The method to set the value to bcc + + Parameters: + bcc (list) : An instance of list + """ + + if bcc is not None and not isinstance(bcc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc EXPECTED TYPE: list', None, None) + + self.__bcc = bcc + self.__key_modified['bcc'] = 1 + + def get_reply_to(self): + """ + The method to get the reply_to + + Returns: + To: An instance of To + """ + + return self.__reply_to + + def set_reply_to(self, reply_to): + """ + The method to set the value to reply_to + + Parameters: + reply_to (To) : An instance of To + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.to import To + except Exception: + from .to import To + + if reply_to is not None and not isinstance(reply_to, To): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reply_to EXPECTED TYPE: To', None, None) + + self.__reply_to = reply_to + self.__key_modified['reply_to'] = 1 + + def get_org_email(self): + """ + The method to get the org_email + + Returns: + bool: A bool representing the org_email + """ + + return self.__org_email + + def set_org_email(self, org_email): + """ + The method to set the value to org_email + + Parameters: + org_email (bool) : A bool representing the org_email + """ + + if org_email is not None and not isinstance(org_email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_email EXPECTED TYPE: bool', None, None) + + self.__org_email = org_email + self.__key_modified['org_email'] = 1 + + def get_scheduled_time(self): + """ + The method to get the scheduled_time + + Returns: + datetime: An instance of datetime + """ + + return self.__scheduled_time + + def set_scheduled_time(self, scheduled_time): + """ + The method to set the value to scheduled_time + + Parameters: + scheduled_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if scheduled_time is not None and not isinstance(scheduled_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduled_time EXPECTED TYPE: datetime', None, None) + + self.__scheduled_time = scheduled_time + self.__key_modified['scheduled_time'] = 1 + + def get_mail_format(self): + """ + The method to get the mail_format + + Returns: + Choice: An instance of Choice + """ + + return self.__mail_format + + def set_mail_format(self, mail_format): + """ + The method to set the value to mail_format + + Parameters: + mail_format (Choice) : An instance of Choice + """ + + if mail_format is not None and not isinstance(mail_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_format EXPECTED TYPE: Choice', None, None) + + self.__mail_format = mail_format + self.__key_modified['mail_format'] = 1 + + def get_consent_email(self): + """ + The method to get the consent_email + + Returns: + bool: A bool representing the consent_email + """ + + return self.__consent_email + + def set_consent_email(self, consent_email): + """ + The method to set the value to consent_email + + Parameters: + consent_email (bool) : A bool representing the consent_email + """ + + if consent_email is not None and not isinstance(consent_email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_email EXPECTED TYPE: bool', None, None) + + self.__consent_email = consent_email + self.__key_modified['consent_email'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_in_reply_to(self): + """ + The method to get the in_reply_to + + Returns: + InReplyTo: An instance of InReplyTo + """ + + return self.__in_reply_to + + def set_in_reply_to(self, in_reply_to): + """ + The method to set the value to in_reply_to + + Parameters: + in_reply_to (InReplyTo) : An instance of InReplyTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.in_reply_to import InReplyTo + except Exception: + from .in_reply_to import InReplyTo + + if in_reply_to is not None and not isinstance(in_reply_to, InReplyTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: in_reply_to EXPECTED TYPE: InReplyTo', None, None) + + self.__in_reply_to = in_reply_to + self.__key_modified['in_reply_to'] = 1 + + def get_template(self): + """ + The method to get the template + + Returns: + Template: An instance of Template + """ + + return self.__template + + def set_template(self, template): + """ + The method to set the value to template + + Parameters: + template (Template) : An instance of Template + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.template import Template + except Exception: + from .template import Template + + if template is not None and not isinstance(template, Template): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: Template', None, None) + + self.__template = template + self.__key_modified['template'] = 1 + + def get_inventory_details(self): + """ + The method to get the inventory_details + + Returns: + InventoryDetails: An instance of InventoryDetails + """ + + return self.__inventory_details + + def set_inventory_details(self, inventory_details): + """ + The method to set the value to inventory_details + + Parameters: + inventory_details (InventoryDetails) : An instance of InventoryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.inventory_details import InventoryDetails + except Exception: + from .inventory_details import InventoryDetails + + if inventory_details is not None and not isinstance(inventory_details, InventoryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_details EXPECTED TYPE: InventoryDetails', None, None) + + self.__inventory_details = inventory_details + self.__key_modified['inventory_details'] = 1 + + def get_data_subject_request(self): + """ + The method to get the data_subject_request + + Returns: + DataSubjectRequest: An instance of DataSubjectRequest + """ + + return self.__data_subject_request + + def set_data_subject_request(self, data_subject_request): + """ + The method to set the value to data_subject_request + + Parameters: + data_subject_request (DataSubjectRequest) : An instance of DataSubjectRequest + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.data_subject_request import DataSubjectRequest + except Exception: + from .data_subject_request import DataSubjectRequest + + if data_subject_request is not None and not isinstance(data_subject_request, DataSubjectRequest): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_subject_request EXPECTED TYPE: DataSubjectRequest', None, None) + + self.__data_subject_request = data_subject_request + self.__key_modified['data_subject_request'] = 1 + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/data_subject_request.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/data_subject_request.py new file mode 100644 index 0000000..5987b13 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/data_subject_request.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataSubjectRequest(object): + def __init__(self): + """Creates an instance of DataSubjectRequest""" + + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/from1.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/from1.py new file mode 100644 index 0000000..9999b7b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/from1.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class From(object): + def __init__(self): + """Creates an instance of From""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/in_reply_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/in_reply_to.py new file mode 100644 index 0000000..e899ab3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/in_reply_to.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InReplyTo(object): + def __init__(self): + """Creates an instance of InReplyTo""" + + self.__message_id = None + self.__owner = None + self.__key_modified = dict() + + def get_message_id(self): + """ + The method to get the message_id + + Returns: + string: A string representing the message_id + """ + + return self.__message_id + + def set_message_id(self, message_id): + """ + The method to set the value to message_id + + Parameters: + message_id (string) : A string representing the message_id + """ + + if message_id is not None and not isinstance(message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message_id EXPECTED TYPE: str', None, None) + + self.__message_id = message_id + self.__key_modified['message_id'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_details.py new file mode 100644 index 0000000..f1fbbcb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_details.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryDetails(object): + def __init__(self): + """Creates an instance of InventoryDetails""" + + self.__inventory_template = None + self.__key_modified = dict() + + def get_inventory_template(self): + """ + The method to get the inventory_template + + Returns: + InventoryTemplate: An instance of InventoryTemplate + """ + + return self.__inventory_template + + def set_inventory_template(self, inventory_template): + """ + The method to set the value to inventory_template + + Parameters: + inventory_template (InventoryTemplate) : An instance of InventoryTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.inventory_template import InventoryTemplate + except Exception: + from .inventory_template import InventoryTemplate + + if inventory_template is not None and not isinstance(inventory_template, InventoryTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_template EXPECTED TYPE: InventoryTemplate', None, None) + + self.__inventory_template = inventory_template + self.__key_modified['inventory_template'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_template.py new file mode 100644 index 0000000..40e4f90 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryTemplate(object): + def __init__(self): + """Creates an instance of InventoryTemplate""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_module.py new file mode 100644 index 0000000..ad76f8f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedModule(object): + def __init__(self): + """Creates an instance of LinkedModule""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_record.py new file mode 100644 index 0000000..8c51f46 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedRecord(object): + def __init__(self): + """Creates an instance of LinkedRecord""" + + self.__module = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + LinkedModule: An instance of LinkedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (LinkedModule) : An instance of LinkedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.linked_module import LinkedModule + except Exception: + from .linked_module import LinkedModule + + if module is not None and not isinstance(module, LinkedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: LinkedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/owner.py new file mode 100644 index 0000000..3a97231 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/send_mail_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/send_mail_operations.py new file mode 100644 index 0000000..c4d3d15 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/send_mail_operations.py @@ -0,0 +1,68 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class SendMailOperations(object): + def __init__(self, id, modulename): + """ + Creates an instance of SendMailOperations with the given parameters + + Parameters: + id (int) : An int representing the id + modulename (string) : A string representing the modulename + """ + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if not isinstance(modulename, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modulename EXPECTED TYPE: str', None, None) + + self.__id = id + self.__modulename = modulename + + + def send_mail(self, request): + """ + The method to send mail + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__modulename) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/send_mail' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/success_response.py new file mode 100644 index 0000000..a961fde --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/template.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/template.py new file mode 100644 index 0000000..2277ba4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/template.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class Template(ABC): + def __init__(self): + """Creates an instance of Template""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/to.py new file mode 100644 index 0000000..dbe309e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/send_mail/to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class To(object): + def __init__(self): + """Creates an instance of To""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/__init__.py new file mode 100644 index 0000000..ddb4f62 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .service_preference import ServicePreference +from .service_preference_operations import ServicePreferenceOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_wrapper.py new file mode 100644 index 0000000..afe8e63 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__service_preferences = None + self.__key_modified = dict() + + def get_service_preferences(self): + """ + The method to get the service_preferences + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__service_preferences + + def set_service_preferences(self, service_preferences): + """ + The method to set the value to service_preferences + + Parameters: + service_preferences (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if service_preferences is not None and not isinstance(service_preferences, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_preferences EXPECTED TYPE: ActionResponse', None, None) + + self.__service_preferences = service_preferences + self.__key_modified['service_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/api_exception.py new file mode 100644 index 0000000..fd61990 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/body_wrapper.py new file mode 100644 index 0000000..0aa37d2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__service_preferences = None + self.__key_modified = dict() + + def get_service_preferences(self): + """ + The method to get the service_preferences + + Returns: + ServicePreference: An instance of ServicePreference + """ + + return self.__service_preferences + + def set_service_preferences(self, service_preferences): + """ + The method to set the value to service_preferences + + Parameters: + service_preferences (ServicePreference) : An instance of ServicePreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.service_preference import ServicePreference + except Exception: + from .service_preference import ServicePreference + + if service_preferences is not None and not isinstance(service_preferences, ServicePreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_preferences EXPECTED TYPE: ServicePreference', None, None) + + self.__service_preferences = service_preferences + self.__key_modified['service_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_wrapper.py new file mode 100644 index 0000000..8d61856 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__service_preferences = None + self.__key_modified = dict() + + def get_service_preferences(self): + """ + The method to get the service_preferences + + Returns: + ServicePreference: An instance of ServicePreference + """ + + return self.__service_preferences + + def set_service_preferences(self, service_preferences): + """ + The method to set the value to service_preferences + + Parameters: + service_preferences (ServicePreference) : An instance of ServicePreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.service_preference import ServicePreference + except Exception: + from .service_preference import ServicePreference + + if service_preferences is not None and not isinstance(service_preferences, ServicePreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_preferences EXPECTED TYPE: ServicePreference', None, None) + + self.__service_preferences = service_preferences + self.__key_modified['service_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference.py new file mode 100644 index 0000000..89ad3a4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ServicePreference(object): + def __init__(self): + """Creates an instance of ServicePreference""" + + self.__job_sheet_enabled = None + self.__key_modified = dict() + + def get_job_sheet_enabled(self): + """ + The method to get the job_sheet_enabled + + Returns: + bool: A bool representing the job_sheet_enabled + """ + + return self.__job_sheet_enabled + + def set_job_sheet_enabled(self, job_sheet_enabled): + """ + The method to set the value to job_sheet_enabled + + Parameters: + job_sheet_enabled (bool) : A bool representing the job_sheet_enabled + """ + + if job_sheet_enabled is not None and not isinstance(job_sheet_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_sheet_enabled EXPECTED TYPE: bool', None, None) + + self.__job_sheet_enabled = job_sheet_enabled + self.__key_modified['job_sheet_enabled'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference_operations.py new file mode 100644 index 0000000..81b8458 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference_operations.py @@ -0,0 +1,72 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class ServicePreferenceOperations(object): + def __init__(self): + """Creates an instance of ServicePreferenceOperations""" + pass + + def get_service_preference(self): + """ + The method to get service preference + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/service_preferences' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_service_preference(self, request): + """ + The method to update service preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/service_preferences' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/success_response.py new file mode 100644 index 0000000..0415309 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/service_preference/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/__init__.py new file mode 100644 index 0000000..09a80e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .dependee import Dependee +from .share_record import ShareRecord +from .delete_action_handler import DeleteActionHandler +from .shared_through import SharedThrough +from .module import Module +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .share_records_operations import ShareRecordsOperations, GetSharedRecordDetailsParam +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .delete_action_wrapper import DeleteActionWrapper +from .action_handler import ActionHandler +from .delete_action_response import DeleteActionResponse diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_wrapper.py new file mode 100644 index 0000000..4d0faf3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/action_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__share = None + self.__notify = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + list: An instance of list + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (list) : An instance of list + """ + + if share is not None and not isinstance(share, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: list', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/api_exception.py new file mode 100644 index 0000000..d17fc09 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.share_records.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_handler import DeleteActionHandler + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_response import DeleteActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .delete_action_handler import DeleteActionHandler + from .action_handler import ActionHandler + from .delete_action_response import DeleteActionResponse + + +class APIException(ResponseHandler, ActionResponse, ActionHandler, DeleteActionResponse, DeleteActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/body_wrapper.py new file mode 100644 index 0000000..80d365a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/body_wrapper.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__share = None + self.__notify_on_completion = None + self.__notify = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + list: An instance of list + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (list) : An instance of list + """ + + if share is not None and not isinstance(share, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: list', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def get_notify_on_completion(self): + """ + The method to get the notify_on_completion + + Returns: + bool: A bool representing the notify_on_completion + """ + + return self.__notify_on_completion + + def set_notify_on_completion(self, notify_on_completion): + """ + The method to set the value to notify_on_completion + + Parameters: + notify_on_completion (bool) : A bool representing the notify_on_completion + """ + + if notify_on_completion is not None and not isinstance(notify_on_completion, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_on_completion EXPECTED TYPE: bool', None, None) + + self.__notify_on_completion = notify_on_completion + self.__key_modified['notify_on_completion'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_handler.py new file mode 100644 index 0000000..3183800 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DeleteActionHandler(ABC): + def __init__(self): + """Creates an instance of DeleteActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_response.py new file mode 100644 index 0000000..5550b68 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DeleteActionResponse(ABC): + def __init__(self): + """Creates an instance of DeleteActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_wrapper.py new file mode 100644 index 0000000..9333f77 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_handler import DeleteActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .delete_action_handler import DeleteActionHandler + + +class DeleteActionWrapper(DeleteActionHandler): + def __init__(self): + """Creates an instance of DeleteActionWrapper""" + super().__init__() + + self.__share = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + DeleteActionResponse: An instance of DeleteActionResponse + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (DeleteActionResponse) : An instance of DeleteActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_response import DeleteActionResponse + except Exception: + from .delete_action_response import DeleteActionResponse + + if share is not None and not isinstance(share, DeleteActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: DeleteActionResponse', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/dependee.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/dependee.py new file mode 100644 index 0000000..4cbcc79 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/dependee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Dependee(object): + def __init__(self): + """Creates an instance of Dependee""" + + self.__json_path = None + self.__api_name = None + self.__key_modified = dict() + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/module.py new file mode 100644 index 0000000..8ebed21 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__name = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/response_wrapper.py new file mode 100644 index 0000000..1773982 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/response_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__share = None + self.__shareable_user = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + list: An instance of list + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (list) : An instance of list + """ + + if share is not None and not isinstance(share, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: list', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def get_shareable_user(self): + """ + The method to get the shareable_user + + Returns: + list: An instance of list + """ + + return self.__shareable_user + + def set_shareable_user(self, shareable_user): + """ + The method to set the value to shareable_user + + Parameters: + shareable_user (list) : An instance of list + """ + + if shareable_user is not None and not isinstance(shareable_user, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shareable_user EXPECTED TYPE: list', None, None) + + self.__shareable_user = shareable_user + self.__key_modified['shareable_user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/share_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/share_record.py new file mode 100644 index 0000000..e4622bd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/share_record.py @@ -0,0 +1,271 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ShareRecord(object): + def __init__(self): + """Creates an instance of ShareRecord""" + + self.__shared_with = None + self.__share_related_records = None + self.__shared_through = None + self.__shared_time = None + self.__permission = None + self.__shared_by = None + self.__user = None + self.__type = None + self.__key_modified = dict() + + def get_shared_with(self): + """ + The method to get the shared_with + + Returns: + Users: An instance of Users + """ + + return self.__shared_with + + def set_shared_with(self, shared_with): + """ + The method to set the value to shared_with + + Parameters: + shared_with (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import Users + except Exception: + from ..users import Users + + if shared_with is not None and not isinstance(shared_with, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_with EXPECTED TYPE: Users', None, None) + + self.__shared_with = shared_with + self.__key_modified['shared_with'] = 1 + + def get_share_related_records(self): + """ + The method to get the share_related_records + + Returns: + bool: A bool representing the share_related_records + """ + + return self.__share_related_records + + def set_share_related_records(self, share_related_records): + """ + The method to set the value to share_related_records + + Parameters: + share_related_records (bool) : A bool representing the share_related_records + """ + + if share_related_records is not None and not isinstance(share_related_records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_related_records EXPECTED TYPE: bool', None, None) + + self.__share_related_records = share_related_records + self.__key_modified['share_related_records'] = 1 + + def get_shared_through(self): + """ + The method to get the shared_through + + Returns: + SharedThrough: An instance of SharedThrough + """ + + return self.__shared_through + + def set_shared_through(self, shared_through): + """ + The method to set the value to shared_through + + Parameters: + shared_through (SharedThrough) : An instance of SharedThrough + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.shared_through import SharedThrough + except Exception: + from .shared_through import SharedThrough + + if shared_through is not None and not isinstance(shared_through, SharedThrough): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_through EXPECTED TYPE: SharedThrough', None, None) + + self.__shared_through = shared_through + self.__key_modified['shared_through'] = 1 + + def get_shared_time(self): + """ + The method to get the shared_time + + Returns: + datetime: An instance of datetime + """ + + return self.__shared_time + + def set_shared_time(self, shared_time): + """ + The method to set the value to shared_time + + Parameters: + shared_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if shared_time is not None and not isinstance(shared_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_time EXPECTED TYPE: datetime', None, None) + + self.__shared_time = shared_time + self.__key_modified['shared_time'] = 1 + + def get_permission(self): + """ + The method to get the permission + + Returns: + string: A string representing the permission + """ + + return self.__permission + + def set_permission(self, permission): + """ + The method to set the value to permission + + Parameters: + permission (string) : A string representing the permission + """ + + if permission is not None and not isinstance(permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission EXPECTED TYPE: str', None, None) + + self.__permission = permission + self.__key_modified['permission'] = 1 + + def get_shared_by(self): + """ + The method to get the shared_by + + Returns: + Users: An instance of Users + """ + + return self.__shared_by + + def set_shared_by(self, shared_by): + """ + The method to set the value to shared_by + + Parameters: + shared_by (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import Users + except Exception: + from ..users import Users + + if shared_by is not None and not isinstance(shared_by, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_by EXPECTED TYPE: Users', None, None) + + self.__shared_by = shared_by + self.__key_modified['shared_by'] = 1 + + def get_user(self): + """ + The method to get the user + + Returns: + Users: An instance of Users + """ + + return self.__user + + def set_user(self, user): + """ + The method to set the value to user + + Parameters: + user (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import Users + except Exception: + from ..users import Users + + if user is not None and not isinstance(user, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: Users', None, None) + + self.__user = user + self.__key_modified['user'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/share_records_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/share_records_operations.py new file mode 100644 index 0000000..8be9d07 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/share_records_operations.py @@ -0,0 +1,182 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class ShareRecordsOperations(object): + def __init__(self, record_id, module_api_name): + """ + Creates an instance of ShareRecordsOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module_api_name = module_api_name + + + def get_shared_record_details(self, param_instance=None): + """ + The method to get shared record details + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + 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/share' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def share_record(self, request): + """ + The method to share record + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + 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/share' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_share_permissions(self, request): + """ + The method to update share permissions + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + 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/share' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def revoke_shared_record(self): + """ + The method to revoke shared record + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + 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/share' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_handler import DeleteActionHandler + except Exception: + from .delete_action_handler import DeleteActionHandler + return handler_instance.api_call(DeleteActionHandler.__module__, 'application/json') + + +class GetSharedRecordDetailsParam(object): + sharedto = Param('sharedTo', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam') + view = Param('view', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/shared_through.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/shared_through.py new file mode 100644 index 0000000..35a7337 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/shared_through.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SharedThrough(object): + def __init__(self): + """Creates an instance of SharedThrough""" + + self.__module = None + self.__id = None + self.__entity_name = None + self.__name = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_entity_name(self): + """ + The method to get the entity_name + + Returns: + string: A string representing the entity_name + """ + + return self.__entity_name + + def set_entity_name(self, entity_name): + """ + The method to set the value to entity_name + + Parameters: + entity_name (string) : A string representing the entity_name + """ + + if entity_name is not None and not isinstance(entity_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: entity_name EXPECTED TYPE: str', None, None) + + self.__entity_name = entity_name + self.__key_modified['entity_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/success_response.py new file mode 100644 index 0000000..13165a3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/share_records/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_response import DeleteActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .delete_action_response import DeleteActionResponse + + +class SuccessResponse(ActionResponse, DeleteActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/__init__.py new file mode 100644 index 0000000..6be5346 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/__init__.py @@ -0,0 +1,18 @@ +from .shift_count import ShiftCount +from .shift_custom_timing import ShiftCustomTiming +from .action_wrapper import ActionWrapper +from .role import Role +from .body_wrapper import BodyWrapper +from .shift_hours import ShiftHours +from .users import Users +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .holidays import Holidays +from .success_response import SuccessResponse +from .break_hours import BreakHours +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .mandatory_details import MandatoryDetails +from .shift_hours_operations import ShiftHoursOperations, GetShiftHoursHeader, CreateShiftsHoursHeader, UpdateShiftHoursHeader, GetShiftHourHeader, UpdateShiftHourHeader, DeleteShiftHourHeader +from .break_custom_timing import BreakCustomTiming diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_wrapper.py new file mode 100644 index 0000000..5e5d914 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__shift_hours = None + self.__key_modified = dict() + + def get_shift_hours(self): + """ + The method to get the shift_hours + + Returns: + list: An instance of list + """ + + return self.__shift_hours + + def set_shift_hours(self, shift_hours): + """ + The method to set the value to shift_hours + + Parameters: + shift_hours (list) : An instance of list + """ + + if shift_hours is not None and not isinstance(shift_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hours EXPECTED TYPE: list', None, None) + + self.__shift_hours = shift_hours + self.__key_modified['shift_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/api_exception.py new file mode 100644 index 0000000..701f1f2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/body_wrapper.py new file mode 100644 index 0000000..2f468ef --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__shift_hours = None + self.__key_modified = dict() + + def get_shift_hours(self): + """ + The method to get the shift_hours + + Returns: + list: An instance of list + """ + + return self.__shift_hours + + def set_shift_hours(self, shift_hours): + """ + The method to set the value to shift_hours + + Parameters: + shift_hours (list) : An instance of list + """ + + if shift_hours is not None and not isinstance(shift_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hours EXPECTED TYPE: list', None, None) + + self.__shift_hours = shift_hours + self.__key_modified['shift_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_custom_timing.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_custom_timing.py new file mode 100644 index 0000000..4d3971f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_custom_timing.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BreakCustomTiming(object): + def __init__(self): + """Creates an instance of BreakCustomTiming""" + + self.__days = None + self.__break_timing = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + string: A string representing the days + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (string) : A string representing the days + """ + + if days is not None and not isinstance(days, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: str', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_break_timing(self): + """ + The method to get the break_timing + + Returns: + list: An instance of list + """ + + return self.__break_timing + + def set_break_timing(self, break_timing): + """ + The method to set the value to break_timing + + Parameters: + break_timing (list) : An instance of list + """ + + if break_timing is not None and not isinstance(break_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: break_timing EXPECTED TYPE: list', None, None) + + self.__break_timing = break_timing + self.__key_modified['break_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_hours.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_hours.py new file mode 100644 index 0000000..d0ccdb5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_hours.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BreakHours(object): + def __init__(self): + """Creates an instance of BreakHours""" + + self.__break_days = None + self.__same_as_everyday = None + self.__daily_timing = None + self.__custom_timing = None + self.__id = None + self.__key_modified = dict() + + def get_break_days(self): + """ + The method to get the break_days + + Returns: + list: An instance of list + """ + + return self.__break_days + + def set_break_days(self, break_days): + """ + The method to set the value to break_days + + Parameters: + break_days (list) : An instance of list + """ + + if break_days is not None and not isinstance(break_days, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: break_days EXPECTED TYPE: list', None, None) + + self.__break_days = break_days + self.__key_modified['break_days'] = 1 + + def get_same_as_everyday(self): + """ + The method to get the same_as_everyday + + Returns: + bool: A bool representing the same_as_everyday + """ + + return self.__same_as_everyday + + def set_same_as_everyday(self, same_as_everyday): + """ + The method to set the value to same_as_everyday + + Parameters: + same_as_everyday (bool) : A bool representing the same_as_everyday + """ + + if same_as_everyday is not None and not isinstance(same_as_everyday, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: same_as_everyday EXPECTED TYPE: bool', None, None) + + self.__same_as_everyday = same_as_everyday + self.__key_modified['same_as_everyday'] = 1 + + def get_daily_timing(self): + """ + The method to get the daily_timing + + Returns: + list: An instance of list + """ + + return self.__daily_timing + + def set_daily_timing(self, daily_timing): + """ + The method to set the value to daily_timing + + Parameters: + daily_timing (list) : An instance of list + """ + + if daily_timing is not None and not isinstance(daily_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: daily_timing EXPECTED TYPE: list', None, None) + + self.__daily_timing = daily_timing + self.__key_modified['daily_timing'] = 1 + + def get_custom_timing(self): + """ + The method to get the custom_timing + + Returns: + list: An instance of list + """ + + return self.__custom_timing + + def set_custom_timing(self, custom_timing): + """ + The method to set the value to custom_timing + + Parameters: + custom_timing (list) : An instance of list + """ + + if custom_timing is not None and not isinstance(custom_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_timing EXPECTED TYPE: list', None, None) + + self.__custom_timing = custom_timing + self.__key_modified['custom_timing'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/holidays.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/holidays.py new file mode 100644 index 0000000..cba10cd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/holidays.py @@ -0,0 +1,151 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Holidays(object): + def __init__(self): + """Creates an instance of Holidays""" + + self.__date = None + self.__year = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_year(self): + """ + The method to get the year + + Returns: + int: An int representing the year + """ + + return self.__year + + def set_year(self, year): + """ + The method to set the value to year + + Parameters: + year (int) : An int representing the year + """ + + if year is not None and not isinstance(year, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: year EXPECTED TYPE: int', None, None) + + self.__year = year + self.__key_modified['year'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/mandatory_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/mandatory_details.py new file mode 100644 index 0000000..6ee3c77 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/mandatory_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MandatoryDetails(object): + def __init__(self): + """Creates an instance of MandatoryDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_wrapper.py new file mode 100644 index 0000000..0acdf2f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__shift_hours = None + self.__shift_count = None + self.__key_modified = dict() + + def get_shift_hours(self): + """ + The method to get the shift_hours + + Returns: + list: An instance of list + """ + + return self.__shift_hours + + def set_shift_hours(self, shift_hours): + """ + The method to set the value to shift_hours + + Parameters: + shift_hours (list) : An instance of list + """ + + if shift_hours is not None and not isinstance(shift_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hours EXPECTED TYPE: list', None, None) + + self.__shift_hours = shift_hours + self.__key_modified['shift_hours'] = 1 + + def get_shift_count(self): + """ + The method to get the shift_count + + Returns: + ShiftCount: An instance of ShiftCount + """ + + return self.__shift_count + + def set_shift_count(self, shift_count): + """ + The method to set the value to shift_count + + Parameters: + shift_count (ShiftCount) : An instance of ShiftCount + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.shift_count import ShiftCount + except Exception: + from .shift_count import ShiftCount + + if shift_count is not None and not isinstance(shift_count, ShiftCount): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_count EXPECTED TYPE: ShiftCount', None, None) + + self.__shift_count = shift_count + self.__key_modified['shift_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/role.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/role.py new file mode 100644 index 0000000..bba4d98 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/role.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Role(object): + def __init__(self): + """Creates an instance of Role""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_count.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_count.py new file mode 100644 index 0000000..8c4a9fe --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_count.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftCount(object): + def __init__(self): + """Creates an instance of ShiftCount""" + + self.__total_shift_with_user = None + self.__total_shift = None + self.__key_modified = dict() + + def get_total_shift_with_user(self): + """ + The method to get the total_shift_with_user + + Returns: + int: An int representing the total_shift_with_user + """ + + return self.__total_shift_with_user + + def set_total_shift_with_user(self, total_shift_with_user): + """ + The method to set the value to total_shift_with_user + + Parameters: + total_shift_with_user (int) : An int representing the total_shift_with_user + """ + + if total_shift_with_user is not None and not isinstance(total_shift_with_user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_shift_with_user EXPECTED TYPE: int', None, None) + + self.__total_shift_with_user = total_shift_with_user + self.__key_modified['total_shift_with_user'] = 1 + + def get_total_shift(self): + """ + The method to get the total_shift + + Returns: + int: An int representing the total_shift + """ + + return self.__total_shift + + def set_total_shift(self, total_shift): + """ + The method to set the value to total_shift + + Parameters: + total_shift (int) : An int representing the total_shift + """ + + if total_shift is not None and not isinstance(total_shift, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_shift EXPECTED TYPE: int', None, None) + + self.__total_shift = total_shift + self.__key_modified['total_shift'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_custom_timing.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_custom_timing.py new file mode 100644 index 0000000..d059e52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_custom_timing.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftCustomTiming(object): + def __init__(self): + """Creates an instance of ShiftCustomTiming""" + + self.__days = None + self.__shift_timing = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + string: A string representing the days + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (string) : A string representing the days + """ + + if days is not None and not isinstance(days, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: str', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_shift_timing(self): + """ + The method to get the shift_timing + + Returns: + list: An instance of list + """ + + return self.__shift_timing + + def set_shift_timing(self, shift_timing): + """ + The method to set the value to shift_timing + + Parameters: + shift_timing (list) : An instance of list + """ + + if shift_timing is not None and not isinstance(shift_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_timing EXPECTED TYPE: list', None, None) + + self.__shift_timing = shift_timing + self.__key_modified['shift_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours.py new file mode 100644 index 0000000..2baf6f7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours.py @@ -0,0 +1,321 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftHours(object): + def __init__(self): + """Creates an instance of ShiftHours""" + + self.__same_as_everyday = None + self.__shift_days = None + self.__daily_timing = None + self.__custom_timing = None + self.__id = None + self.__break_hours = None + self.__users = None + self.__holidays = None + self.__users_count = None + self.__timezone = None + self.__name = None + self.__key_modified = dict() + + def get_same_as_everyday(self): + """ + The method to get the same_as_everyday + + Returns: + bool: A bool representing the same_as_everyday + """ + + return self.__same_as_everyday + + def set_same_as_everyday(self, same_as_everyday): + """ + The method to set the value to same_as_everyday + + Parameters: + same_as_everyday (bool) : A bool representing the same_as_everyday + """ + + if same_as_everyday is not None and not isinstance(same_as_everyday, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: same_as_everyday EXPECTED TYPE: bool', None, None) + + self.__same_as_everyday = same_as_everyday + self.__key_modified['same_as_everyday'] = 1 + + def get_shift_days(self): + """ + The method to get the shift_days + + Returns: + list: An instance of list + """ + + return self.__shift_days + + def set_shift_days(self, shift_days): + """ + The method to set the value to shift_days + + Parameters: + shift_days (list) : An instance of list + """ + + if shift_days is not None and not isinstance(shift_days, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_days EXPECTED TYPE: list', None, None) + + self.__shift_days = shift_days + self.__key_modified['shift_days'] = 1 + + def get_daily_timing(self): + """ + The method to get the daily_timing + + Returns: + list: An instance of list + """ + + return self.__daily_timing + + def set_daily_timing(self, daily_timing): + """ + The method to set the value to daily_timing + + Parameters: + daily_timing (list) : An instance of list + """ + + if daily_timing is not None and not isinstance(daily_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: daily_timing EXPECTED TYPE: list', None, None) + + self.__daily_timing = daily_timing + self.__key_modified['daily_timing'] = 1 + + def get_custom_timing(self): + """ + The method to get the custom_timing + + Returns: + list: An instance of list + """ + + return self.__custom_timing + + def set_custom_timing(self, custom_timing): + """ + The method to set the value to custom_timing + + Parameters: + custom_timing (list) : An instance of list + """ + + if custom_timing is not None and not isinstance(custom_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_timing EXPECTED TYPE: list', None, None) + + self.__custom_timing = custom_timing + self.__key_modified['custom_timing'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_break_hours(self): + """ + The method to get the break_hours + + Returns: + list: An instance of list + """ + + return self.__break_hours + + def set_break_hours(self, break_hours): + """ + The method to set the value to break_hours + + Parameters: + break_hours (list) : An instance of list + """ + + if break_hours is not None and not isinstance(break_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: break_hours EXPECTED TYPE: list', None, None) + + self.__break_hours = break_hours + self.__key_modified['break_hours'] = 1 + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def get_users_count(self): + """ + The method to get the users_count + + Returns: + int: An int representing the users_count + """ + + return self.__users_count + + def set_users_count(self, users_count): + """ + The method to set the value to users_count + + Parameters: + users_count (int) : An int representing the users_count + """ + + if users_count is not None and not isinstance(users_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_count EXPECTED TYPE: int', None, None) + + self.__users_count = users_count + self.__key_modified['users_count'] = 1 + + def get_timezone(self): + """ + The method to get the timezone + + Returns: + string: An instance of string + """ + + return self.__timezone + + def set_timezone(self, timezone): + """ + The method to set the value to timezone + + Parameters: + timezone (string) : An instance of string + """ + + self.__timezone = timezone + self.__key_modified['timezone'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours_operations.py new file mode 100644 index 0000000..a83333c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours_operations.py @@ -0,0 +1,253 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class ShiftHoursOperations(object): + def __init__(self, x_crm_org=None): + """ + Creates an instance of ShiftHoursOperations with the given parameters + + Parameters: + x_crm_org (string) : A string representing the x_crm_org + """ + + if x_crm_org is not None and not isinstance(x_crm_org, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_crm_org EXPECTED TYPE: str', None, None) + + self.__x_crm_org = x_crm_org + + + def get_shift_hours(self): + """ + The method to get shift hours + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours/shift_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.GetShiftHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_shifts_hours(self, request): + """ + The method to create shifts hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours/shift_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.CreateShiftsHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_shift_hours(self, request): + """ + The method to update shift hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours/shift_hours' + 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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.UpdateShiftHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_shift_hour(self, shift_id): + """ + The method to get shift hour + + Parameters: + shift_id (int) : An int representing the shift_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(shift_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours/shift_hours/' + api_path = api_path + str(shift_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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.GetShiftHourHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_shift_hour(self, shift_id, request): + """ + The method to update shift hour + + Parameters: + shift_id (int) : An int representing the shift_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(shift_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_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/v7/settings/business_hours/shift_hours/' + api_path = api_path + str(shift_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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.UpdateShiftHourHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_shift_hour(self, shift_id): + """ + The method to delete shift hour + + Parameters: + shift_id (int) : An int representing the shift_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(shift_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours/shift_hours/' + api_path = api_path + str(shift_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.DeleteShiftHourHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetShiftHoursHeader(object): + pass + + +class CreateShiftsHoursHeader(object): + pass + + +class UpdateShiftHoursHeader(object): + pass + + +class GetShiftHourHeader(object): + pass + + +class UpdateShiftHourHeader(object): + pass + + +class DeleteShiftHourHeader(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/success_response.py new file mode 100644 index 0000000..1d93c4c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/users.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/users.py new file mode 100644 index 0000000..e604e26 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/shift_hours/users.py @@ -0,0 +1,206 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Users(object): + def __init__(self): + """Creates an instance of Users""" + + self.__role = None + self.__name = None + self.__id = None + self.__email = None + self.__zuid = None + self.__effective_from = None + self.__key_modified = dict() + + def get_role(self): + """ + The method to get the role + + Returns: + Role: An instance of Role + """ + + return self.__role + + def set_role(self, role): + """ + The method to set the value to role + + Parameters: + role (Role) : An instance of Role + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.role import Role + except Exception: + from .role import Role + + if role is not None and not isinstance(role, Role): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role EXPECTED TYPE: Role', None, None) + + self.__role = role + self.__key_modified['role'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def get_effective_from(self): + """ + The method to get the effective_from + + Returns: + date: An instance of date + """ + + return self.__effective_from + + def set_effective_from(self, effective_from): + """ + The method to set the value to effective_from + + Parameters: + effective_from (date) : An instance of date + """ + + from datetime import date as date1 + + if effective_from is not None and not isinstance(effective_from, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: effective_from EXPECTED TYPE: date1', None, None) + + self.__effective_from = effective_from + self.__key_modified['effective_from'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/__init__.py new file mode 100644 index 0000000..b4ffa2e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/__init__.py @@ -0,0 +1,26 @@ +from .count_response_wrapper import CountResponseWrapper +from .record_detail_tag import RecordDetailTag +from .tags_operations import TagsOperations, GetTagsParam, CreateTagsParam, UpdateTagsParam, UpdateTagParam, AddTagsParam, AddTagsToMultipleRecordsParam, RemoveTagsFromMultipleRecordsParam, GetRecordCountForTagParam +from .existing_tag import ExistingTag +from .new_tag_request_wrapper import NewTagRequestWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .record_success_response import RecordSuccessResponse +from .action_handler import ActionHandler +from .tag import Tag +from .associated_places import AssociatedPlaces +from .info import Info +from .action_wrapper import ActionWrapper +from .merge_wrapper import MergeWrapper +from .record_action_wrapper import RecordActionWrapper +from .resources import Resources +from .body_wrapper import BodyWrapper +from .record_action_handler import RecordActionHandler +from .existing_tag_request_wrapper import ExistingTagRequestWrapper +from .conflict_wrapper import ConflictWrapper +from .response_wrapper import ResponseWrapper +from .record_action_response import RecordActionResponse +from .success_wrapper import SuccessWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_wrapper.py new file mode 100644 index 0000000..713fc4d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/api_exception.py new file mode 100644 index 0000000..a43507c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_response import RecordActionResponse + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + from .record_action_response import RecordActionResponse + from .record_action_handler import RecordActionHandler + + +class APIException(ActionResponse, RecordActionResponse, ResponseHandler, ActionHandler, RecordActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/associated_places.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/associated_places.py new file mode 100644 index 0000000..e3fd0e1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/associated_places.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedPlaces(object): + def __init__(self): + """Creates an instance of AssociatedPlaces""" + + self.__type = None + self.__resources = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/body_wrapper.py new file mode 100644 index 0000000..c1de2c4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/conflict_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/conflict_wrapper.py new file mode 100644 index 0000000..415f22c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/conflict_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConflictWrapper(object): + def __init__(self): + """Creates an instance of ConflictWrapper""" + + self.__conflict_id = None + self.__key_modified = dict() + + def get_conflict_id(self): + """ + The method to get the conflict_id + + Returns: + string: A string representing the conflict_id + """ + + return self.__conflict_id + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/count_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/count_response_wrapper.py new file mode 100644 index 0000000..bb72950 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/count_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class CountResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of CountResponseWrapper""" + super().__init__() + + self.__count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + string: A string representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (string) : A string representing the count + """ + + if count is not None and not isinstance(count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: str', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/error_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag.py new file mode 100644 index 0000000..c78c1a4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExistingTag(object): + def __init__(self): + """Creates an instance of ExistingTag""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag_request_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag_request_wrapper.py new file mode 100644 index 0000000..f0201bc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag_request_wrapper.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExistingTagRequestWrapper(object): + def __init__(self): + """Creates an instance of ExistingTagRequestWrapper""" + + self.__tags = None + self.__ids = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/info.py new file mode 100644 index 0000000..1d3e270 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/info.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__allowed_count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_allowed_count(self): + """ + The method to get the allowed_count + + Returns: + int: An int representing the allowed_count + """ + + return self.__allowed_count + + def set_allowed_count(self, allowed_count): + """ + The method to set the value to allowed_count + + Parameters: + allowed_count (int) : An int representing the allowed_count + """ + + if allowed_count is not None and not isinstance(allowed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_count EXPECTED TYPE: int', None, None) + + self.__allowed_count = allowed_count + self.__key_modified['allowed_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/merge_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/merge_wrapper.py new file mode 100644 index 0000000..1f34624 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MergeWrapper(object): + def __init__(self): + """Creates an instance of MergeWrapper""" + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/new_tag_request_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/new_tag_request_wrapper.py new file mode 100644 index 0000000..37f16d7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/new_tag_request_wrapper.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NewTagRequestWrapper(object): + def __init__(self): + """Creates an instance of NewTagRequestWrapper""" + + self.__tags = None + self.__over_write = None + self.__ids = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_over_write(self): + """ + The method to get the over_write + + Returns: + bool: A bool representing the over_write + """ + + return self.__over_write + + def set_over_write(self, over_write): + """ + The method to set the value to over_write + + Parameters: + over_write (bool) : A bool representing the over_write + """ + + if over_write is not None and not isinstance(over_write, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: over_write EXPECTED TYPE: bool', None, None) + + self.__over_write = over_write + self.__key_modified['over_write'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_handler.py new file mode 100644 index 0000000..e711e65 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class RecordActionHandler(ABC): + def __init__(self): + """Creates an instance of RecordActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_response.py new file mode 100644 index 0000000..bee98ec --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class RecordActionResponse(ABC): + def __init__(self): + """Creates an instance of RecordActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_wrapper.py new file mode 100644 index 0000000..a0401a4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_wrapper.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record_action_handler import RecordActionHandler + + +class RecordActionWrapper(RecordActionHandler): + def __init__(self): + """Creates an instance of RecordActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + self.__wf_scheduler = None + self.__success_count = None + self.__locked_count = None + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification + + def get_wf_scheduler(self): + """ + The method to get the wf_scheduler + + Returns: + bool: A bool representing the wf_scheduler + """ + + return self.__wf_scheduler + + def set_wf_scheduler(self, wf_scheduler): + """ + The method to set the value to wf_scheduler + + Parameters: + wf_scheduler (bool) : A bool representing the wf_scheduler + """ + + if wf_scheduler is not None and not isinstance(wf_scheduler, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wf_scheduler EXPECTED TYPE: bool', None, None) + + self.__wf_scheduler = wf_scheduler + self.__key_modified['wf_scheduler'] = 1 + + def get_success_count(self): + """ + The method to get the success_count + + Returns: + string: A string representing the success_count + """ + + return self.__success_count + + def set_success_count(self, success_count): + """ + The method to set the value to success_count + + Parameters: + success_count (string) : A string representing the success_count + """ + + if success_count is not None and not isinstance(success_count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: success_count EXPECTED TYPE: str', None, None) + + self.__success_count = success_count + self.__key_modified['success_count'] = 1 + + def get_locked_count(self): + """ + The method to get the locked_count + + Returns: + string: A string representing the locked_count + """ + + return self.__locked_count + + def set_locked_count(self, locked_count): + """ + The method to set the value to locked_count + + Parameters: + locked_count (string) : A string representing the locked_count + """ + + if locked_count is not None and not isinstance(locked_count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_count EXPECTED TYPE: str', None, None) + + self.__locked_count = locked_count + self.__key_modified['locked_count'] = 1 diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_detail_tag.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_detail_tag.py new file mode 100644 index 0000000..d7fb174 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_detail_tag.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RecordDetailTag(object): + def __init__(self): + """Creates an instance of RecordDetailTag""" + + self.__id = None + self.__name = None + self.__color_code = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_color_code(self): + """ + The method to get the color_code + + Returns: + string: A string representing the color_code + """ + + return self.__color_code + + def set_color_code(self, color_code): + """ + The method to set the value to color_code + + Parameters: + color_code (string) : A string representing the color_code + """ + + if color_code is not None and not isinstance(color_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: str', None, None) + + self.__color_code = color_code + self.__key_modified['color_code'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_success_response.py new file mode 100644 index 0000000..abca4e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/record_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_response import RecordActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .record_action_response import RecordActionResponse + + +class RecordSuccessResponse(RecordActionResponse): + def __init__(self): + """Creates an instance of RecordSuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/resources.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/resources.py new file mode 100644 index 0000000..71aea97 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/resources.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resources(object): + def __init__(self): + """Creates an instance of Resources""" + + self.__name = None + self.__id = None + self.__details = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/response_wrapper.py new file mode 100644 index 0000000..44c0722 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__tags = None + self.__info = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/success_response.py new file mode 100644 index 0000000..e5b21c6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/success_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/success_wrapper.py new file mode 100644 index 0000000..fabbe2f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/success_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class SuccessWrapper(ActionHandler): + def __init__(self): + """Creates an instance of SuccessWrapper""" + super().__init__() + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/tag.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/tag.py new file mode 100644 index 0000000..9984242 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/tag.py @@ -0,0 +1,238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Tag(object): + def __init__(self): + """Creates an instance of Tag""" + + self.__name = None + self.__color_code = None + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__created_by = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_color_code(self): + """ + The method to get the color_code + + Returns: + Choice: An instance of Choice + """ + + return self.__color_code + + def set_color_code(self, color_code): + """ + The method to set the value to color_code + + Parameters: + color_code (Choice) : An instance of Choice + """ + + if color_code is not None and not isinstance(color_code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: Choice', None, None) + + self.__color_code = color_code + self.__key_modified['color_code'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/tags_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/tags_operations.py new file mode 100644 index 0000000..ba1b111 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/tags/tags_operations.py @@ -0,0 +1,556 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class TagsOperations(object): + def __init__(self): + """Creates an instance of TagsOperations""" + pass + + def get_tags(self, param_instance=None): + """ + The method to get tags + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_tags(self, request, param_instance=None): + """ + The method to create tags + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_tags(self, request, param_instance=None): + """ + The method to update tags + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/tags' + 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.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_tag(self, id, request, param_instance=None): + """ + The method to update tag + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + 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/v7/settings/tags/' + api_path = api_path + str(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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_tag(self, id): + """ + The method to delete tag + + 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/v7/settings/tags/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def merge_tags(self, id, request): + """ + The method to merge tags + + Parameters: + id (int) : An int representing the id + request (MergeWrapper) : An instance of MergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.merge_wrapper import MergeWrapper + except Exception: + from .merge_wrapper import MergeWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, MergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/tags/' + api_path = api_path + str(id) + api_path = api_path + '/actions/merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def add_tags(self, record_id, module_api_name, request, param_instance=None): + """ + The method to add tags + + Parameters: + record_id (int) : An int representing the record_id + module_api_name (string) : A string representing the module_api_name + request (NewTagRequestWrapper) : An instance of NewTagRequestWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.new_tag_request_wrapper import NewTagRequestWrapper + except Exception: + from .new_tag_request_wrapper import NewTagRequestWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, NewTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: NewTagRequestWrapper', None, None) + + 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/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/actions/add_tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def remove_tags(self, record_id, module_api_name, request): + """ + The method to remove tags + + Parameters: + record_id (int) : An int representing the record_id + module_api_name (string) : A string representing the module_api_name + request (ExistingTagRequestWrapper) : An instance of ExistingTagRequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.existing_tag_request_wrapper import ExistingTagRequestWrapper + except Exception: + from .existing_tag_request_wrapper import ExistingTagRequestWrapper + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, ExistingTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ExistingTagRequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/actions/remove_tags' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def add_tags_to_multiple_records(self, module_api_name, request, param_instance=None): + """ + The method to add tags to multiple records + + Parameters: + module_api_name (string) : A string representing the module_api_name + request (NewTagRequestWrapper) : An instance of NewTagRequestWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.new_tag_request_wrapper import NewTagRequestWrapper + except Exception: + from .new_tag_request_wrapper import NewTagRequestWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, NewTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: NewTagRequestWrapper', None, None) + + 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/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/actions/add_tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def remove_tags_from_multiple_records(self, module_api_name, request, param_instance=None): + """ + The method to remove tags from multiple records + + Parameters: + module_api_name (string) : A string representing the module_api_name + request (ExistingTagRequestWrapper) : An instance of ExistingTagRequestWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.existing_tag_request_wrapper import ExistingTagRequestWrapper + except Exception: + from .existing_tag_request_wrapper import ExistingTagRequestWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, ExistingTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ExistingTagRequestWrapper', None, None) + + 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/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/actions/remove_tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def get_record_count_for_tag(self, id, param_instance=None): + """ + The method to get record count for tag + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/tags/' + api_path = api_path + str(id) + api_path = api_path + '/actions/records_count' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetTagsParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.GetTagsParam') + my_tags = Param('my_tags', 'com.zoho.crm.api.Tags.GetTagsParam') + include = Param('include', 'com.zoho.crm.api.Tags.GetTagsParam') + + +class CreateTagsParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.CreateTagsParam') + + +class UpdateTagsParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.UpdateTagsParam') + + +class UpdateTagParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.UpdateTagParam') + + +class AddTagsParam(object): + over_write = Param('over_write', 'com.zoho.crm.api.Tags.AddTagsParam') + + +class AddTagsToMultipleRecordsParam(object): + over_write = Param('over_write', 'com.zoho.crm.api.Tags.AddTagsToMultipleRecordsParam') + + +class RemoveTagsFromMultipleRecordsParam(object): + ids = Param('ids', 'com.zoho.crm.api.Tags.RemoveTagsFromMultipleRecordsParam') + + +class GetRecordCountForTagParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.GetRecordCountForTagParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/__init__.py new file mode 100644 index 0000000..f9e185b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/__init__.py @@ -0,0 +1,13 @@ +from .action_wrapper import ActionWrapper +from .org_tax import OrgTax +from .preference import Preference +from .body_wrapper import BodyWrapper +from .tax import Tax +from .expected_field import ExpectedField +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .taxes_operations import TaxesOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_wrapper.py new file mode 100644 index 0000000..8c12505 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__org_taxes = None + self.__key_modified = dict() + + def get_org_taxes(self): + """ + The method to get the org_taxes + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__org_taxes + + def set_org_taxes(self, org_taxes): + """ + The method to set the value to org_taxes + + Parameters: + org_taxes (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if org_taxes is not None and not isinstance(org_taxes, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_taxes EXPECTED TYPE: ActionResponse', None, None) + + self.__org_taxes = org_taxes + self.__key_modified['org_taxes'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/api_exception.py new file mode 100644 index 0000000..8cfd7f8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/body_wrapper.py new file mode 100644 index 0000000..4697356 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__org_taxes = None + self.__key_modified = dict() + + def get_org_taxes(self): + """ + The method to get the org_taxes + + Returns: + OrgTax: An instance of OrgTax + """ + + return self.__org_taxes + + def set_org_taxes(self, org_taxes): + """ + The method to set the value to org_taxes + + Parameters: + org_taxes (OrgTax) : An instance of OrgTax + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.org_tax import OrgTax + except Exception: + from .org_tax import OrgTax + + if org_taxes is not None and not isinstance(org_taxes, OrgTax): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_taxes EXPECTED TYPE: OrgTax', None, None) + + self.__org_taxes = org_taxes + self.__key_modified['org_taxes'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/expected_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/expected_field.py new file mode 100644 index 0000000..f7bbab1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/expected_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExpectedField(object): + def __init__(self): + """Creates an instance of ExpectedField""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/org_tax.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/org_tax.py new file mode 100644 index 0000000..7909bdb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/org_tax.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OrgTax(object): + def __init__(self): + """Creates an instance of OrgTax""" + + self.__taxes = None + self.__preference = None + self.__key_modified = dict() + + def get_taxes(self): + """ + The method to get the taxes + + Returns: + list: An instance of list + """ + + return self.__taxes + + def set_taxes(self, taxes): + """ + The method to set the value to taxes + + Parameters: + taxes (list) : An instance of list + """ + + if taxes is not None and not isinstance(taxes, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: taxes EXPECTED TYPE: list', None, None) + + self.__taxes = taxes + self.__key_modified['taxes'] = 1 + + def get_preference(self): + """ + The method to get the preference + + Returns: + Preference: An instance of Preference + """ + + return self.__preference + + def set_preference(self, preference): + """ + The method to set the value to preference + + Parameters: + preference (Preference) : An instance of Preference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.preference import Preference + except Exception: + from .preference import Preference + + if preference is not None and not isinstance(preference, Preference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preference EXPECTED TYPE: Preference', None, None) + + self.__preference = preference + self.__key_modified['preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/preference.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/preference.py new file mode 100644 index 0000000..ea438a9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/preference.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Preference(object): + def __init__(self): + """Creates an instance of Preference""" + + self.__auto_populate_tax = None + self.__modify_tax_rates = None + self.__key_modified = dict() + + def get_auto_populate_tax(self): + """ + The method to get the auto_populate_tax + + Returns: + bool: A bool representing the auto_populate_tax + """ + + return self.__auto_populate_tax + + def set_auto_populate_tax(self, auto_populate_tax): + """ + The method to set the value to auto_populate_tax + + Parameters: + auto_populate_tax (bool) : A bool representing the auto_populate_tax + """ + + if auto_populate_tax is not None and not isinstance(auto_populate_tax, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_populate_tax EXPECTED TYPE: bool', None, None) + + self.__auto_populate_tax = auto_populate_tax + self.__key_modified['auto_populate_tax'] = 1 + + def get_modify_tax_rates(self): + """ + The method to get the modify_tax_rates + + Returns: + bool: A bool representing the modify_tax_rates + """ + + return self.__modify_tax_rates + + def set_modify_tax_rates(self, modify_tax_rates): + """ + The method to set the value to modify_tax_rates + + Parameters: + modify_tax_rates (bool) : A bool representing the modify_tax_rates + """ + + if modify_tax_rates is not None and not isinstance(modify_tax_rates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modify_tax_rates EXPECTED TYPE: bool', None, None) + + self.__modify_tax_rates = modify_tax_rates + self.__key_modified['modify_tax_rates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/response_wrapper.py new file mode 100644 index 0000000..ec33fe8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__org_taxes = None + self.__key_modified = dict() + + def get_org_taxes(self): + """ + The method to get the org_taxes + + Returns: + OrgTax: An instance of OrgTax + """ + + return self.__org_taxes + + def set_org_taxes(self, org_taxes): + """ + The method to set the value to org_taxes + + Parameters: + org_taxes (OrgTax) : An instance of OrgTax + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.org_tax import OrgTax + except Exception: + from .org_tax import OrgTax + + if org_taxes is not None and not isinstance(org_taxes, OrgTax): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_taxes EXPECTED TYPE: OrgTax', None, None) + + self.__org_taxes = org_taxes + self.__key_modified['org_taxes'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/success_response.py new file mode 100644 index 0000000..eb9eb86 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/tax.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/tax.py new file mode 100644 index 0000000..6192fc0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/tax.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tax(object): + def __init__(self): + """Creates an instance of Tax""" + + self.__display_label = None + self.__sequence_number = None + self.__name = None + self.__id = None + self.__value = None + self.__delete = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + float: A float representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (float) : A float representing the value + """ + + if value is not None and not isinstance(value, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: float', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/taxes_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/taxes_operations.py new file mode 100644 index 0000000..5302040 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/taxes/taxes_operations.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class TaxesOperations(object): + def __init__(self): + """Creates an instance of TaxesOperations""" + pass + + def get_taxes(self): + """ + The method to get taxes + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/taxes' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_taxes(self, request): + """ + The method to update taxes + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/org/taxes' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_tax(self, id): + """ + The method to get tax + + 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/v7/org/taxes/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/__init__.py new file mode 100644 index 0000000..0b2a9db --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .folder import Folder +from .templates import Templates +from .wrapper import Wrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/api_exception.py new file mode 100644 index 0000000..5161635 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/folder.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/folder.py new file mode 100644 index 0000000..03de6e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/folder.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Folder(object): + def __init__(self): + """Creates an instance of Folder""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/templates.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/templates.py new file mode 100644 index 0000000..7b84f1e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/templates.py @@ -0,0 +1,311 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Templates(object): + def __init__(self): + """Creates an instance of Templates""" + + self.__folder = None + self.__modified_by = None + self.__module = None + self.__modified_time = None + self.__subject = None + self.__name = None + self.__consent_linked = None + self.__favourite = None + self.__attachment_present = None + self.__id = None + self.__key_modified = dict() + + def get_folder(self): + """ + The method to get the folder + + Returns: + Folder: An instance of Folder + """ + + return self.__folder + + def set_folder(self, folder): + """ + The method to set the value to folder + + Parameters: + folder (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.templates.folder import Folder + except Exception: + from .folder import Folder + + if folder is not None and not isinstance(folder, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: Folder', None, None) + + self.__folder = folder + self.__key_modified['folder'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Folder: An instance of Folder + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.templates.folder import Folder + except Exception: + from .folder import Folder + + if modified_by is not None and not isinstance(modified_by, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Folder', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_consent_linked(self): + """ + The method to get the consent_linked + + Returns: + bool: A bool representing the consent_linked + """ + + return self.__consent_linked + + def set_consent_linked(self, consent_linked): + """ + The method to set the value to consent_linked + + Parameters: + consent_linked (bool) : A bool representing the consent_linked + """ + + if consent_linked is not None and not isinstance(consent_linked, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_linked EXPECTED TYPE: bool', None, None) + + self.__consent_linked = consent_linked + self.__key_modified['consent_linked'] = 1 + + def get_favourite(self): + """ + The method to get the favourite + + Returns: + bool: A bool representing the favourite + """ + + return self.__favourite + + def set_favourite(self, favourite): + """ + The method to set the value to favourite + + Parameters: + favourite (bool) : A bool representing the favourite + """ + + if favourite is not None and not isinstance(favourite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favourite EXPECTED TYPE: bool', None, None) + + self.__favourite = favourite + self.__key_modified['favourite'] = 1 + + def get_attachment_present(self): + """ + The method to get the attachment_present + + Returns: + bool: A bool representing the attachment_present + """ + + return self.__attachment_present + + def set_attachment_present(self, attachment_present): + """ + The method to set the value to attachment_present + + Parameters: + attachment_present (bool) : A bool representing the attachment_present + """ + + if attachment_present is not None and not isinstance(attachment_present, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_present EXPECTED TYPE: bool', None, None) + + self.__attachment_present = attachment_present + self.__key_modified['attachment_present'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/wrapper.py new file mode 100644 index 0000000..e8b795d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/templates/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__templates = None + self.__key_modified = dict() + + def get_templates(self): + """ + The method to get the templates + + Returns: + list: An instance of list + """ + + return self.__templates + + def set_templates(self, templates): + """ + The method to set the value to templates + + Parameters: + templates (list) : An instance of list + """ + + if templates is not None and not isinstance(templates, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: templates EXPECTED TYPE: list', None, None) + + self.__templates = templates + self.__key_modified['templates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/__init__.py new file mode 100644 index 0000000..a7b3375 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/__init__.py @@ -0,0 +1,22 @@ +from .deleted_associated_wrapper import DeletedAssociatedWrapper +from .action_wrapper import ActionWrapper +from .manager import Manager +from .criteria import Criteria +from .territories_operations import TerritoriesOperations, GetTerritoriesParam, DeleteTerritoriesParam, DeleteTerritoryParam, GetChildTerritoryParam +from .body_wrapper import BodyWrapper +from .reporting_to import ReportingTo +from .associated_users_count import AssociatedUsersCount +from .transfer_territory import TransferTerritory +from .minified_territory import MinifiedTerritory +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .field import Field +from .territories import Territories +from .transfer_body_wrapper import TransferBodyWrapper +from .deleted_associated_territories import DeletedAssociatedTerritories +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .associated_users_count_wrapper import AssociatedUsersCountWrapper +from .action_handler import ActionHandler +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_wrapper.py new file mode 100644 index 0000000..7e06161 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/api_exception.py new file mode 100644 index 0000000..0da1da9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count.py new file mode 100644 index 0000000..06b8acd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedUsersCount(object): + def __init__(self): + """Creates an instance of AssociatedUsersCount""" + + self.__count = None + self.__territory = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + string: A string representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (string) : A string representing the count + """ + + if count is not None and not isinstance(count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: str', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + MinifiedTerritory: An instance of MinifiedTerritory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (MinifiedTerritory) : An instance of MinifiedTerritory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.minified_territory import MinifiedTerritory + except Exception: + from .minified_territory import MinifiedTerritory + + if territory is not None and not isinstance(territory, MinifiedTerritory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: MinifiedTerritory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count_wrapper.py new file mode 100644 index 0000000..08b3fcb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociatedUsersCountWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of AssociatedUsersCountWrapper""" + super().__init__() + + self.__associated_users_count = None + self.__info = None + self.__key_modified = dict() + + def get_associated_users_count(self): + """ + The method to get the associated_users_count + + Returns: + list: An instance of list + """ + + return self.__associated_users_count + + def set_associated_users_count(self, associated_users_count): + """ + The method to set the value to associated_users_count + + Parameters: + associated_users_count (list) : An instance of list + """ + + if associated_users_count is not None and not isinstance(associated_users_count, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_users_count EXPECTED TYPE: list', None, None) + + self.__associated_users_count = associated_users_count + self.__key_modified['associated_users_count'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/body_wrapper.py new file mode 100644 index 0000000..5e9566b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/criteria.py new file mode 100644 index 0000000..82ea82b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_territories.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_territories.py new file mode 100644 index 0000000..e75b2e9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_territories.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DeletedAssociatedTerritories(object): + def __init__(self): + """Creates an instance of DeletedAssociatedTerritories""" + + self.__name = None + self.__id = None + self.__deleted_time = None + self.__deleted_by = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_deleted_time(self): + """ + The method to get the deleted_time + + Returns: + datetime: An instance of datetime + """ + + return self.__deleted_time + + def set_deleted_time(self, deleted_time): + """ + The method to set the value to deleted_time + + Parameters: + deleted_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if deleted_time is not None and not isinstance(deleted_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_time EXPECTED TYPE: datetime', None, None) + + self.__deleted_time = deleted_time + self.__key_modified['deleted_time'] = 1 + + def get_deleted_by(self): + """ + The method to get the deleted_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__deleted_by + + def set_deleted_by(self, deleted_by): + """ + The method to set the value to deleted_by + + Parameters: + deleted_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if deleted_by is not None and not isinstance(deleted_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__deleted_by = deleted_by + self.__key_modified['deleted_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_wrapper.py new file mode 100644 index 0000000..73fb296 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_wrapper.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DeletedAssociatedWrapper(object): + def __init__(self): + """Creates an instance of DeletedAssociatedWrapper""" + + self.__territories = None + self.__info = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/manager.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/manager.py new file mode 100644 index 0000000..b7a8f34 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/manager.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Manager(object): + def __init__(self): + """Creates an instance of Manager""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/minified_territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/minified_territory.py new file mode 100644 index 0000000..c561e16 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/minified_territory.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedTerritory(object): + def __init__(self): + """Creates an instance of MinifiedTerritory""" + + self.__name = None + self.__id = None + self.__subordinates = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/reporting_to.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/reporting_to.py new file mode 100644 index 0000000..ddb09b9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/reporting_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReportingTo(object): + def __init__(self): + """Creates an instance of ReportingTo""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/response_wrapper.py new file mode 100644 index 0000000..8a3559f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__territories = None + self.__info = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/success_response.py new file mode 100644 index 0000000..442d442 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/territories.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/territories.py new file mode 100644 index 0000000..034bf9c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/territories.py @@ -0,0 +1,438 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Territories(object): + def __init__(self): + """Creates an instance of Territories""" + + self.__created_time = None + self.__modified_time = None + self.__manager = None + self.__reporting_to = None + self.__permission_type = None + self.__modified_by = None + self.__description = None + self.__id = None + self.__created_by = None + self.__account_rule_criteria = None + self.__deal_rule_criteria = None + self.__lead_rule_criteria = None + self.__name = None + self.__api_name = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_manager(self): + """ + The method to get the manager + + Returns: + Manager: An instance of Manager + """ + + return self.__manager + + def set_manager(self, manager): + """ + The method to set the value to manager + + Parameters: + manager (Manager) : An instance of Manager + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.manager import Manager + except Exception: + from .manager import Manager + + if manager is not None and not isinstance(manager, Manager): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: manager EXPECTED TYPE: Manager', None, None) + + self.__manager = manager + self.__key_modified['manager'] = 1 + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + ReportingTo: An instance of ReportingTo + """ + + return self.__reporting_to + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (ReportingTo) : An instance of ReportingTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.reporting_to import ReportingTo + except Exception: + from .reporting_to import ReportingTo + + if reporting_to is not None and not isinstance(reporting_to, ReportingTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: ReportingTo', None, None) + + self.__reporting_to = reporting_to + self.__key_modified['reporting_to'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + Choice: An instance of Choice + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (Choice) : An instance of Choice + """ + + if permission_type is not None and not isinstance(permission_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: Choice', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_account_rule_criteria(self): + """ + The method to get the account_rule_criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__account_rule_criteria + + def set_account_rule_criteria(self, account_rule_criteria): + """ + The method to set the value to account_rule_criteria + + Parameters: + account_rule_criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.criteria import Criteria + except Exception: + from .criteria import Criteria + + if account_rule_criteria is not None and not isinstance(account_rule_criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: account_rule_criteria EXPECTED TYPE: Criteria', None, None) + + self.__account_rule_criteria = account_rule_criteria + self.__key_modified['account_rule_criteria'] = 1 + + def get_deal_rule_criteria(self): + """ + The method to get the deal_rule_criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__deal_rule_criteria + + def set_deal_rule_criteria(self, deal_rule_criteria): + """ + The method to set the value to deal_rule_criteria + + Parameters: + deal_rule_criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.criteria import Criteria + except Exception: + from .criteria import Criteria + + if deal_rule_criteria is not None and not isinstance(deal_rule_criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal_rule_criteria EXPECTED TYPE: Criteria', None, None) + + self.__deal_rule_criteria = deal_rule_criteria + self.__key_modified['deal_rule_criteria'] = 1 + + def get_lead_rule_criteria(self): + """ + The method to get the lead_rule_criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__lead_rule_criteria + + def set_lead_rule_criteria(self, lead_rule_criteria): + """ + The method to set the value to lead_rule_criteria + + Parameters: + lead_rule_criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.criteria import Criteria + except Exception: + from .criteria import Criteria + + if lead_rule_criteria is not None and not isinstance(lead_rule_criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lead_rule_criteria EXPECTED TYPE: Criteria', None, None) + + self.__lead_rule_criteria = lead_rule_criteria + self.__key_modified['lead_rule_criteria'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/territories_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/territories_operations.py new file mode 100644 index 0000000..3d6fdb7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/territories_operations.py @@ -0,0 +1,431 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class TerritoriesOperations(object): + def __init__(self): + """Creates an instance of TerritoriesOperations""" + pass + + def get_territories(self, param_instance=None): + """ + The method to get territories + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/territories' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_territories(self, request): + """ + The method to create territories + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/territories' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_territories(self, request): + """ + The method to update territories + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/territories' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_territories(self, param_instance=None): + """ + The method to delete territories + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_territory(self, id): + """ + The method to get territory + + 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/v7/settings/territories/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_territory(self, id, request): + """ + The method to update territory + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/territories/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_territory(self, id, param_instance=None): + """ + The method to delete territory + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/territories/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_child_territory(self, id, param_instance=None): + """ + The method to get child territory + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/territories/' + api_path = api_path + str(id) + api_path = api_path + '/__child_territories' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associated_user_count(self): + """ + The method to get associated user count + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/actions/associated_users_count' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def transfer_and_delete_territory(self, id, request): + """ + The method to transfer and delete territory + + Parameters: + id (int) : An int representing the id + request (TransferBodyWrapper) : An instance of TransferBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.transfer_body_wrapper import TransferBodyWrapper + except Exception: + from .transfer_body_wrapper import TransferBodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, TransferBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(id) + api_path = api_path + '/actions/transfer_and_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def transfer_and_delete_territories(self, request): + """ + The method to transfer and delete territories + + Parameters: + request (TransferBodyWrapper) : An instance of TransferBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.transfer_body_wrapper import TransferBodyWrapper + except Exception: + from .transfer_body_wrapper import TransferBodyWrapper + + if request is not None and not isinstance(request, TransferBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/actions/transfer_and_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetTerritoriesParam(object): + filters = Param('filters', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + include = Param('include', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + page = Param('page', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + per_page = Param('per_page', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + + +class DeleteTerritoriesParam(object): + ids = Param('ids', 'com.zoho.crm.api.Territories.DeleteTerritoriesParam') + delete_previous_forecasts = Param('delete_previous_forecasts', 'com.zoho.crm.api.Territories.DeleteTerritoriesParam') + + +class DeleteTerritoryParam(object): + delete_previous_forecasts = Param('delete_previous_forecasts', 'com.zoho.crm.api.Territories.DeleteTerritoryParam') + + +class GetChildTerritoryParam(object): + filters = Param('filters', 'com.zoho.crm.api.Territories.GetChildTerritoryParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_body_wrapper.py new file mode 100644 index 0000000..6ca28ce --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferBodyWrapper(object): + def __init__(self): + """Creates an instance of TransferBodyWrapper""" + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_territory.py new file mode 100644 index 0000000..be83663 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_territory.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferTerritory(object): + def __init__(self): + """Creates an instance of TransferTerritory""" + + self.__id = None + self.__transfer_to_id = None + self.__delete_previous_forecasts = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_transfer_to_id(self): + """ + The method to get the transfer_to_id + + Returns: + int: An int representing the transfer_to_id + """ + + return self.__transfer_to_id + + def set_transfer_to_id(self, transfer_to_id): + """ + The method to set the value to transfer_to_id + + Parameters: + transfer_to_id (int) : An int representing the transfer_to_id + """ + + if transfer_to_id is not None and not isinstance(transfer_to_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_to_id EXPECTED TYPE: int', None, None) + + self.__transfer_to_id = transfer_to_id + self.__key_modified['transfer_to_id'] = 1 + + def get_delete_previous_forecasts(self): + """ + The method to get the delete_previous_forecasts + + Returns: + bool: A bool representing the delete_previous_forecasts + """ + + return self.__delete_previous_forecasts + + def set_delete_previous_forecasts(self, delete_previous_forecasts): + """ + The method to set the value to delete_previous_forecasts + + Parameters: + delete_previous_forecasts (bool) : A bool representing the delete_previous_forecasts + """ + + if delete_previous_forecasts is not None and not isinstance(delete_previous_forecasts, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete_previous_forecasts EXPECTED TYPE: bool', None, None) + + self.__delete_previous_forecasts = delete_previous_forecasts + self.__key_modified['delete_previous_forecasts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/__init__.py new file mode 100644 index 0000000..37586e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .territory_users_operations import TerritoryUsersOperations, DeassociateTerritoryUsersParam +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_wrapper.py new file mode 100644 index 0000000..0d43322 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/api_exception.py new file mode 100644 index 0000000..1f860ea --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/body_wrapper.py new file mode 100644 index 0000000..9160577 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_wrapper.py new file mode 100644 index 0000000..8eb9d8e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users = None + self.__info = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/success_response.py new file mode 100644 index 0000000..f4fcfd5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/territory_users_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/territory_users_operations.py new file mode 100644 index 0000000..d4e4f2c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/territory_users/territory_users_operations.py @@ -0,0 +1,241 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class TerritoryUsersOperations(object): + def __init__(self): + """Creates an instance of TerritoryUsersOperations""" + pass + + def get_territory_users(self, territory): + """ + The method to get territory users + + Parameters: + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_territory_users(self, territory, request): + """ + The method to update territory users + + Parameters: + territory (int) : An int representing the territory + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory 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/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def deassociate_territory_users(self, territory, param_instance=None): + """ + The method to deassociate territory users + + Parameters: + territory (int) : An int representing the territory + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + 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/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_territory_user(self, user, territory): + """ + The method to get territory user + + Parameters: + user (int) : An int representing the user + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users/' + api_path = api_path + str(user) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_territory_user(self, user, territory): + """ + The method to update territory user + + Parameters: + user (int) : An int representing the user + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users/' + api_path = api_path + str(user) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def deassociate_territory_user(self, user, territory): + """ + The method to deassociate territory user + + Parameters: + user (int) : An int representing the user + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users/' + api_path = api_path + str(user) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class DeassociateTerritoryUsersParam(object): + ids = Param('ids', 'com.zoho.crm.api.TerritoryUsers.DeassociateTerritoryUsersParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/__init__.py new file mode 100644 index 0000000..eda829f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/__init__.py @@ -0,0 +1,16 @@ +from .related_record import RelatedRecord +from .automation_detail import AutomationDetail +from .module import Module +from .picklist_detail import PicklistDetail +from .api_exception import APIException +from .response_handler import ResponseHandler +from .timelines_operations import TimelinesOperations, GetTimelinesParam +from .field_history_value import FieldHistoryValue +from .record import Record +from .path_finder import PathFinder +from .response_wrapper import ResponseWrapper +from .timeline import Timeline +from .state import State +from .name_id_structure import NameIdStructure +from .field_history import FieldHistory +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/api_exception.py new file mode 100644 index 0000000..54523ff --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.timelines.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/automation_detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/automation_detail.py new file mode 100644 index 0000000..a81556e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/automation_detail.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutomationDetail(object): + def __init__(self): + """Creates an instance of AutomationDetail""" + + self.__type = None + self.__rule = None + self.__pathfinder = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_rule(self): + """ + The method to get the rule + + Returns: + NameIdStructure: An instance of NameIdStructure + """ + + return self.__rule + + def set_rule(self, rule): + """ + The method to set the value to rule + + Parameters: + rule (NameIdStructure) : An instance of NameIdStructure + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.name_id_structure import NameIdStructure + except Exception: + from .name_id_structure import NameIdStructure + + if rule is not None and not isinstance(rule, NameIdStructure): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rule EXPECTED TYPE: NameIdStructure', None, None) + + self.__rule = rule + self.__key_modified['rule'] = 1 + + def get_pathfinder(self): + """ + The method to get the pathfinder + + Returns: + PathFinder: An instance of PathFinder + """ + + return self.__pathfinder + + def set_pathfinder(self, pathfinder): + """ + The method to set the value to pathfinder + + Parameters: + pathfinder (PathFinder) : An instance of PathFinder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.path_finder import PathFinder + except Exception: + from .path_finder import PathFinder + + if pathfinder is not None and not isinstance(pathfinder, PathFinder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pathfinder EXPECTED TYPE: PathFinder', None, None) + + self.__pathfinder = pathfinder + self.__key_modified['pathfinder'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history.py new file mode 100644 index 0000000..3199347 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldHistory(object): + def __init__(self): + """Creates an instance of FieldHistory""" + + self.__data_type = None + self.__enable_colour_code = None + self.__pick_list_values = None + self.__field_label = None + self.__api_name = None + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + FieldHistoryValue: An instance of FieldHistoryValue + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (FieldHistoryValue) : An instance of FieldHistoryValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.field_history_value import FieldHistoryValue + except Exception: + from .field_history_value import FieldHistoryValue + + if value is not None and not isinstance(value, FieldHistoryValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: FieldHistoryValue', None, None) + + self.__value = value + self.__key_modified['_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history_value.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history_value.py new file mode 100644 index 0000000..b27e152 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history_value.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldHistoryValue(object): + def __init__(self): + """Creates an instance of FieldHistoryValue""" + + self.__new = None + self.__old = None + self.__key_modified = dict() + + def get_new(self): + """ + The method to get the new + + Returns: + string: A string representing the new + """ + + return self.__new + + def set_new(self, new): + """ + The method to set the value to new + + Parameters: + new (string) : A string representing the new + """ + + if new is not None and not isinstance(new, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: new EXPECTED TYPE: str', None, None) + + self.__new = new + self.__key_modified['new'] = 1 + + def get_old(self): + """ + The method to get the old + + Returns: + string: A string representing the old + """ + + return self.__old + + def set_old(self, old): + """ + The method to set the value to old + + Parameters: + old (string) : A string representing the old + """ + + if old is not None and not isinstance(old, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: old EXPECTED TYPE: str', None, None) + + self.__old = old + self.__key_modified['old'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/info.py new file mode 100644 index 0000000..55b7d3d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/info.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__next_page_token = None + self.__previous_page_token = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/name_id_structure.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/name_id_structure.py new file mode 100644 index 0000000..0eca1ef --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/name_id_structure.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NameIdStructure(object): + def __init__(self): + """Creates an instance of NameIdStructure""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/path_finder.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/path_finder.py new file mode 100644 index 0000000..d47fad2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/path_finder.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PathFinder(object): + def __init__(self): + """Creates an instance of PathFinder""" + + self.__process_entry = None + self.__process_exit = None + self.__state = None + self.__key_modified = dict() + + def get_process_entry(self): + """ + The method to get the process_entry + + Returns: + bool: A bool representing the process_entry + """ + + return self.__process_entry + + def set_process_entry(self, process_entry): + """ + The method to set the value to process_entry + + Parameters: + process_entry (bool) : A bool representing the process_entry + """ + + if process_entry is not None and not isinstance(process_entry, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_entry EXPECTED TYPE: bool', None, None) + + self.__process_entry = process_entry + self.__key_modified['process_entry'] = 1 + + def get_process_exit(self): + """ + The method to get the process_exit + + Returns: + bool: A bool representing the process_exit + """ + + return self.__process_exit + + def set_process_exit(self, process_exit): + """ + The method to set the value to process_exit + + Parameters: + process_exit (bool) : A bool representing the process_exit + """ + + if process_exit is not None and not isinstance(process_exit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_exit EXPECTED TYPE: bool', None, None) + + self.__process_exit = process_exit + self.__key_modified['process_exit'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + State: An instance of State + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (State) : An instance of State + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.state import State + except Exception: + from .state import State + + if state is not None and not isinstance(state, State): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: State', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/picklist_detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/picklist_detail.py new file mode 100644 index 0000000..a180d30 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/picklist_detail.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PicklistDetail(object): + def __init__(self): + """Creates an instance of PicklistDetail""" + + self.__display_value = None + self.__sequence_number = None + self.__colour_code = None + self.__actual_value = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/record.py new file mode 100644 index 0000000..90a5187 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/related_record.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/related_record.py new file mode 100644 index 0000000..7fcd3bb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/related_record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedRecord(object): + def __init__(self): + """Creates an instance of RelatedRecord""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + NameIdStructure: An instance of NameIdStructure + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (NameIdStructure) : An instance of NameIdStructure + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.name_id_structure import NameIdStructure + except Exception: + from .name_id_structure import NameIdStructure + + if module is not None and not isinstance(module, NameIdStructure): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: NameIdStructure', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/response_wrapper.py new file mode 100644 index 0000000..fadd169 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.timelines.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__timeline = None + self.__info = None + self.__key_modified = dict() + + def get_timeline(self): + """ + The method to get the timeline + + Returns: + list: An instance of list + """ + + return self.__timeline + + def set_timeline(self, timeline): + """ + The method to set the value to timeline + + Parameters: + timeline (list) : An instance of list + """ + + if timeline is not None and not isinstance(timeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: timeline EXPECTED TYPE: list', None, None) + + self.__timeline = timeline + self.__key_modified['__timeline'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/state.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/state.py new file mode 100644 index 0000000..990d92a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/state.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class State(object): + def __init__(self): + """Creates an instance of State""" + + self.__trigger_type = None + self.__name = None + self.__is_last_state = None + self.__id = None + self.__key_modified = dict() + + def get_trigger_type(self): + """ + The method to get the trigger_type + + Returns: + string: A string representing the trigger_type + """ + + return self.__trigger_type + + def set_trigger_type(self, trigger_type): + """ + The method to set the value to trigger_type + + Parameters: + trigger_type (string) : A string representing the trigger_type + """ + + if trigger_type is not None and not isinstance(trigger_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trigger_type EXPECTED TYPE: str', None, None) + + self.__trigger_type = trigger_type + self.__key_modified['trigger_type'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_is_last_state(self): + """ + The method to get the is_last_state + + Returns: + bool: A bool representing the is_last_state + """ + + return self.__is_last_state + + def set_is_last_state(self, is_last_state): + """ + The method to set the value to is_last_state + + Parameters: + is_last_state (bool) : A bool representing the is_last_state + """ + + if is_last_state is not None and not isinstance(is_last_state, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_last_state EXPECTED TYPE: bool', None, None) + + self.__is_last_state = is_last_state + self.__key_modified['is_last_state'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/timeline.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/timeline.py new file mode 100644 index 0000000..0a355db --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/timeline.py @@ -0,0 +1,346 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Timeline(object): + def __init__(self): + """Creates an instance of Timeline""" + + self.__audited_time = None + self.__action = None + self.__id = None + self.__source = None + self.__extension = None + self.__type = None + self.__done_by = None + self.__related_record = None + self.__automation_details = None + self.__record = None + self.__field_history = None + self.__key_modified = dict() + + def get_audited_time(self): + """ + The method to get the audited_time + + Returns: + datetime: An instance of datetime + """ + + return self.__audited_time + + def set_audited_time(self, audited_time): + """ + The method to set the value to audited_time + + Parameters: + audited_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if audited_time is not None and not isinstance(audited_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audited_time EXPECTED TYPE: datetime', None, None) + + self.__audited_time = audited_time + self.__key_modified['audited_time'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + string: A string representing the action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (string) : A string representing the action + """ + + if action is not None and not isinstance(action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: str', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_extension(self): + """ + The method to get the extension + + Returns: + string: A string representing the extension + """ + + return self.__extension + + def set_extension(self, extension): + """ + The method to set the value to extension + + Parameters: + extension (string) : A string representing the extension + """ + + if extension is not None and not isinstance(extension, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: extension EXPECTED TYPE: str', None, None) + + self.__extension = extension + self.__key_modified['extension'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_done_by(self): + """ + The method to get the done_by + + Returns: + NameIdStructure: An instance of NameIdStructure + """ + + return self.__done_by + + def set_done_by(self, done_by): + """ + The method to set the value to done_by + + Parameters: + done_by (NameIdStructure) : An instance of NameIdStructure + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.name_id_structure import NameIdStructure + except Exception: + from .name_id_structure import NameIdStructure + + if done_by is not None and not isinstance(done_by, NameIdStructure): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: done_by EXPECTED TYPE: NameIdStructure', None, None) + + self.__done_by = done_by + self.__key_modified['done_by'] = 1 + + def get_related_record(self): + """ + The method to get the related_record + + Returns: + RelatedRecord: An instance of RelatedRecord + """ + + return self.__related_record + + def set_related_record(self, related_record): + """ + The method to set the value to related_record + + Parameters: + related_record (RelatedRecord) : An instance of RelatedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.related_record import RelatedRecord + except Exception: + from .related_record import RelatedRecord + + if related_record is not None and not isinstance(related_record, RelatedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record EXPECTED TYPE: RelatedRecord', None, None) + + self.__related_record = related_record + self.__key_modified['related_record'] = 1 + + def get_automation_details(self): + """ + The method to get the automation_details + + Returns: + AutomationDetail: An instance of AutomationDetail + """ + + return self.__automation_details + + def set_automation_details(self, automation_details): + """ + The method to set the value to automation_details + + Parameters: + automation_details (AutomationDetail) : An instance of AutomationDetail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.automation_detail import AutomationDetail + except Exception: + from .automation_detail import AutomationDetail + + if automation_details is not None and not isinstance(automation_details, AutomationDetail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: automation_details EXPECTED TYPE: AutomationDetail', None, None) + + self.__automation_details = automation_details + self.__key_modified['automation_details'] = 1 + + def get_record(self): + """ + The method to get the record + + Returns: + Record: An instance of Record + """ + + return self.__record + + def set_record(self, record): + """ + The method to set the value to record + + Parameters: + record (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.record import Record + except Exception: + from .record import Record + + if record is not None and not isinstance(record, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: Record', None, None) + + self.__record = record + self.__key_modified['record'] = 1 + + def get_field_history(self): + """ + The method to get the field_history + + Returns: + list: An instance of list + """ + + return self.__field_history + + def set_field_history(self, field_history): + """ + The method to set the value to field_history + + Parameters: + field_history (list) : An instance of list + """ + + if field_history is not None and not isinstance(field_history, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_history EXPECTED TYPE: list', None, None) + + self.__field_history = field_history + self.__key_modified['field_history'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/timelines_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/timelines_operations.py new file mode 100644 index 0000000..167545d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/timelines/timelines_operations.py @@ -0,0 +1,73 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class TimelinesOperations(object): + def __init__(self): + """Creates an instance of TimelinesOperations""" + pass + + def get_timelines(self, module, record_id, param_instance=None): + """ + The method to get timelines + + Parameters: + module (string) : A string representing the module + record_id (string) : A string representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(record_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/__timeline' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetTimelinesParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + include_timeline_type = Param('include_timeline_type', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + include = Param('include', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + filters = Param('filters', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + per_page = Param('per_page', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + page = Param('page', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + page_token = Param('page_token', 'com.zoho.crm.api.Timelines.GetTimelinesParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/__init__.py new file mode 100644 index 0000000..c76331c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/__init__.py @@ -0,0 +1,7 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .unblock_email_operations import UnblockEmailOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_wrapper.py new file mode 100644 index 0000000..5719d26 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/api_exception.py new file mode 100644 index 0000000..02f741e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class APIException(ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/body_wrapper.py new file mode 100644 index 0000000..f1d58f3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/body_wrapper.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__ids = None + self.__unblock_fields = None + self.__key_modified = dict() + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_unblock_fields(self): + """ + The method to get the unblock_fields + + Returns: + list: An instance of list + """ + + return self.__unblock_fields + + def set_unblock_fields(self, unblock_fields): + """ + The method to set the value to unblock_fields + + Parameters: + unblock_fields (list) : An instance of list + """ + + if unblock_fields is not None and not isinstance(unblock_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unblock_fields EXPECTED TYPE: list', None, None) + + self.__unblock_fields = unblock_fields + self.__key_modified['unblock_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/success_response.py new file mode 100644 index 0000000..e924303 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + string: A string representing the code + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (string) : A string representing the code + """ + + if code is not None and not isinstance(code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: str', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/unblock_email_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/unblock_email_operations.py new file mode 100644 index 0000000..c9d6373 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unblock_email/unblock_email_operations.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class UnblockEmailOperations(object): + def __init__(self, module): + """ + Creates an instance of UnblockEmailOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def unblock_emails(self, request): + """ + The method to unblock emails + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/unblock_email' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def unblock_email(self, id, request): + """ + The method to unblock email + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/unblock_email' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/__init__.py new file mode 100644 index 0000000..1eec210 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .associations_response_wrapper import AssociationsResponseWrapper +from .resource import Resource +from .module import Module +from .body_wrapper import BodyWrapper +from .associations_response_handler import AssociationsResponseHandler +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .association_details import AssociationDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .unsubscribe_links import UnsubscribeLinks +from .action_handler import ActionHandler +from .detail import Detail +from .associated_places import AssociatedPlaces +from .unsubscribe_links_operations import UnsubscribeLinksOperations +from .user import User diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_wrapper.py new file mode 100644 index 0000000..d14d805 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__unsubscribe_links = None + self.__key_modified = dict() + + def get_unsubscribe_links(self): + """ + The method to get the unsubscribe_links + + Returns: + list: An instance of list + """ + + return self.__unsubscribe_links + + def set_unsubscribe_links(self, unsubscribe_links): + """ + The method to set the value to unsubscribe_links + + Parameters: + unsubscribe_links (list) : An instance of list + """ + + if unsubscribe_links is not None and not isinstance(unsubscribe_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_links EXPECTED TYPE: list', None, None) + + self.__unsubscribe_links = unsubscribe_links + self.__key_modified['unsubscribe_links'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/api_exception.py new file mode 100644 index 0000000..f37ac08 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.associations_response_handler import AssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + from .associations_response_handler import AssociationsResponseHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse, AssociationsResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associated_places.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associated_places.py new file mode 100644 index 0000000..555c79d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associated_places.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedPlaces(object): + def __init__(self): + """Creates an instance of AssociatedPlaces""" + + self.__type = None + self.__resource = None + self.__details = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + Resource: An instance of Resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Resource) : An instance of Resource + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.resource import Resource + except Exception: + from .resource import Resource + + if resource is not None and not isinstance(resource, Resource): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Resource', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + Detail: An instance of Detail + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Detail) : An instance of Detail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.detail import Detail + except Exception: + from .detail import Detail + + if details is not None and not isinstance(details, Detail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Detail', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/association_details.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/association_details.py new file mode 100644 index 0000000..48791db --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/association_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationDetails(object): + def __init__(self): + """Creates an instance of AssociationDetails""" + + self.__id = None + self.__associated_places = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_associated_places(self): + """ + The method to get the associated_places + + Returns: + list: An instance of list + """ + + return self.__associated_places + + def set_associated_places(self, associated_places): + """ + The method to set the value to associated_places + + Parameters: + associated_places (list) : An instance of list + """ + + if associated_places is not None and not isinstance(associated_places, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_places EXPECTED TYPE: list', None, None) + + self.__associated_places = associated_places + self.__key_modified['associated_places'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_handler.py new file mode 100644 index 0000000..0b460f7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class AssociationsResponseHandler(ABC): + def __init__(self): + """Creates an instance of AssociationsResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_wrapper.py new file mode 100644 index 0000000..e85a67e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.associations_response_handler import AssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .associations_response_handler import AssociationsResponseHandler + + +class AssociationsResponseWrapper(AssociationsResponseHandler): + def __init__(self): + """Creates an instance of AssociationsResponseWrapper""" + super().__init__() + + self.__associations = None + self.__key_modified = dict() + + def get_associations(self): + """ + The method to get the associations + + Returns: + list: An instance of list + """ + + return self.__associations + + def set_associations(self, associations): + """ + The method to set the value to associations + + Parameters: + associations (list) : An instance of list + """ + + if associations is not None and not isinstance(associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associations EXPECTED TYPE: list', None, None) + + self.__associations = associations + self.__key_modified['associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/body_wrapper.py new file mode 100644 index 0000000..4456831 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__unsubscribe_links = None + self.__key_modified = dict() + + def get_unsubscribe_links(self): + """ + The method to get the unsubscribe_links + + Returns: + list: An instance of list + """ + + return self.__unsubscribe_links + + def set_unsubscribe_links(self, unsubscribe_links): + """ + The method to set the value to unsubscribe_links + + Parameters: + unsubscribe_links (list) : An instance of list + """ + + if unsubscribe_links is not None and not isinstance(unsubscribe_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_links EXPECTED TYPE: list', None, None) + + self.__unsubscribe_links = unsubscribe_links + self.__key_modified['unsubscribe_links'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/detail.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/detail.py new file mode 100644 index 0000000..8241f38 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/detail.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Detail(object): + def __init__(self): + """Creates an instance of Detail""" + + self.__module = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/module.py new file mode 100644 index 0000000..93604c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/resource.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/resource.py new file mode 100644 index 0000000..ae2a6ea --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_wrapper.py new file mode 100644 index 0000000..782877f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__unsubscribe_links = None + self.__key_modified = dict() + + def get_unsubscribe_links(self): + """ + The method to get the unsubscribe_links + + Returns: + list: An instance of list + """ + + return self.__unsubscribe_links + + def set_unsubscribe_links(self, unsubscribe_links): + """ + The method to set the value to unsubscribe_links + + Parameters: + unsubscribe_links (list) : An instance of list + """ + + if unsubscribe_links is not None and not isinstance(unsubscribe_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_links EXPECTED TYPE: list', None, None) + + self.__unsubscribe_links = unsubscribe_links + self.__key_modified['unsubscribe_links'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/success_response.py new file mode 100644 index 0000000..adfc738 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links.py new file mode 100644 index 0000000..d625fd8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links.py @@ -0,0 +1,438 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class UnsubscribeLinks(object): + def __init__(self): + """Creates an instance of UnsubscribeLinks""" + + self.__id = None + self.__name = None + self.__page_type = None + self.__custom_location_url = None + self.__standard_page_message = None + self.__submission_action_type = None + self.__submission_message = None + self.__submission_redirect_url = None + self.__location_url_type = None + self.__action_on_unsubscribe = None + self.__created_by = None + self.__modified_by = None + self.__modified_time = None + self.__created_time = None + self.__landing_url = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_page_type(self): + """ + The method to get the page_type + + Returns: + Choice: An instance of Choice + """ + + return self.__page_type + + def set_page_type(self, page_type): + """ + The method to set the value to page_type + + Parameters: + page_type (Choice) : An instance of Choice + """ + + if page_type is not None and not isinstance(page_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_type EXPECTED TYPE: Choice', None, None) + + self.__page_type = page_type + self.__key_modified['page_type'] = 1 + + def get_custom_location_url(self): + """ + The method to get the custom_location_url + + Returns: + string: A string representing the custom_location_url + """ + + return self.__custom_location_url + + def set_custom_location_url(self, custom_location_url): + """ + The method to set the value to custom_location_url + + Parameters: + custom_location_url (string) : A string representing the custom_location_url + """ + + if custom_location_url is not None and not isinstance(custom_location_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_location_url EXPECTED TYPE: str', None, None) + + self.__custom_location_url = custom_location_url + self.__key_modified['custom_location_url'] = 1 + + def get_standard_page_message(self): + """ + The method to get the standard_page_message + + Returns: + string: A string representing the standard_page_message + """ + + return self.__standard_page_message + + def set_standard_page_message(self, standard_page_message): + """ + The method to set the value to standard_page_message + + Parameters: + standard_page_message (string) : A string representing the standard_page_message + """ + + if standard_page_message is not None and not isinstance(standard_page_message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: standard_page_message EXPECTED TYPE: str', None, None) + + self.__standard_page_message = standard_page_message + self.__key_modified['standard_page_message'] = 1 + + def get_submission_action_type(self): + """ + The method to get the submission_action_type + + Returns: + Choice: An instance of Choice + """ + + return self.__submission_action_type + + def set_submission_action_type(self, submission_action_type): + """ + The method to set the value to submission_action_type + + Parameters: + submission_action_type (Choice) : An instance of Choice + """ + + if submission_action_type is not None and not isinstance(submission_action_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: submission_action_type EXPECTED TYPE: Choice', None, None) + + self.__submission_action_type = submission_action_type + self.__key_modified['submission_action_type'] = 1 + + def get_submission_message(self): + """ + The method to get the submission_message + + Returns: + string: A string representing the submission_message + """ + + return self.__submission_message + + def set_submission_message(self, submission_message): + """ + The method to set the value to submission_message + + Parameters: + submission_message (string) : A string representing the submission_message + """ + + if submission_message is not None and not isinstance(submission_message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: submission_message EXPECTED TYPE: str', None, None) + + self.__submission_message = submission_message + self.__key_modified['submission_message'] = 1 + + def get_submission_redirect_url(self): + """ + The method to get the submission_redirect_url + + Returns: + string: A string representing the submission_redirect_url + """ + + return self.__submission_redirect_url + + def set_submission_redirect_url(self, submission_redirect_url): + """ + The method to set the value to submission_redirect_url + + Parameters: + submission_redirect_url (string) : A string representing the submission_redirect_url + """ + + if submission_redirect_url is not None and not isinstance(submission_redirect_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: submission_redirect_url EXPECTED TYPE: str', None, None) + + self.__submission_redirect_url = submission_redirect_url + self.__key_modified['submission_redirect_url'] = 1 + + def get_location_url_type(self): + """ + The method to get the location_url_type + + Returns: + string: A string representing the location_url_type + """ + + return self.__location_url_type + + def set_location_url_type(self, location_url_type): + """ + The method to set the value to location_url_type + + Parameters: + location_url_type (string) : A string representing the location_url_type + """ + + if location_url_type is not None and not isinstance(location_url_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: location_url_type EXPECTED TYPE: str', None, None) + + self.__location_url_type = location_url_type + self.__key_modified['location_url_type'] = 1 + + def get_action_on_unsubscribe(self): + """ + The method to get the action_on_unsubscribe + + Returns: + string: A string representing the action_on_unsubscribe + """ + + return self.__action_on_unsubscribe + + def set_action_on_unsubscribe(self, action_on_unsubscribe): + """ + The method to set the value to action_on_unsubscribe + + Parameters: + action_on_unsubscribe (string) : A string representing the action_on_unsubscribe + """ + + if action_on_unsubscribe is not None and not isinstance(action_on_unsubscribe, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_on_unsubscribe EXPECTED TYPE: str', None, None) + + self.__action_on_unsubscribe = action_on_unsubscribe + self.__key_modified['action_on_unsubscribe'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_landing_url(self): + """ + The method to get the landing_url + + Returns: + string: A string representing the landing_url + """ + + return self.__landing_url + + def set_landing_url(self, landing_url): + """ + The method to set the value to landing_url + + Parameters: + landing_url (string) : A string representing the landing_url + """ + + if landing_url is not None and not isinstance(landing_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: landing_url EXPECTED TYPE: str', None, None) + + self.__landing_url = landing_url + self.__key_modified['landing_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links_operations.py new file mode 100644 index 0000000..106ec75 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links_operations.py @@ -0,0 +1,233 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class UnsubscribeLinksOperations(object): + def __init__(self): + """Creates an instance of UnsubscribeLinksOperations""" + pass + + def get_unsubscribe_links(self): + """ + The method to get unsubscribe links + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/unsubscribe_links' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_unsubscribe_link(self, request): + """ + The method to create unsubscribe link + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/unsubscribe_links' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_unsubscribe_links(self, request): + """ + The method to update unsubscribe links + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/unsubscribe_links' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_unsubscribe_link(self, id): + """ + The method to get unsubscribe link + + 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/v7/settings/unsubscribe_links/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_unsubscribe_link(self, id, request): + """ + The method to update unsubscribe link + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/unsubscribe_links/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_unsubscribe_link(self, id): + """ + The method to delete unsubscribe link + + 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/v7/settings/unsubscribe_links/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_associated_unsubscribe_links(self): + """ + The method to get associated unsubscribe links + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/unsubscribe_link/actions/associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.associations_response_handler import AssociationsResponseHandler + except Exception: + from .associations_response_handler import AssociationsResponseHandler + return handler_instance.api_call(AssociationsResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/user.py new file mode 100644 index 0000000..65fd721 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/__init__.py new file mode 100644 index 0000000..a89efed --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/__init__.py @@ -0,0 +1,38 @@ +from .un_assigned_action_response import UnAssignedActionResponse +from .get_assign_body_wrapper import GetAssignBodyWrapper +from .association_wrapper import AssociationWrapper +from .sources import Sources +from .sources_wrapper import SourcesWrapper +from .criteria import Criteria +from .get_unassign_body_wrapper import GetUnassignBodyWrapper +from .associated_user_count import AssociatedUserCount +from .source import Source +from .association_module import AssociationModule +from .api_exception import APIException +from .sources_count import SourcesCount +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .jobs_wrapper import JobsWrapper +from .sources_count_wrapper import SourcesCountWrapper +from .un_assigned_action_wrapper import UnAssignedActionWrapper +from .action_handler import ActionHandler +from .assigned_action_wrapper import AssignedActionWrapper +from .info import Info +from .action_wrapper import ActionWrapper +from .owner import Owner +from .user_group import UserGroup +from .resource import Resource +from .jobs import Jobs +from .grouped_count import GroupedCount +from .groups import Groups +from .body_wrapper import BodyWrapper +from .users import Users +from .association_response import AssociationResponse +from .field import Field +from .grouped_count_wrapper import GroupedCountWrapper +from .response_wrapper import ResponseWrapper +from .assigned_action_response import AssignedActionResponse +from .associated_user import AssociatedUser +from .user_groups_operations import UserGroupsOperations, GetGroupsParam, GetSourcesParam, GetGroupedCountsParam +from .assign import Assign diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_wrapper.py new file mode 100644 index 0000000..5361a5c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__user_groups = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/api_exception.py new file mode 100644 index 0000000..8e6645f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.un_assigned_action_response import UnAssignedActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assigned_action_response import AssignedActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .un_assigned_action_response import UnAssignedActionResponse + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + from .assigned_action_response import AssignedActionResponse + + +class APIException(ActionResponse, AssignedActionResponse, UnAssignedActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assign.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assign.py new file mode 100644 index 0000000..282dc18 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assign.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Assign(object): + def __init__(self): + """Creates an instance of Assign""" + + self.__feature = None + self.__related_entity_id = None + self.__page = None + self.__per_page = None + self.__id = None + self.__filters = None + self.__key_modified = dict() + + def get_feature(self): + """ + The method to get the feature + + Returns: + Choice: An instance of Choice + """ + + return self.__feature + + def set_feature(self, feature): + """ + The method to set the value to feature + + Parameters: + feature (Choice) : An instance of Choice + """ + + if feature is not None and not isinstance(feature, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature EXPECTED TYPE: Choice', None, None) + + self.__feature = feature + self.__key_modified['feature'] = 1 + + def get_related_entity_id(self): + """ + The method to get the related_entity_id + + Returns: + int: An int representing the related_entity_id + """ + + return self.__related_entity_id + + def set_related_entity_id(self, related_entity_id): + """ + The method to set the value to related_entity_id + + Parameters: + related_entity_id (int) : An int representing the related_entity_id + """ + + if related_entity_id is not None and not isinstance(related_entity_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_entity_id EXPECTED TYPE: int', None, None) + + self.__related_entity_id = related_entity_id + self.__key_modified['related_entity_id'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_filters(self): + """ + The method to get the filters + + Returns: + Criteria: An instance of Criteria + """ + + return self.__filters + + def set_filters(self, filters): + """ + The method to set the value to filters + + Parameters: + filters (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.criteria import Criteria + except Exception: + from .criteria import Criteria + + if filters is not None and not isinstance(filters, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: Criteria', None, None) + + self.__filters = filters + self.__key_modified['filters'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_response.py new file mode 100644 index 0000000..5a878cc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class AssignedActionResponse(ABC): + def __init__(self): + """Creates an instance of AssignedActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_wrapper.py new file mode 100644 index 0000000..72ddc3e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignedActionWrapper(object): + def __init__(self): + """Creates an instance of AssignedActionWrapper""" + + self.__get_assigned = None + self.__key_modified = dict() + + def get_get_assigned(self): + """ + The method to get the get_assigned + + Returns: + AssignedActionResponse: An instance of AssignedActionResponse + """ + + return self.__get_assigned + + def set_get_assigned(self, get_assigned): + """ + The method to set the value to get_assigned + + Parameters: + get_assigned (AssignedActionResponse) : An instance of AssignedActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assigned_action_response import AssignedActionResponse + except Exception: + from .assigned_action_response import AssignedActionResponse + + if get_assigned is not None and not isinstance(get_assigned, AssignedActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_assigned EXPECTED TYPE: AssignedActionResponse', None, None) + + self.__get_assigned = get_assigned + self.__key_modified['get_assigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user.py new file mode 100644 index 0000000..fab62e4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedUser(object): + def __init__(self): + """Creates an instance of AssociatedUser""" + + self.__user_group = None + self.__count = None + self.__key_modified = dict() + + def get_user_group(self): + """ + The method to get the user_group + + Returns: + UserGroup: An instance of UserGroup + """ + + return self.__user_group + + def set_user_group(self, user_group): + """ + The method to set the value to user_group + + Parameters: + user_group (UserGroup) : An instance of UserGroup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.user_group import UserGroup + except Exception: + from .user_group import UserGroup + + if user_group is not None and not isinstance(user_group, UserGroup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_group EXPECTED TYPE: UserGroup', None, None) + + self.__user_group = user_group + self.__key_modified['user_group'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user_count.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user_count.py new file mode 100644 index 0000000..06f7a7f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user_count.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociatedUserCount(ResponseHandler): + def __init__(self): + """Creates an instance of AssociatedUserCount""" + super().__init__() + + self.__associated_users_count = None + self.__info = None + self.__key_modified = dict() + + def get_associated_users_count(self): + """ + The method to get the associated_users_count + + Returns: + list: An instance of list + """ + + return self.__associated_users_count + + def set_associated_users_count(self, associated_users_count): + """ + The method to set the value to associated_users_count + + Parameters: + associated_users_count (list) : An instance of list + """ + + if associated_users_count is not None and not isinstance(associated_users_count, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_users_count EXPECTED TYPE: list', None, None) + + self.__associated_users_count = associated_users_count + self.__key_modified['associated_users_count'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_module.py new file mode 100644 index 0000000..687e8ee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_module.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationModule(object): + def __init__(self): + """Creates an instance of AssociationModule""" + + self.__module = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_response.py new file mode 100644 index 0000000..82d8373 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_response.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationResponse(object): + def __init__(self): + """Creates an instance of AssociationResponse""" + + self.__type = None + self.__resource = None + self.__detail = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + Resource: An instance of Resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Resource) : An instance of Resource + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.resource import Resource + except Exception: + from .resource import Resource + + if resource is not None and not isinstance(resource, Resource): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Resource', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_detail(self): + """ + The method to get the detail + + Returns: + AssociationModule: An instance of AssociationModule + """ + + return self.__detail + + def set_detail(self, detail): + """ + The method to set the value to detail + + Parameters: + detail (AssociationModule) : An instance of AssociationModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.association_module import AssociationModule + except Exception: + from .association_module import AssociationModule + + if detail is not None and not isinstance(detail, AssociationModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: detail EXPECTED TYPE: AssociationModule', None, None) + + self.__detail = detail + self.__key_modified['detail'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_wrapper.py new file mode 100644 index 0000000..d1c10b3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociationWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of AssociationWrapper""" + super().__init__() + + self.__associations = None + self.__key_modified = dict() + + def get_associations(self): + """ + The method to get the associations + + Returns: + list: An instance of list + """ + + return self.__associations + + def set_associations(self, associations): + """ + The method to set the value to associations + + Parameters: + associations (list) : An instance of list + """ + + if associations is not None and not isinstance(associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associations EXPECTED TYPE: list', None, None) + + self.__associations = associations + self.__key_modified['associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/body_wrapper.py new file mode 100644 index 0000000..eb064c5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__user_groups = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/criteria.py new file mode 100644 index 0000000..0c70771 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__group_operator = None + self.__group = None + self.__value = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + Choice: An instance of Choice + """ + + return self.__group_operator + + 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 get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/field.py new file mode 100644 index 0000000..4fee76b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_assign_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_assign_body_wrapper.py new file mode 100644 index 0000000..260f606 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_assign_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class GetAssignBodyWrapper(object): + def __init__(self): + """Creates an instance of GetAssignBodyWrapper""" + + self.__get_assigned = None + self.__key_modified = dict() + + def get_get_assigned(self): + """ + The method to get the get_assigned + + Returns: + Assign: An instance of Assign + """ + + return self.__get_assigned + + def set_get_assigned(self, get_assigned): + """ + The method to set the value to get_assigned + + Parameters: + get_assigned (Assign) : An instance of Assign + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assign import Assign + except Exception: + from .assign import Assign + + if get_assigned is not None and not isinstance(get_assigned, Assign): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_assigned EXPECTED TYPE: Assign', None, None) + + self.__get_assigned = get_assigned + self.__key_modified['get_assigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_unassign_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_unassign_body_wrapper.py new file mode 100644 index 0000000..5f1ec93 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_unassign_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class GetUnassignBodyWrapper(object): + def __init__(self): + """Creates an instance of GetUnassignBodyWrapper""" + + self.__get_unassigned = None + self.__key_modified = dict() + + def get_get_unassigned(self): + """ + The method to get the get_unassigned + + Returns: + Assign: An instance of Assign + """ + + return self.__get_unassigned + + def set_get_unassigned(self, get_unassigned): + """ + The method to set the value to get_unassigned + + Parameters: + get_unassigned (Assign) : An instance of Assign + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assign import Assign + except Exception: + from .assign import Assign + + if get_unassigned is not None and not isinstance(get_unassigned, Assign): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_unassigned EXPECTED TYPE: Assign', None, None) + + self.__get_unassigned = get_unassigned + self.__key_modified['get_unassigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count.py new file mode 100644 index 0000000..db3a96d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class GroupedCount(object): + def __init__(self): + """Creates an instance of GroupedCount""" + + self.__status = None + self.__count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count_wrapper.py new file mode 100644 index 0000000..78c1834 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class GroupedCountWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of GroupedCountWrapper""" + super().__init__() + + self.__grouped_counts = None + self.__info = None + self.__key_modified = dict() + + def get_grouped_counts(self): + """ + The method to get the grouped_counts + + Returns: + list: An instance of list + """ + + return self.__grouped_counts + + def set_grouped_counts(self, grouped_counts): + """ + The method to set the value to grouped_counts + + Parameters: + grouped_counts (list) : An instance of list + """ + + if grouped_counts is not None and not isinstance(grouped_counts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: grouped_counts EXPECTED TYPE: list', None, None) + + self.__grouped_counts = grouped_counts + self.__key_modified['grouped_counts'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/groups.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/groups.py new file mode 100644 index 0000000..5662b2b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/groups.py @@ -0,0 +1,293 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Groups(object): + def __init__(self): + """Creates an instance of Groups""" + + self.__created_by = None + self.__modified_by = None + self.__modified_time = None + self.__created_time = None + self.__description = None + self.__id = None + self.__name = None + self.__sources_count = None + self.__sources = None + self.__key_modified = dict() + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_sources_count(self): + """ + The method to get the sources_count + + Returns: + SourcesCount: An instance of SourcesCount + """ + + return self.__sources_count + + def set_sources_count(self, sources_count): + """ + The method to set the value to sources_count + + Parameters: + sources_count (SourcesCount) : An instance of SourcesCount + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.sources_count import SourcesCount + except Exception: + from .sources_count import SourcesCount + + if sources_count is not None and not isinstance(sources_count, SourcesCount): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources_count EXPECTED TYPE: SourcesCount', None, None) + + self.__sources_count = sources_count + self.__key_modified['sources_count'] = 1 + + def get_sources(self): + """ + The method to get the sources + + Returns: + list: An instance of list + """ + + return self.__sources + + def set_sources(self, sources): + """ + The method to set the value to sources + + Parameters: + sources (list) : An instance of list + """ + + if sources is not None and not isinstance(sources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources EXPECTED TYPE: list', None, None) + + self.__sources = sources + self.__key_modified['sources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs.py new file mode 100644 index 0000000..a00bcb6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Jobs(object): + def __init__(self): + """Creates an instance of Jobs""" + + self.__status = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs_wrapper.py new file mode 100644 index 0000000..929408f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class JobsWrapper(object): + def __init__(self): + """Creates an instance of JobsWrapper""" + + self.__deletion_jobs = None + self.__key_modified = dict() + + def get_deletion_jobs(self): + """ + The method to get the deletion_jobs + + Returns: + list: An instance of list + """ + + return self.__deletion_jobs + + def set_deletion_jobs(self, deletion_jobs): + """ + The method to set the value to deletion_jobs + + Parameters: + deletion_jobs (list) : An instance of list + """ + + if deletion_jobs is not None and not isinstance(deletion_jobs, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deletion_jobs EXPECTED TYPE: list', None, None) + + self.__deletion_jobs = deletion_jobs + self.__key_modified['deletion_jobs'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/resource.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/resource.py new file mode 100644 index 0000000..ae2a6ea --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_wrapper.py new file mode 100644 index 0000000..a8935af --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__user_groups = None + self.__info = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/source.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/source.py new file mode 100644 index 0000000..bb1b4b7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/source.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Source(object): + def __init__(self): + """Creates an instance of Source""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources.py new file mode 100644 index 0000000..06aa2eb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Sources(object): + def __init__(self): + """Creates an instance of Sources""" + + self.__type = None + self.__source = None + self.__subordinates = None + self.__sub_territories = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + Source: An instance of Source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (Source) : An instance of Source + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.source import Source + except Exception: + from .source import Source + + if source is not None and not isinstance(source, Source): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: Source', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def get_sub_territories(self): + """ + The method to get the sub_territories + + Returns: + bool: A bool representing the sub_territories + """ + + return self.__sub_territories + + def set_sub_territories(self, sub_territories): + """ + The method to set the value to sub_territories + + Parameters: + sub_territories (bool) : A bool representing the sub_territories + """ + + if sub_territories is not None and not isinstance(sub_territories, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_territories EXPECTED TYPE: bool', None, None) + + self.__sub_territories = sub_territories + self.__key_modified['sub_territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count.py new file mode 100644 index 0000000..af627b5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SourcesCount(object): + def __init__(self): + """Creates an instance of SourcesCount""" + + self.__territories = None + self.__roles = None + self.__groups = None + self.__users = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + int: An int representing the territories + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (int) : An int representing the territories + """ + + if territories is not None and not isinstance(territories, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: int', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_roles(self): + """ + The method to get the roles + + Returns: + int: An int representing the roles + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (int) : An int representing the roles + """ + + if roles is not None and not isinstance(roles, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: int', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def get_groups(self): + """ + The method to get the groups + + Returns: + int: An int representing the groups + """ + + return self.__groups + + def set_groups(self, groups): + """ + The method to set the value to groups + + Parameters: + groups (int) : An int representing the groups + """ + + if groups is not None and not isinstance(groups, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: groups EXPECTED TYPE: int', None, None) + + self.__groups = groups + self.__key_modified['groups'] = 1 + + def get_users(self): + """ + The method to get the users + + Returns: + Users: An instance of Users + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.users import Users + except Exception: + from .users import Users + + if users is not None and not isinstance(users, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: Users', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count_wrapper.py new file mode 100644 index 0000000..0637c02 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class SourcesCountWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of SourcesCountWrapper""" + super().__init__() + + self.__sources_count = None + self.__key_modified = dict() + + def get_sources_count(self): + """ + The method to get the sources_count + + Returns: + list: An instance of list + """ + + return self.__sources_count + + def set_sources_count(self, sources_count): + """ + The method to set the value to sources_count + + Parameters: + sources_count (list) : An instance of list + """ + + if sources_count is not None and not isinstance(sources_count, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources_count EXPECTED TYPE: list', None, None) + + self.__sources_count = sources_count + self.__key_modified['sources_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_wrapper.py new file mode 100644 index 0000000..64dfedf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class SourcesWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of SourcesWrapper""" + super().__init__() + + self.__sources = None + self.__info = None + self.__key_modified = dict() + + def get_sources(self): + """ + The method to get the sources + + Returns: + list: An instance of list + """ + + return self.__sources + + def set_sources(self, sources): + """ + The method to set the value to sources + + Parameters: + sources (list) : An instance of list + """ + + if sources is not None and not isinstance(sources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources EXPECTED TYPE: list', None, None) + + self.__sources = sources + self.__key_modified['sources'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/success_response.py new file mode 100644 index 0000000..a68bbc8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_response.py new file mode 100644 index 0000000..93ba015 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class UnAssignedActionResponse(ABC): + def __init__(self): + """Creates an instance of UnAssignedActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_wrapper.py new file mode 100644 index 0000000..7419b77 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UnAssignedActionWrapper(object): + def __init__(self): + """Creates an instance of UnAssignedActionWrapper""" + + self.__get_unassigned = None + self.__key_modified = dict() + + def get_get_unassigned(self): + """ + The method to get the get_unassigned + + Returns: + UnAssignedActionResponse: An instance of UnAssignedActionResponse + """ + + return self.__get_unassigned + + def set_get_unassigned(self, get_unassigned): + """ + The method to set the value to get_unassigned + + Parameters: + get_unassigned (UnAssignedActionResponse) : An instance of UnAssignedActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.un_assigned_action_response import UnAssignedActionResponse + except Exception: + from .un_assigned_action_response import UnAssignedActionResponse + + if get_unassigned is not None and not isinstance(get_unassigned, UnAssignedActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_unassigned EXPECTED TYPE: UnAssignedActionResponse', None, None) + + self.__get_unassigned = get_unassigned + self.__key_modified['get_unassigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_group.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_group.py new file mode 100644 index 0000000..c400cd0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_group.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UserGroup(object): + def __init__(self): + """Creates an instance of UserGroup""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_groups_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_groups_operations.py new file mode 100644 index 0000000..c656c7a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_groups_operations.py @@ -0,0 +1,411 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UserGroupsOperations(object): + def __init__(self): + """Creates an instance of UserGroupsOperations""" + pass + + def get_groups(self, param_instance=None): + """ + The method to get groups + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/user_groups' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_groups(self, request): + """ + The method to create groups + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/user_groups' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_groups(self, request): + """ + The method to update groups + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/user_groups' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_group(self, group): + """ + The method to get group + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_group(self, group, request): + """ + The method to update group + + Parameters: + group (int) : An int representing the group + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group 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/v7/settings/user_groups/' + api_path = api_path + str(group) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_group(self, group): + """ + The method to delete group + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_sources(self, group, param_instance=None): + """ + The method to get sources + + Parameters: + group (int) : An int representing the group + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + 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/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/sources' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_sources_count(self, group): + """ + The method to get sources count + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/actions/sources_count' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associations(self, group): + """ + The method to get associations + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/actions/associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associated_users_count(self): + """ + The method to get associated users count + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/actions/associated_users_count' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_grouped_counts(self, group, param_instance=None): + """ + The method to get grouped counts + + Parameters: + group (int) : An int representing the group + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + 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/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/associated_users/actions/grouped_counts' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetGroupsParam(object): + include = Param('include', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + name = Param('name', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + page = Param('page', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + per_page = Param('per_page', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + filters = Param('filters', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + + +class GetSourcesParam(object): + type = Param('type', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + user_type = Param('user_type', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + page = Param('page', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + per_page = Param('per_page', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + + +class GetGroupedCountsParam(object): + group_by = Param('group_by', 'com.zoho.crm.api.UserGroups.GetGroupedCountsParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/users.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/users.py new file mode 100644 index 0000000..8ab92e6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_groups/users.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Users(object): + def __init__(self): + """Creates an instance of Users""" + + self.__inactive = None + self.__deleted = None + self.__active = None + self.__key_modified = dict() + + def get_inactive(self): + """ + The method to get the inactive + + Returns: + int: An int representing the inactive + """ + + return self.__inactive + + def set_inactive(self, inactive): + """ + The method to set the value to inactive + + Parameters: + inactive (int) : An int representing the inactive + """ + + if inactive is not None and not isinstance(inactive, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inactive EXPECTED TYPE: int', None, None) + + self.__inactive = inactive + self.__key_modified['inactive'] = 1 + + def get_deleted(self): + """ + The method to get the deleted + + Returns: + int: An int representing the deleted + """ + + return self.__deleted + + def set_deleted(self, deleted): + """ + The method to set the value to deleted + + Parameters: + deleted (int) : An int representing the deleted + """ + + if deleted is not None and not isinstance(deleted, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted EXPECTED TYPE: int', None, None) + + self.__deleted = deleted + self.__key_modified['deleted'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + int: An int representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (int) : An int representing the active + """ + + if active is not None and not isinstance(active, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: int', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_signature.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_signature.py new file mode 100755 index 0000000..726bdec --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_signature.py @@ -0,0 +1,36 @@ +try: + import re + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + +except Exception: + import re + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from .util.constants import Constants + + +class UserSignature(object): + + """ + This class represents the Zoho CRM User. + """ + + def __init__(self, name): + + """ + Creates an UserSignature class instance with the specified user email. + + Parameters: + email (str) : A string containing the CRM user email + """ + self.__name = name + + def get_name(self): + """ + This is a getter method to get __name. + + Returns: + string: A string representing __name + """ + + return self.__name diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/__init__.py new file mode 100644 index 0000000..95cee17 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/__init__.py @@ -0,0 +1,14 @@ +from .status_action_response import StatusActionResponse +from .action_wrapper import ActionWrapper +from .status_action_wrapper import StatusActionWrapper +from .status_action_handler import StatusActionHandler +from .body_wrapper import BodyWrapper +from .users import Users +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .user_type_users_operations import UserTypeUsersOperations, GetUsersOfUserTypeParam, DeleteUserFromThePortalParam, TransferUsersOfAUserTypeParam, ChangeUsersStatusParam +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_wrapper.py new file mode 100644 index 0000000..0b97467 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/api_exception.py new file mode 100644 index 0000000..a880afd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_response import StatusActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_handler import StatusActionHandler + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .status_action_handler import StatusActionHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse, StatusActionHandler, StatusActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/body_wrapper.py new file mode 100644 index 0000000..9160577 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/info.py new file mode 100644 index 0000000..69c3623 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/info.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__total_count = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['total_count'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_wrapper.py new file mode 100644 index 0000000..524a23b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users = None + self.__info = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_handler.py new file mode 100644 index 0000000..e42d843 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusActionHandler(ABC): + def __init__(self): + """Creates an instance of StatusActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_response.py new file mode 100644 index 0000000..ff1c58b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusActionResponse(ABC): + def __init__(self): + """Creates an instance of StatusActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_wrapper.py new file mode 100644 index 0000000..bdbc4e5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_handler import StatusActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .status_action_handler import StatusActionHandler + + +class StatusActionWrapper(StatusActionHandler): + def __init__(self): + """Creates an instance of StatusActionWrapper""" + super().__init__() + + self.__change_status = None + self.__key_modified = dict() + + def get_change_status(self): + """ + The method to get the change_status + + Returns: + list: An instance of list + """ + + return self.__change_status + + def set_change_status(self, change_status): + """ + The method to set the value to change_status + + Parameters: + change_status (list) : An instance of list + """ + + if change_status is not None and not isinstance(change_status, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: change_status EXPECTED TYPE: list', None, None) + + self.__change_status = change_status + self.__key_modified['change_status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/success_response.py new file mode 100644 index 0000000..181018e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_response import StatusActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + from .action_response import ActionResponse + + +class SuccessResponse(StatusActionResponse, ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/user_type_users_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/user_type_users_operations.py new file mode 100644 index 0000000..8b04090 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/user_type_users_operations.py @@ -0,0 +1,211 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UserTypeUsersOperations(object): + def __init__(self, user_type_id, portal_name): + """ + Creates an instance of UserTypeUsersOperations with the given parameters + + Parameters: + user_type_id (int) : An int representing the user_type_id + portal_name (string) : A string representing the portal_name + """ + + if not isinstance(user_type_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: int', None, None) + + if not isinstance(portal_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_name EXPECTED TYPE: str', None, None) + + self.__user_type_id = user_type_id + self.__portal_name = portal_name + + + def get_users_of_user_type(self, param_instance=None): + """ + The method to get users of user type + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_user_from_the_portal(self, param_instance=None): + """ + The method to delete user from the portal + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def transfer_users_of_a_user_type(self, param_instance=None): + """ + The method to transfer users of a user type + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users/action/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_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def change_users_status(self, user_id, param_instance=None): + """ + The method to change users status + + Parameters: + user_id (int) : An int representing the user_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(user_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_id EXPECTED TYPE: int', None, None) + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users/' + api_path = api_path + str(user_id) + api_path = api_path + '/actions/change_status' + 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_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_handler import StatusActionHandler + except Exception: + from .status_action_handler import StatusActionHandler + return handler_instance.api_call(StatusActionHandler.__module__, 'application/json') + + +class GetUsersOfUserTypeParam(object): + filter = Param('filter', 'com.zoho.crm.api.UserTypeUsers.GetUsersOfUserTypeParam') + type = Param('type', 'com.zoho.crm.api.UserTypeUsers.GetUsersOfUserTypeParam') + + +class DeleteUserFromThePortalParam(object): + personality_ids = Param('personality_ids', 'com.zoho.crm.api.UserTypeUsers.DeleteUserFromThePortalParam') + + +class TransferUsersOfAUserTypeParam(object): + personality_ids = Param('personality_ids', 'com.zoho.crm.api.UserTypeUsers.TransferUsersOfAUserTypeParam') + transfer_to = Param('transfer_To', 'com.zoho.crm.api.UserTypeUsers.TransferUsersOfAUserTypeParam') + + +class ChangeUsersStatusParam(object): + active = Param('active', 'com.zoho.crm.api.UserTypeUsers.ChangeUsersStatusParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/users.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/users.py new file mode 100644 index 0000000..6a55577 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/user_type_users/users.py @@ -0,0 +1,251 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Users(object): + def __init__(self): + """Creates an instance of Users""" + + self.__personality_id = None + self.__confirm = None + self.__status_reason__s = None + self.__invited_time = None + self.__module = None + self.__name = None + self.__active = None + self.__email = None + self.__key_modified = dict() + + def get_personality_id(self): + """ + The method to get the personality_id + + Returns: + int: An int representing the personality_id + """ + + return self.__personality_id + + def set_personality_id(self, personality_id): + """ + The method to set the value to personality_id + + Parameters: + personality_id (int) : An int representing the personality_id + """ + + if personality_id is not None and not isinstance(personality_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: personality_id EXPECTED TYPE: int', None, None) + + self.__personality_id = personality_id + self.__key_modified['personality_id'] = 1 + + def get_confirm(self): + """ + The method to get the confirm + + Returns: + bool: A bool representing the confirm + """ + + return self.__confirm + + def set_confirm(self, confirm): + """ + The method to set the value to confirm + + Parameters: + confirm (bool) : A bool representing the confirm + """ + + if confirm is not None and not isinstance(confirm, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: confirm EXPECTED TYPE: bool', None, None) + + self.__confirm = confirm + self.__key_modified['confirm'] = 1 + + def get_status_reason__s(self): + """ + The method to get the status_reason__s + + Returns: + string: A string representing the status_reason__s + """ + + return self.__status_reason__s + + def set_status_reason__s(self, status_reason__s): + """ + The method to set the value to status_reason__s + + Parameters: + status_reason__s (string) : A string representing the status_reason__s + """ + + if status_reason__s is not None and not isinstance(status_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status_reason__s EXPECTED TYPE: str', None, None) + + self.__status_reason__s = status_reason__s + self.__key_modified['status_reason__s'] = 1 + + def get_invited_time(self): + """ + The method to get the invited_time + + Returns: + datetime: An instance of datetime + """ + + return self.__invited_time + + def set_invited_time(self, invited_time): + """ + The method to set the value to invited_time + + Parameters: + invited_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if invited_time is not None and not isinstance(invited_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: invited_time EXPECTED TYPE: datetime', None, None) + + self.__invited_time = invited_time + self.__key_modified['invited_time'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/__init__.py new file mode 100644 index 0000000..c92a57a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/__init__.py @@ -0,0 +1,23 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .users_operations import UsersOperations, GetUsersParam, GetUsersHeader, GetUserHeader, GetAssociatedGroupsParam, UsersCountParam +from .customize_info import CustomizeInfo +from .role import Role +from .associated_group import AssociatedGroup +from .minified_user import MinifiedUser +from .profile import Profile +from .shift import Shift +from .associated_groups_wrapper import AssociatedGroupsWrapper +from .body_wrapper import BodyWrapper +from .users import Users +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .count_wrapper import CountWrapper +from .tab import Tab +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .count_handler import CountHandler +from .action_handler import ActionHandler +from .theme import Theme +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_wrapper.py new file mode 100644 index 0000000..514fe13 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..territory_users import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/api_exception.py new file mode 100644 index 0000000..3831d9d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users.count_handler import CountHandler + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .count_handler import CountHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler, CountHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/associated_group.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/associated_group.py new file mode 100644 index 0000000..0c9822c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/associated_group.py @@ -0,0 +1,238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedGroup(object): + def __init__(self): + """Creates an instance of AssociatedGroup""" + + self.__id = None + self.__name = None + self.__description = None + self.__created_time = None + self.__modified_time = None + self.__created_by = None + self.__modified_by = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/associated_groups_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/associated_groups_wrapper.py new file mode 100644 index 0000000..74065ff --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/associated_groups_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociatedGroupsWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of AssociatedGroupsWrapper""" + super().__init__() + + self.__user_groups = None + self.__info = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/body_wrapper.py new file mode 100644 index 0000000..9160577 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/count_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/count_handler.py new file mode 100644 index 0000000..6c4eb60 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/count_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class CountHandler(ABC): + def __init__(self): + """Creates an instance of CountHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/count_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/count_wrapper.py new file mode 100644 index 0000000..d34cbe0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/count_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users.count_handler import CountHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .count_handler import CountHandler + + +class CountWrapper(CountHandler): + def __init__(self): + """Creates an instance of CountWrapper""" + super().__init__() + + self.__count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/customize_info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/customize_info.py new file mode 100644 index 0000000..e309911 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/customize_info.py @@ -0,0 +1,187 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CustomizeInfo(object): + def __init__(self): + """Creates an instance of CustomizeInfo""" + + self.__notes_desc = None + self.__show_right_panel = None + self.__bc_view = None + self.__unpin_recent_item = None + self.__show_home = None + self.__show_detail_view = None + self.__key_modified = dict() + + def get_notes_desc(self): + """ + The method to get the notes_desc + + Returns: + Object: A Object representing the notes_desc + """ + + return self.__notes_desc + + def set_notes_desc(self, notes_desc): + """ + The method to set the value to notes_desc + + Parameters: + notes_desc (Object) : A Object representing the notes_desc + """ + + self.__notes_desc = notes_desc + self.__key_modified['notes_desc'] = 1 + + def get_show_right_panel(self): + """ + The method to get the show_right_panel + + Returns: + Object: A Object representing the show_right_panel + """ + + return self.__show_right_panel + + def set_show_right_panel(self, show_right_panel): + """ + The method to set the value to show_right_panel + + Parameters: + show_right_panel (Object) : A Object representing the show_right_panel + """ + + self.__show_right_panel = show_right_panel + self.__key_modified['show_right_panel'] = 1 + + def get_bc_view(self): + """ + The method to get the bc_view + + Returns: + Object: A Object representing the bc_view + """ + + return self.__bc_view + + def set_bc_view(self, bc_view): + """ + The method to set the value to bc_view + + Parameters: + bc_view (Object) : A Object representing the bc_view + """ + + self.__bc_view = bc_view + self.__key_modified['bc_view'] = 1 + + def get_unpin_recent_item(self): + """ + The method to get the unpin_recent_item + + Returns: + Object: A Object representing the unpin_recent_item + """ + + return self.__unpin_recent_item + + def set_unpin_recent_item(self, unpin_recent_item): + """ + The method to set the value to unpin_recent_item + + Parameters: + unpin_recent_item (Object) : A Object representing the unpin_recent_item + """ + + self.__unpin_recent_item = unpin_recent_item + self.__key_modified['unpin_recent_item'] = 1 + + def get_show_home(self): + """ + The method to get the show_home + + Returns: + bool: A bool representing the show_home + """ + + return self.__show_home + + def set_show_home(self, show_home): + """ + The method to set the value to show_home + + Parameters: + show_home (bool) : A bool representing the show_home + """ + + if show_home is not None and not isinstance(show_home, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_home EXPECTED TYPE: bool', None, None) + + self.__show_home = show_home + self.__key_modified['show_home'] = 1 + + def get_show_detail_view(self): + """ + The method to get the show_detail_view + + Returns: + bool: A bool representing the show_detail_view + """ + + return self.__show_detail_view + + def set_show_detail_view(self, show_detail_view): + """ + The method to set the value to show_detail_view + + Parameters: + show_detail_view (bool) : A bool representing the show_detail_view + """ + + if show_detail_view is not None and not isinstance(show_detail_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_detail_view EXPECTED TYPE: bool', None, None) + + self.__show_detail_view = show_detail_view + self.__key_modified['show_detail_view'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/minified_user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/minified_user.py new file mode 100644 index 0000000..70e582a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/minified_user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedUser(object): + def __init__(self): + """Creates an instance of MinifiedUser""" + + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/owner.py new file mode 100644 index 0000000..58dfca6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/owner.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__last_name = None + self.__first_name = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_last_name(self): + """ + The method to get the last_name + + Returns: + string: A string representing the last_name + """ + + return self.__last_name + + def set_last_name(self, last_name): + """ + The method to set the value to last_name + + Parameters: + last_name (string) : A string representing the last_name + """ + + if last_name is not None and not isinstance(last_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_name EXPECTED TYPE: str', None, None) + + self.__last_name = last_name + self.__key_modified['last_name'] = 1 + + def get_first_name(self): + """ + The method to get the first_name + + Returns: + string: A string representing the first_name + """ + + return self.__first_name + + def set_first_name(self, first_name): + """ + The method to set the value to first_name + + Parameters: + first_name (string) : A string representing the first_name + """ + + if first_name is not None and not isinstance(first_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_name EXPECTED TYPE: str', None, None) + + self.__first_name = first_name + self.__key_modified['first_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/profile.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/profile.py new file mode 100644 index 0000000..fa877f9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/profile.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/response_wrapper.py new file mode 100644 index 0000000..8ccfef8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users = None + self.__info = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/role.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/role.py new file mode 100644 index 0000000..bba4d98 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/role.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Role(object): + def __init__(self): + """Creates an instance of Role""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/shift.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/shift.py new file mode 100644 index 0000000..160ad67 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/shift.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Shift(object): + def __init__(self): + """Creates an instance of Shift""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/success_response.py new file mode 100644 index 0000000..d3f9b45 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/tab.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/tab.py new file mode 100644 index 0000000..f9be85e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/tab.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Tab(object): + def __init__(self): + """Creates an instance of Tab""" + + self.__font_color = None + self.__background = None + self.__key_modified = dict() + + def get_font_color(self): + """ + The method to get the font_color + + Returns: + Choice: An instance of Choice + """ + + return self.__font_color + + def set_font_color(self, font_color): + """ + The method to set the value to font_color + + Parameters: + font_color (Choice) : An instance of Choice + """ + + if font_color is not None and not isinstance(font_color, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: font_color EXPECTED TYPE: Choice', None, None) + + self.__font_color = font_color + self.__key_modified['font_color'] = 1 + + def get_background(self): + """ + The method to get the background + + Returns: + Choice: An instance of Choice + """ + + return self.__background + + def set_background(self, background): + """ + The method to set the value to background + + Parameters: + background (Choice) : An instance of Choice + """ + + if background is not None and not isinstance(background, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: background EXPECTED TYPE: Choice', None, None) + + self.__background = background + self.__key_modified['background'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/theme.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/theme.py new file mode 100644 index 0000000..b123ef6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/theme.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Theme(object): + def __init__(self): + """Creates an instance of Theme""" + + self.__normal_tab = None + self.__selected_tab = None + self.__new_background = None + self.__background = None + self.__screen = None + self.__type = None + self.__key_modified = dict() + + def get_normal_tab(self): + """ + The method to get the normal_tab + + Returns: + Tab: An instance of Tab + """ + + return self.__normal_tab + + def set_normal_tab(self, normal_tab): + """ + The method to set the value to normal_tab + + Parameters: + normal_tab (Tab) : An instance of Tab + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.tab import Tab + except Exception: + from .tab import Tab + + if normal_tab is not None and not isinstance(normal_tab, Tab): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: normal_tab EXPECTED TYPE: Tab', None, None) + + self.__normal_tab = normal_tab + self.__key_modified['normal_tab'] = 1 + + def get_selected_tab(self): + """ + The method to get the selected_tab + + Returns: + Tab: An instance of Tab + """ + + return self.__selected_tab + + def set_selected_tab(self, selected_tab): + """ + The method to set the value to selected_tab + + Parameters: + selected_tab (Tab) : An instance of Tab + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.tab import Tab + except Exception: + from .tab import Tab + + if selected_tab is not None and not isinstance(selected_tab, Tab): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: selected_tab EXPECTED TYPE: Tab', None, None) + + self.__selected_tab = selected_tab + self.__key_modified['selected_tab'] = 1 + + def get_new_background(self): + """ + The method to get the new_background + + Returns: + string: A string representing the new_background + """ + + return self.__new_background + + def set_new_background(self, new_background): + """ + The method to set the value to new_background + + Parameters: + new_background (string) : A string representing the new_background + """ + + if new_background is not None and not isinstance(new_background, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: new_background EXPECTED TYPE: str', None, None) + + self.__new_background = new_background + self.__key_modified['new_background'] = 1 + + def get_background(self): + """ + The method to get the background + + Returns: + Choice: An instance of Choice + """ + + return self.__background + + def set_background(self, background): + """ + The method to set the value to background + + Parameters: + background (Choice) : An instance of Choice + """ + + if background is not None and not isinstance(background, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: background EXPECTED TYPE: Choice', None, None) + + self.__background = background + self.__key_modified['background'] = 1 + + def get_screen(self): + """ + The method to get the screen + + Returns: + Choice: An instance of Choice + """ + + return self.__screen + + def set_screen(self, screen): + """ + The method to set the value to screen + + Parameters: + screen (Choice) : An instance of Choice + """ + + if screen is not None and not isinstance(screen, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screen EXPECTED TYPE: Choice', None, None) + + self.__screen = screen + self.__key_modified['screen'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/users.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/users.py new file mode 100644 index 0000000..87b6864 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/users.py @@ -0,0 +1,1516 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record import Record +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from ..record import Record + + +class Users(Record): + def __init__(self): + """Creates an instance of Users""" + super().__init__() + + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.get_key_value('country') + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.add_key_value('country', country) + + def get_language(self): + """ + The method to get the language + + Returns: + string: A string representing the language + """ + + return self.get_key_value('language') + + def set_language(self, language): + """ + The method to set the value to language + + Parameters: + language (string) : A string representing the language + """ + + if language is not None and not isinstance(language, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: language EXPECTED TYPE: str', None, None) + + self.add_key_value('language', language) + + def get_microsoft(self): + """ + The method to get the microsoft + + Returns: + bool: A bool representing the microsoft + """ + + return self.get_key_value('microsoft') + + def set_microsoft(self, microsoft): + """ + The method to set the value to microsoft + + Parameters: + microsoft (bool) : A bool representing the microsoft + """ + + if microsoft is not None and not isinstance(microsoft, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: microsoft EXPECTED TYPE: bool', None, None) + + self.add_key_value('microsoft', microsoft) + + def get_shift_effective_from(self): + """ + The method to get the shift_effective_from + + Returns: + Object: A Object representing the shift_effective_from + """ + + return self.get_key_value('$shift_effective_from') + + def set_shift_effective_from(self, shift_effective_from): + """ + The method to set the value to shift_effective_from + + Parameters: + shift_effective_from (Object) : A Object representing the shift_effective_from + """ + + self.add_key_value('$shift_effective_from', shift_effective_from) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.get_key_value('state') + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.add_key_value('state', state) + + def get_fax(self): + """ + The method to get the fax + + Returns: + string: A string representing the fax + """ + + return self.get_key_value('fax') + + def set_fax(self, fax): + """ + The method to set the value to fax + + Parameters: + fax (string) : A string representing the fax + """ + + if fax is not None and not isinstance(fax, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fax EXPECTED TYPE: str', None, None) + + self.add_key_value('fax', fax) + + def get_country_locale(self): + """ + The method to get the country_locale + + Returns: + string: A string representing the country_locale + """ + + return self.get_key_value('country_locale') + + def set_country_locale(self, country_locale): + """ + The method to set the value to country_locale + + Parameters: + country_locale (string) : A string representing the country_locale + """ + + if country_locale is not None and not isinstance(country_locale, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country_locale EXPECTED TYPE: str', None, None) + + self.add_key_value('country_locale', country_locale) + + def get_zip(self): + """ + The method to get the zip + + Returns: + string: A string representing the zip + """ + + return self.get_key_value('zip') + + def set_zip(self, zip): + """ + The method to set the value to zip + + Parameters: + zip (string) : A string representing the zip + """ + + if zip is not None and not isinstance(zip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zip EXPECTED TYPE: str', None, None) + + self.add_key_value('zip', zip) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('created_time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('created_time', created_time) + + def get_time_format(self): + """ + The method to get the time_format + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('time_format') + + def set_time_format(self, time_format): + """ + The method to set the value to time_format + + Parameters: + time_format (Choice) : An instance of Choice + """ + + if time_format is not None and not isinstance(time_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time_format EXPECTED TYPE: Choice', None, None) + + self.add_key_value('time_format', time_format) + + def get_offset(self): + """ + The method to get the offset + + Returns: + int: An int representing the offset + """ + + return self.get_key_value('offset') + + def set_offset(self, offset): + """ + The method to set the value to offset + + Parameters: + offset (int) : An int representing the offset + """ + + if offset is not None and not isinstance(offset, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: offset EXPECTED TYPE: int', None, None) + + self.add_key_value('offset', offset) + + def get_imap_status(self): + """ + The method to get the imap_status + + Returns: + bool: A bool representing the imap_status + """ + + return self.get_key_value('imap_status') + + def set_imap_status(self, imap_status): + """ + The method to set the value to imap_status + + Parameters: + imap_status (bool) : A bool representing the imap_status + """ + + if imap_status is not None and not isinstance(imap_status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: imap_status EXPECTED TYPE: bool', None, None) + + self.add_key_value('imap_status', imap_status) + + def get_image_link(self): + """ + The method to get the image_link + + Returns: + string: A string representing the image_link + """ + + return self.get_key_value('image_link') + + def set_image_link(self, image_link): + """ + The method to set the value to image_link + + Parameters: + image_link (string) : A string representing the image_link + """ + + if image_link is not None and not isinstance(image_link, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: image_link EXPECTED TYPE: str', None, None) + + self.add_key_value('image_link', image_link) + + def get_ezuid(self): + """ + The method to get the ezuid + + Returns: + string: A string representing the ezuid + """ + + return self.get_key_value('ezuid') + + def set_ezuid(self, ezuid): + """ + The method to set the value to ezuid + + Parameters: + ezuid (string) : A string representing the ezuid + """ + + if ezuid is not None and not isinstance(ezuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ezuid EXPECTED TYPE: str', None, None) + + self.add_key_value('ezuid', ezuid) + + def get_profile(self): + """ + The method to get the profile + + Returns: + Profile: An instance of Profile + """ + + return self.get_key_value('profile') + + def set_profile(self, profile): + """ + The method to set the value to profile + + Parameters: + profile (Profile) : An instance of Profile + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.profile import Profile + except Exception: + from .profile import Profile + + if profile is not None and not isinstance(profile, Profile): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profile EXPECTED TYPE: Profile', None, None) + + self.add_key_value('profile', profile) + + def get_role(self): + """ + The method to get the role + + Returns: + Role: An instance of Role + """ + + return self.get_key_value('role') + + def set_role(self, role): + """ + The method to set the value to role + + Parameters: + role (Role) : An instance of Role + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.role import Role + except Exception: + from .role import Role + + if role is not None and not isinstance(role, Role): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role EXPECTED TYPE: Role', None, None) + + self.add_key_value('role', role) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('created_by') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('created_by', created_by) + + def get_full_name(self): + """ + The method to get the full_name + + Returns: + string: A string representing the full_name + """ + + return self.get_key_value('full_name') + + def set_full_name(self, full_name): + """ + The method to set the value to full_name + + Parameters: + full_name (string) : A string representing the full_name + """ + + if full_name is not None and not isinstance(full_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: full_name EXPECTED TYPE: str', None, None) + + self.add_key_value('full_name', full_name) + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.get_key_value('zuid') + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.add_key_value('zuid', zuid) + + def get_phone(self): + """ + The method to get the phone + + Returns: + string: A string representing the phone + """ + + return self.get_key_value('phone') + + def set_phone(self, phone): + """ + The method to set the value to phone + + Parameters: + phone (string) : A string representing the phone + """ + + if phone is not None and not isinstance(phone, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: phone EXPECTED TYPE: str', None, None) + + self.add_key_value('phone', phone) + + def get_dob(self): + """ + The method to get the dob + + Returns: + date: An instance of date + """ + + return self.get_key_value('dob') + + def set_dob(self, dob): + """ + The method to set the value to dob + + Parameters: + dob (date) : An instance of date + """ + + from datetime import date as date1 + + if dob is not None and not isinstance(dob, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dob EXPECTED TYPE: date1', None, None) + + self.add_key_value('dob', dob) + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.get_key_value('status') + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.add_key_value('status', status) + + def get_customize_info(self): + """ + The method to get the customize_info + + Returns: + CustomizeInfo: An instance of CustomizeInfo + """ + + return self.get_key_value('customize_info') + + def set_customize_info(self, customize_info): + """ + The method to set the value to customize_info + + Parameters: + customize_info (CustomizeInfo) : An instance of CustomizeInfo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.customize_info import CustomizeInfo + except Exception: + from .customize_info import CustomizeInfo + + if customize_info is not None and not isinstance(customize_info, CustomizeInfo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_info EXPECTED TYPE: CustomizeInfo', None, None) + + self.add_key_value('customize_info', customize_info) + + def get_city(self): + """ + The method to get the city + + Returns: + string: A string representing the city + """ + + return self.get_key_value('city') + + def set_city(self, city): + """ + The method to set the value to city + + Parameters: + city (string) : A string representing the city + """ + + if city is not None and not isinstance(city, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: city EXPECTED TYPE: str', None, None) + + self.add_key_value('city', city) + + def get_signature(self): + """ + The method to get the signature + + Returns: + string: A string representing the signature + """ + + return self.get_key_value('signature') + + def set_signature(self, signature): + """ + The method to set the value to signature + + Parameters: + signature (string) : A string representing the signature + """ + + if signature is not None and not isinstance(signature, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signature EXPECTED TYPE: str', None, None) + + self.add_key_value('signature', signature) + + def get_sort_order_preference__s(self): + """ + The method to get the sort_order_preference__s + + Returns: + string: A string representing the sort_order_preference__s + """ + + return self.get_key_value('sort_order_preference__s') + + def set_sort_order_preference__s(self, sort_order_preference__s): + """ + The method to set the value to sort_order_preference__s + + Parameters: + sort_order_preference__s (string) : A string representing the sort_order_preference__s + """ + + if sort_order_preference__s is not None and not isinstance(sort_order_preference__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order_preference__s EXPECTED TYPE: str', None, None) + + self.add_key_value('sort_order_preference__s', sort_order_preference__s) + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.get_key_value('category') + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.add_key_value('category', category) + + def get_date_format(self): + """ + The method to get the date_format + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('date_format') + + def set_date_format(self, date_format): + """ + The method to set the value to date_format + + Parameters: + date_format (Choice) : An instance of Choice + """ + + if date_format is not None and not isinstance(date_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date_format EXPECTED TYPE: Choice', None, None) + + self.add_key_value('date_format', date_format) + + def get_confirm(self): + """ + The method to get the confirm + + Returns: + bool: A bool representing the confirm + """ + + return self.get_key_value('confirm') + + def set_confirm(self, confirm): + """ + The method to set the value to confirm + + Parameters: + confirm (bool) : A bool representing the confirm + """ + + if confirm is not None and not isinstance(confirm, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: confirm EXPECTED TYPE: bool', None, None) + + self.add_key_value('confirm', confirm) + + def get_decimal_separator(self): + """ + The method to get the decimal_separator + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('decimal_separator') + + def set_decimal_separator(self, decimal_separator): + """ + The method to set the value to decimal_separator + + Parameters: + decimal_separator (Choice) : An instance of Choice + """ + + if decimal_separator is not None and not isinstance(decimal_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_separator EXPECTED TYPE: Choice', None, None) + + self.add_key_value('decimal_separator', decimal_separator) + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('number_separator') + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (Choice) : An instance of Choice + """ + + if number_separator is not None and not isinstance(number_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: Choice', None, None) + + self.add_key_value('number_separator', number_separator) + + def get_time_zone(self): + """ + The method to get the time_zone + + Returns: + string: An instance of string + """ + + return self.get_key_value('time_zone') + + def set_time_zone(self, time_zone): + """ + The method to set the value to time_zone + + Parameters: + time_zone (string) : An instance of string + """ + + self.add_key_value('time_zone', time_zone) + + def get_last_name(self): + """ + The method to get the last_name + + Returns: + string: A string representing the last_name + """ + + return self.get_key_value('last_name') + + def set_last_name(self, last_name): + """ + The method to set the value to last_name + + Parameters: + last_name (string) : A string representing the last_name + """ + + if last_name is not None and not isinstance(last_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_name EXPECTED TYPE: str', None, None) + + self.add_key_value('last_name', last_name) + + def get_mobile(self): + """ + The method to get the mobile + + Returns: + string: A string representing the mobile + """ + + return self.get_key_value('mobile') + + def set_mobile(self, mobile): + """ + The method to set the value to mobile + + Parameters: + mobile (string) : A string representing the mobile + """ + + if mobile is not None and not isinstance(mobile, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mobile EXPECTED TYPE: str', None, None) + + self.add_key_value('mobile', mobile) + + def get_current_shift(self): + """ + The method to get the current_shift + + Returns: + Shift: An instance of Shift + """ + + return self.get_key_value('$current_shift') + + def set_current_shift(self, current_shift): + """ + The method to set the value to current_shift + + Parameters: + current_shift (Shift) : An instance of Shift + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.shift import Shift + except Exception: + from .shift import Shift + + if current_shift is not None and not isinstance(current_shift, Shift): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: current_shift EXPECTED TYPE: Shift', None, None) + + self.add_key_value('$current_shift', current_shift) + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Reporting_To') + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if reporting_to is not None and not isinstance(reporting_to, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Reporting_To', reporting_to) + + def get_currency(self): + """ + The method to get the currency + + Returns: + string: A string representing the currency + """ + + return self.get_key_value('Currency') + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (string) : A string representing the currency + """ + + if currency is not None and not isinstance(currency, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: str', None, None) + + self.add_key_value('Currency', currency) + + def get_next_shift(self): + """ + The method to get the next_shift + + Returns: + Shift: An instance of Shift + """ + + return self.get_key_value('$next_shift') + + def set_next_shift(self, next_shift): + """ + The method to set the value to next_shift + + Parameters: + next_shift (Shift) : An instance of Shift + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.shift import Shift + except Exception: + from .shift import Shift + + if next_shift is not None and not isinstance(next_shift, Shift): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_shift EXPECTED TYPE: Shift', None, None) + + self.add_key_value('$next_shift', next_shift) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.get_key_value('website') + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.add_key_value('website', website) + + def get_status_reason__s(self): + """ + The method to get the status_reason__s + + Returns: + string: A string representing the status_reason__s + """ + + return self.get_key_value('status_reason__s') + + def set_status_reason__s(self, status_reason__s): + """ + The method to set the value to status_reason__s + + Parameters: + status_reason__s (string) : A string representing the status_reason__s + """ + + if status_reason__s is not None and not isinstance(status_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status_reason__s EXPECTED TYPE: str', None, None) + + self.add_key_value('status_reason__s', status_reason__s) + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.get_key_value('email') + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.add_key_value('email', email) + + def get_first_name(self): + """ + The method to get the first_name + + Returns: + string: A string representing the first_name + """ + + return self.get_key_value('first_name') + + def set_first_name(self, first_name): + """ + The method to set the value to first_name + + Parameters: + first_name (string) : A string representing the first_name + """ + + if first_name is not None and not isinstance(first_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_name EXPECTED TYPE: str', None, None) + + self.add_key_value('first_name', first_name) + + def get_sandboxdeveloper(self): + """ + The method to get the sandboxdeveloper + + Returns: + bool: A bool representing the sandboxdeveloper + """ + + return self.get_key_value('sandboxDeveloper') + + 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 get_alias(self): + """ + The method to get the alias + + Returns: + string: A string representing the alias + """ + + return self.get_key_value('alias') + + def set_alias(self, alias): + """ + The method to set the value to alias + + Parameters: + alias (string) : A string representing the alias + """ + + if alias is not None and not isinstance(alias, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alias EXPECTED TYPE: str', None, None) + + self.add_key_value('alias', alias) + + def get_street(self): + """ + The method to get the street + + Returns: + string: A string representing the street + """ + + return self.get_key_value('street') + + def set_street(self, street): + """ + The method to set the value to street + + Parameters: + street (string) : A string representing the street + """ + + if street is not None and not isinstance(street, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: street EXPECTED TYPE: str', None, None) + + self.add_key_value('street', street) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_isonline(self): + """ + The method to get the isonline + + Returns: + bool: A bool representing the isonline + """ + + return self.get_key_value('Isonline') + + def set_isonline(self, isonline): + """ + The method to set the value to isonline + + Parameters: + isonline (bool) : A bool representing the isonline + """ + + if isonline is not None and not isinstance(isonline, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isonline EXPECTED TYPE: bool', None, None) + + self.add_key_value('Isonline', isonline) + + def get_locale(self): + """ + The method to get the locale + + Returns: + string: A string representing the locale + """ + + return self.get_key_value('locale') + + def set_locale(self, locale): + """ + The method to set the value to locale + + Parameters: + locale (string) : A string representing the locale + """ + + if locale is not None and not isinstance(locale, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locale EXPECTED TYPE: str', None, None) + + self.add_key_value('locale', locale) + + def get_name_format__s(self): + """ + The method to get the name_format__s + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('name_format__s') + + def set_name_format__s(self, name_format__s): + """ + The method to set the value to name_format__s + + Parameters: + name_format__s (Choice) : An instance of Choice + """ + + if name_format__s is not None and not isinstance(name_format__s, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name_format__s EXPECTED TYPE: Choice', None, None) + + self.add_key_value('name_format__s', name_format__s) + + def get_personal_account(self): + """ + The method to get the personal_account + + Returns: + bool: A bool representing the personal_account + """ + + return self.get_key_value('personal_account') + + 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 get_default_tab_group(self): + """ + The method to get the default_tab_group + + Returns: + string: A string representing the default_tab_group + """ + + return self.get_key_value('default_tab_group') + + 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 get_theme(self): + """ + The method to get the theme + + Returns: + Theme: An instance of Theme + """ + + return self.get_key_value('theme') + + def set_theme(self, theme): + """ + The method to set the value to theme + + Parameters: + theme (Theme) : An instance of Theme + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.theme import Theme + except Exception: + from .theme import Theme + + if theme is not None and not isinstance(theme, Theme): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: theme EXPECTED TYPE: Theme', None, None) + + self.add_key_value('theme', theme) + + def get_ntc_notification_type(self): + """ + The method to get the ntc_notification_type + + Returns: + list: An instance of list + """ + + return self.get_key_value('ntc_notification_type') + + def set_ntc_notification_type(self, ntc_notification_type): + """ + The method to set the value to ntc_notification_type + + Parameters: + ntc_notification_type (list) : An instance of list + """ + + if ntc_notification_type is not None and not isinstance(ntc_notification_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ntc_notification_type EXPECTED TYPE: list', None, None) + + self.add_key_value('ntc_notification_type', ntc_notification_type) + + def get_ntc_enabled(self): + """ + The method to get the ntc_enabled + + Returns: + bool: A bool representing the ntc_enabled + """ + + return self.get_key_value('ntc_enabled') + + def set_ntc_enabled(self, ntc_enabled): + """ + The method to set the value to ntc_enabled + + Parameters: + ntc_enabled (bool) : A bool representing the ntc_enabled + """ + + if ntc_enabled is not None and not isinstance(ntc_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ntc_enabled EXPECTED TYPE: bool', None, None) + + self.add_key_value('ntc_enabled', ntc_enabled) + + def get_rtl_enabled(self): + """ + The method to get the rtl_enabled + + Returns: + bool: A bool representing the rtl_enabled + """ + + return self.get_key_value('rtl_enabled') + + def set_rtl_enabled(self, rtl_enabled): + """ + The method to set the value to rtl_enabled + + Parameters: + rtl_enabled (bool) : A bool representing the rtl_enabled + """ + + if rtl_enabled is not None and not isinstance(rtl_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rtl_enabled EXPECTED TYPE: bool', None, None) + + self.add_key_value('rtl_enabled', rtl_enabled) + + def get_telephony_enabled(self): + """ + The method to get the telephony_enabled + + Returns: + bool: A bool representing the telephony_enabled + """ + + return self.get_key_value('telephony_enabled') + + def set_telephony_enabled(self, telephony_enabled): + """ + The method to set the value to telephony_enabled + + Parameters: + telephony_enabled (bool) : A bool representing the telephony_enabled + """ + + if telephony_enabled is not None and not isinstance(telephony_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: telephony_enabled EXPECTED TYPE: bool', None, None) + + self.add_key_value('telephony_enabled', telephony_enabled) + + def get_sort_order_preference(self): + """ + The method to get the sort_order_preference + + Returns: + string: A string representing the sort_order_preference + """ + + return self.get_key_value('sort_order_preference') + + 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 get_created_by_17(self): + """ + The method to get the created_by_17 + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by_17(self, created_by_17): + """ + The method to set the value to created_by_17 + + Parameters: + created_by_17 (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if created_by_17 is not None and not isinstance(created_by_17, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by_17 EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by_17) + + def get_created_time_9(self): + """ + The method to get the created_time_9 + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time_9(self, created_time_9): + """ + The method to set the value to created_time_9 + + Parameters: + created_time_9 (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time_9 is not None and not isinstance(created_time_9, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time_9 EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time_9) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/users_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/users_operations.py new file mode 100644 index 0000000..21c4340 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users/users_operations.py @@ -0,0 +1,346 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class UsersOperations(object): + def __init__(self): + """Creates an instance of UsersOperations""" + pass + + def get_users(self, param_instance=None, header_instance=None): + """ + The method to get users + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_users(self, request): + """ + The method to create users + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_users(self, request): + """ + The method to update users + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_user(self, user, header_instance=None): + """ + The method to get user + + Parameters: + user (int) : An int representing the user + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(user) + 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.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_user(self, user, request): + """ + The method to update user + + Parameters: + user (int) : An int representing the user + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user 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/v7/users/' + api_path = api_path + str(user) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_user(self, user): + """ + The method to delete user + + Parameters: + user (int) : An int representing the user + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(user) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_associated_groups(self, user, param_instance=None): + """ + The method to get associated groups + + Parameters: + user (int) : An int representing the user + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + 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/v7/users/' + api_path = api_path + str(user) + api_path = api_path + '/actions/associated_groups' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def users_count(self, param_instance=None): + """ + The method to users count + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/users/actions/count' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.count_handler import CountHandler + except Exception: + from .count_handler import CountHandler + return handler_instance.api_call(CountHandler.__module__, 'application/json') + + +class GetUsersParam(object): + type = Param('type', 'com.zoho.crm.api.Users.GetUsersParam') + page = Param('page', 'com.zoho.crm.api.Users.GetUsersParam') + per_page = Param('per_page', 'com.zoho.crm.api.Users.GetUsersParam') + ids = Param('ids', 'com.zoho.crm.api.Users.GetUsersParam') + + +class GetUsersHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Users.GetUsersHeader') + + +class GetUserHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Users.GetUserHeader') + + +class GetAssociatedGroupsParam(object): + include = Param('include', 'com.zoho.crm.api.Users.GetAssociatedGroupsParam') + + +class UsersCountParam(object): + type = Param('type', 'com.zoho.crm.api.Users.UsersCountParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/__init__.py new file mode 100644 index 0000000..65ce794 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/__init__.py @@ -0,0 +1,24 @@ +from .action_wrapper import ActionWrapper +from .transfer_and_delink import TransferAndDelink +from .transfer_action_wrapper import TransferActionWrapper +from .users_territories_operations import UsersTerritoriesOperations +from .transfer_action_handler import TransferActionHandler +from .manager import Manager +from .transfer_action_response import TransferActionResponse +from .body_wrapper import BodyWrapper +from .validation_wrapper import ValidationWrapper +from .bulk_validation import BulkValidation +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .action_wrappe import ActionWrappe +from .transfer_wrapper import TransferWrapper +from .validation_handler import ValidationHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .validation_group import ValidationGroup +from .action_handler import ActionHandler +from .transfer_to_user import TransferToUser +from .validation import Validation +from .territory import Territory +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrappe.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrappe.py new file mode 100644 index 0000000..1fa20bd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrappe.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrappe(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrappe""" + super().__init__() + + self.__transfer_and_delink = None + self.__key_modified = dict() + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrapper.py new file mode 100644 index 0000000..f0febca --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__transfer_and_delink = None + self.__key_modified = dict() + self.__territories = None + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/api_exception.py new file mode 100644 index 0000000..791d4e9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .transfer_action_handler import TransferActionHandler + from .validation_handler import ValidationHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler, ValidationHandler, TransferActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/body_wrapper.py new file mode 100644 index 0000000..5e9566b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/bulk_validation.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/bulk_validation.py new file mode 100644 index 0000000..a2ef705 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/bulk_validation.py @@ -0,0 +1,177 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_group import ValidationGroup +except Exception: + from ..exception import SDKException + from ..util import Constants + from .validation_group import ValidationGroup + + +class BulkValidation(ValidationGroup): + def __init__(self): + """Creates an instance of BulkValidation""" + super().__init__() + + self.__alert = None + self.__assignment = None + self.__criteria = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_alert(self): + """ + The method to get the alert + + Returns: + bool: A bool representing the alert + """ + + return self.__alert + + def set_alert(self, alert): + """ + The method to set the value to alert + + Parameters: + alert (bool) : A bool representing the alert + """ + + if alert is not None and not isinstance(alert, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alert EXPECTED TYPE: bool', None, None) + + self.__alert = alert + self.__key_modified['alert'] = 1 + + def get_assignment(self): + """ + The method to get the assignment + + Returns: + bool: A bool representing the assignment + """ + + return self.__assignment + + def set_assignment(self, assignment): + """ + The method to set the value to assignment + + Parameters: + assignment (bool) : A bool representing the assignment + """ + + if assignment is not None and not isinstance(assignment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment EXPECTED TYPE: bool', None, None) + + self.__assignment = assignment + self.__key_modified['assignment'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + bool: A bool representing the criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (bool) : A bool representing the criteria + """ + + if criteria is not None and not isinstance(criteria, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: bool', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/info.py new file mode 100644 index 0000000..d656bd3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__page = None + self.__per_page = None + self.__more_records = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/manager.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/manager.py new file mode 100644 index 0000000..cf6176a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/manager.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Manager(object): + def __init__(self): + """Creates an instance of Manager""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_wrapper.py new file mode 100644 index 0000000..0925122 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__territories = None + self.__info = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/success_response.py new file mode 100644 index 0000000..181b350 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_response import TransferActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .transfer_action_response import TransferActionResponse + + +class SuccessResponse(ActionResponse, TransferActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/territory.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/territory.py new file mode 100644 index 0000000..43f59a9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/territory.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__id = None + self.__manager = None + self.__reporting_to = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_manager(self): + """ + The method to get the manager + + Returns: + Manager: An instance of Manager + """ + + return self.__manager + + def set_manager(self, manager): + """ + The method to set the value to manager + + Parameters: + manager (Manager) : An instance of Manager + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.manager import Manager + except Exception: + from .manager import Manager + + if manager is not None and not isinstance(manager, Manager): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: manager EXPECTED TYPE: Manager', None, None) + + self.__manager = manager + self.__key_modified['Manager'] = 1 + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + Manager: An instance of Manager + """ + + return self.__reporting_to + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (Manager) : An instance of Manager + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.manager import Manager + except Exception: + from .manager import Manager + + if reporting_to is not None and not isinstance(reporting_to, Manager): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: Manager', None, None) + + self.__reporting_to = reporting_to + self.__key_modified['Reporting_To'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_handler.py new file mode 100644 index 0000000..574e9c4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferActionHandler(ABC): + def __init__(self): + """Creates an instance of TransferActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_response.py new file mode 100644 index 0000000..ebad40c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferActionResponse(ABC): + def __init__(self): + """Creates an instance of TransferActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_wrapper.py new file mode 100644 index 0000000..1555d5e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .transfer_action_handler import TransferActionHandler + + +class TransferActionWrapper(TransferActionHandler): + def __init__(self): + """Creates an instance of TransferActionWrapper""" + super().__init__() + + self.__transfer_and_delink = None + self.__key_modified = dict() + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_and_delink.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_and_delink.py new file mode 100644 index 0000000..f87ecae --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_and_delink.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferAndDelink(object): + def __init__(self): + """Creates an instance of TransferAndDelink""" + + self.__id = None + self.__transfer_to_user = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_transfer_to_user(self): + """ + The method to get the transfer_to_user + + Returns: + TransferToUser: An instance of TransferToUser + """ + + return self.__transfer_to_user + + def set_transfer_to_user(self, transfer_to_user): + """ + The method to set the value to transfer_to_user + + Parameters: + transfer_to_user (TransferToUser) : An instance of TransferToUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_to_user import TransferToUser + except Exception: + from .transfer_to_user import TransferToUser + + if transfer_to_user is not None and not isinstance(transfer_to_user, TransferToUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_to_user EXPECTED TYPE: TransferToUser', None, None) + + self.__transfer_to_user = transfer_to_user + self.__key_modified['transfer_to_user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_to_user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_to_user.py new file mode 100644 index 0000000..c41febd --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_to_user.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferToUser(object): + def __init__(self): + """Creates an instance of TransferToUser""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_wrapper.py new file mode 100644 index 0000000..0b16e6a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferWrapper(object): + def __init__(self): + """Creates an instance of TransferWrapper""" + + self.__transfer_and_delink = None + self.__key_modified = dict() + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/users_territories_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/users_territories_operations.py new file mode 100644 index 0000000..90efbe3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/users_territories_operations.py @@ -0,0 +1,258 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class UsersTerritoriesOperations(object): + def __init__(self, user): + """ + Creates an instance of UsersTerritoriesOperations with the given parameters + + Parameters: + user (int) : An int representing the user + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + self.__user = user + + + def get_territories_of_user(self): + """ + The method to get territories of user + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def associate_territories_to_user(self, request): + """ + The method to associate territories to user + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_territory_of_user(self, territory): + """ + The method to get territory of user + + Parameters: + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/' + api_path = api_path + str(territory) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def validate_before_transfer_for_all_territories(self): + """ + The method to validate before transfer for all territories + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/actions/validate_before_transfer' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler + except Exception: + from .validation_handler import ValidationHandler + return handler_instance.api_call(ValidationHandler.__module__, 'application/json') + + def validate_before_transfer(self, territory): + """ + The method to validate before transfer + + Parameters: + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/actions/validate_before_transfer' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler + except Exception: + from .validation_handler import ValidationHandler + return handler_instance.api_call(ValidationHandler.__module__, 'application/json') + + def delink_and_transfer_from_all_territories(self, request): + """ + The method to delink and transfer from all territories + + Parameters: + request (TransferWrapper) : An instance of TransferWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_wrapper import TransferWrapper + except Exception: + from .transfer_wrapper import TransferWrapper + + if request is not None and not isinstance(request, TransferWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/actions/transfer_and_delink' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler + except Exception: + from .transfer_action_handler import TransferActionHandler + return handler_instance.api_call(TransferActionHandler.__module__, 'application/json') + + def delink_and_transfer_from_specific_territory(self, territory, request): + """ + The method to delink and transfer from specific territory + + Parameters: + territory (int) : An int representing the territory + request (TransferWrapper) : An instance of TransferWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_wrapper import TransferWrapper + except Exception: + from .transfer_wrapper import TransferWrapper + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, TransferWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/actions/transfer_and_delink' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler + except Exception: + from .transfer_action_handler import TransferActionHandler + return handler_instance.api_call(TransferActionHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation.py new file mode 100644 index 0000000..dfb8b0c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_group import ValidationGroup +except Exception: + from ..exception import SDKException + from ..util import Constants + from .validation_group import ValidationGroup + + +class Validation(ValidationGroup): + def __init__(self): + """Creates an instance of Validation""" + super().__init__() + + self.__id = None + self.__name = None + self.__records = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_records(self): + """ + The method to get the records + + Returns: + bool: A bool representing the records + """ + + return self.__records + + def set_records(self, records): + """ + The method to set the value to records + + Parameters: + records (bool) : A bool representing the records + """ + + if records is not None and not isinstance(records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: records EXPECTED TYPE: bool', None, None) + + self.__records = records + self.__key_modified['records'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_group.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_group.py new file mode 100644 index 0000000..0bb2748 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_group.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ValidationGroup(ABC): + def __init__(self): + """Creates an instance of ValidationGroup""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_handler.py new file mode 100644 index 0000000..c3ab80f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ValidationHandler(ABC): + def __init__(self): + """Creates an instance of ValidationHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_wrapper.py new file mode 100644 index 0000000..5c02b93 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .validation_handler import ValidationHandler + + +class ValidationWrapper(ValidationHandler): + def __init__(self): + """Creates an instance of ValidationWrapper""" + super().__init__() + + self.__validate_before_transfer = None + self.__key_modified = dict() + + def get_validate_before_transfer(self): + """ + The method to get the validate_before_transfer + + Returns: + list: An instance of list + """ + + return self.__validate_before_transfer + + def set_validate_before_transfer(self, validate_before_transfer): + """ + The method to set the value to validate_before_transfer + + Parameters: + validate_before_transfer (list) : An instance of list + """ + + if validate_before_transfer is not None and not isinstance(validate_before_transfer, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: validate_before_transfer EXPECTED TYPE: list', None, None) + + self.__validate_before_transfer = validate_before_transfer + self.__key_modified['validate_before_transfer'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/__init__.py new file mode 100644 index 0000000..cdf886e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .move_subordinate import MoveSubordinate +from .body_wrapper import BodyWrapper +from .transfer_and_delete_by_id import TransferAndDeleteByID +from .transfer_and_delete import TransferAndDelete +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .transfer import Transfer +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .users_transfer_delete_operations import UsersTransferDeleteOperations, GetStatusParam +from .status import Status diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_wrapper.py new file mode 100644 index 0000000..9a4b0ee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__transfer_and_delete = None + self.__key_modified = dict() + + def get_transfer_and_delete(self): + """ + The method to get the transfer_and_delete + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delete + + def set_transfer_and_delete(self, transfer_and_delete): + """ + The method to set the value to transfer_and_delete + + Parameters: + transfer_and_delete (list) : An instance of list + """ + + if transfer_and_delete is not None and not isinstance(transfer_and_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delete EXPECTED TYPE: list', None, None) + + self.__transfer_and_delete = transfer_and_delete + self.__key_modified['transfer_and_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/api_exception.py new file mode 100644 index 0000000..e6d47ee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/body_wrapper.py new file mode 100644 index 0000000..14ed9e3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__transfer_and_delete = None + self.__key_modified = dict() + + def get_transfer_and_delete(self): + """ + The method to get the transfer_and_delete + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delete + + def set_transfer_and_delete(self, transfer_and_delete): + """ + The method to set the value to transfer_and_delete + + Parameters: + transfer_and_delete (list) : An instance of list + """ + + if transfer_and_delete is not None and not isinstance(transfer_and_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delete EXPECTED TYPE: list', None, None) + + self.__transfer_and_delete = transfer_and_delete + self.__key_modified['transfer_and_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/move_subordinate.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/move_subordinate.py new file mode 100644 index 0000000..228e1b4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/move_subordinate.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MoveSubordinate(object): + def __init__(self): + """Creates an instance of MoveSubordinate""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_wrapper.py new file mode 100644 index 0000000..21173a3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__transfer_and_delete = None + self.__key_modified = dict() + + def get_transfer_and_delete(self): + """ + The method to get the transfer_and_delete + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delete + + def set_transfer_and_delete(self, transfer_and_delete): + """ + The method to set the value to transfer_and_delete + + Parameters: + transfer_and_delete (list) : An instance of list + """ + + if transfer_and_delete is not None and not isinstance(transfer_and_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delete EXPECTED TYPE: list', None, None) + + self.__transfer_and_delete = transfer_and_delete + self.__key_modified['transfer_and_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/status.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/status.py new file mode 100644 index 0000000..65aab16 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/status.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/success_response.py new file mode 100644 index 0000000..c794901 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer.py new file mode 100644 index 0000000..51ab88c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Transfer(object): + def __init__(self): + """Creates an instance of Transfer""" + + self.__records = None + self.__assignment = None + self.__criteria = None + self.__id = None + self.__key_modified = dict() + + def get_records(self): + """ + The method to get the records + + Returns: + bool: A bool representing the records + """ + + return self.__records + + def set_records(self, records): + """ + The method to set the value to records + + Parameters: + records (bool) : A bool representing the records + """ + + if records is not None and not isinstance(records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: records EXPECTED TYPE: bool', None, None) + + self.__records = records + self.__key_modified['records'] = 1 + + def get_assignment(self): + """ + The method to get the assignment + + Returns: + bool: A bool representing the assignment + """ + + return self.__assignment + + def set_assignment(self, assignment): + """ + The method to set the value to assignment + + Parameters: + assignment (bool) : A bool representing the assignment + """ + + if assignment is not None and not isinstance(assignment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment EXPECTED TYPE: bool', None, None) + + self.__assignment = assignment + self.__key_modified['assignment'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + bool: A bool representing the criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (bool) : A bool representing the criteria + """ + + if criteria is not None and not isinstance(criteria, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: bool', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete.py new file mode 100644 index 0000000..fc457a3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferAndDelete(object): + def __init__(self): + """Creates an instance of TransferAndDelete""" + + self.__id = None + self.__transfer = None + self.__move_subordinate = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_transfer(self): + """ + The method to get the transfer + + Returns: + Transfer: An instance of Transfer + """ + + return self.__transfer + + def set_transfer(self, transfer): + """ + The method to set the value to transfer + + Parameters: + transfer (Transfer) : An instance of Transfer + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.transfer import Transfer + except Exception: + from .transfer import Transfer + + if transfer is not None and not isinstance(transfer, Transfer): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer EXPECTED TYPE: Transfer', None, None) + + self.__transfer = transfer + self.__key_modified['transfer'] = 1 + + def get_move_subordinate(self): + """ + The method to get the move_subordinate + + Returns: + MoveSubordinate: An instance of MoveSubordinate + """ + + return self.__move_subordinate + + def set_move_subordinate(self, move_subordinate): + """ + The method to set the value to move_subordinate + + Parameters: + move_subordinate (MoveSubordinate) : An instance of MoveSubordinate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.move_subordinate import MoveSubordinate + except Exception: + from .move_subordinate import MoveSubordinate + + if move_subordinate is not None and not isinstance(move_subordinate, MoveSubordinate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_subordinate EXPECTED TYPE: MoveSubordinate', None, None) + + self.__move_subordinate = move_subordinate + self.__key_modified['move_subordinate'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.py new file mode 100644 index 0000000..76758b1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferAndDeleteByID(object): + def __init__(self): + """Creates an instance of TransferAndDeleteByID""" + + self.__transfer = None + self.__move_subordinate = None + self.__key_modified = dict() + + def get_transfer(self): + """ + The method to get the transfer + + Returns: + Transfer: An instance of Transfer + """ + + return self.__transfer + + def set_transfer(self, transfer): + """ + The method to set the value to transfer + + Parameters: + transfer (Transfer) : An instance of Transfer + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.transfer import Transfer + except Exception: + from .transfer import Transfer + + if transfer is not None and not isinstance(transfer, Transfer): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer EXPECTED TYPE: Transfer', None, None) + + self.__transfer = transfer + self.__key_modified['transfer'] = 1 + + def get_move_subordinate(self): + """ + The method to get the move_subordinate + + Returns: + MoveSubordinate: An instance of MoveSubordinate + """ + + return self.__move_subordinate + + def set_move_subordinate(self, move_subordinate): + """ + The method to set the value to move_subordinate + + Parameters: + move_subordinate (MoveSubordinate) : An instance of MoveSubordinate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.move_subordinate import MoveSubordinate + except Exception: + from .move_subordinate import MoveSubordinate + + if move_subordinate is not None and not isinstance(move_subordinate, MoveSubordinate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_subordinate EXPECTED TYPE: MoveSubordinate', None, None) + + self.__move_subordinate = move_subordinate + self.__key_modified['move_subordinate'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/users_transfer_delete_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/users_transfer_delete_operations.py new file mode 100644 index 0000000..b7e8312 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/users_transfer_delete_operations.py @@ -0,0 +1,133 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UsersTransferDeleteOperations(object): + def __init__(self): + """Creates an instance of UsersTransferDeleteOperations""" + pass + + def users_transfer_and_delete(self, request): + """ + The method to users transfer and delete + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users/actions/transfer_and_delete' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_status(self, param_instance=None): + """ + The method to get status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/users/actions/transfer_and_delete' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def user_transfer_and_delete(self, id, request): + """ + The method to user transfer and delete + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/users/' + api_path = api_path + str(id) + api_path = api_path + '/actions/transfer_and_delete' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.UsersTransferDelete.GetStatusParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/__init__.py new file mode 100644 index 0000000..6aa4c02 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/__init__.py @@ -0,0 +1,12 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .users_unavailability_operations import UsersUnavailabilityOperations, GetUsersUnavailabilityParam, GetUserUnavailabilityParam +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .users_unavailability import UsersUnavailability +from .body_wrapper import BodyWrapper +from .user import User +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_wrapper.py new file mode 100644 index 0000000..8e0c513 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users_unavailability = None + self.__key_modified = dict() + + def get_users_unavailability(self): + """ + The method to get the users_unavailability + + Returns: + list: An instance of list + """ + + return self.__users_unavailability + + def set_users_unavailability(self, users_unavailability): + """ + The method to set the value to users_unavailability + + Parameters: + users_unavailability (list) : An instance of list + """ + + if users_unavailability is not None and not isinstance(users_unavailability, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_unavailability EXPECTED TYPE: list', None, None) + + self.__users_unavailability = users_unavailability + self.__key_modified['users_unavailability'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/api_exception.py new file mode 100644 index 0000000..339233c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/body_wrapper.py new file mode 100644 index 0000000..93395f0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users_unavailability = None + self.__key_modified = dict() + + def get_users_unavailability(self): + """ + The method to get the users_unavailability + + Returns: + list: An instance of list + """ + + return self.__users_unavailability + + def set_users_unavailability(self, users_unavailability): + """ + The method to set the value to users_unavailability + + Parameters: + users_unavailability (list) : An instance of list + """ + + if users_unavailability is not None and not isinstance(users_unavailability, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_unavailability EXPECTED TYPE: list', None, None) + + self.__users_unavailability = users_unavailability + self.__key_modified['users_unavailability'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_wrapper.py new file mode 100644 index 0000000..d4ab94e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users_unavailability = None + self.__info = None + self.__key_modified = dict() + + def get_users_unavailability(self): + """ + The method to get the users_unavailability + + Returns: + list: An instance of list + """ + + return self.__users_unavailability + + def set_users_unavailability(self, users_unavailability): + """ + The method to set the value to users_unavailability + + Parameters: + users_unavailability (list) : An instance of list + """ + + if users_unavailability is not None and not isinstance(users_unavailability, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_unavailability EXPECTED TYPE: list', None, None) + + self.__users_unavailability = users_unavailability + self.__key_modified['users_unavailability'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/success_response.py new file mode 100644 index 0000000..038347a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/user.py new file mode 100644 index 0000000..7305eca --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__zuid = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability.py new file mode 100644 index 0000000..9875fc8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability.py @@ -0,0 +1,308 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UsersUnavailability(object): + def __init__(self): + """Creates an instance of UsersUnavailability""" + + self.__service = None + self.__title = None + self.__all_day = None + self.__tp_calendar_id = None + self.__tp_event_id = None + self.__comments = None + self.__from_1 = None + self.__id = None + self.__to = None + self.__user = None + self.__key_modified = dict() + + def get_service(self): + """ + The method to get the service + + Returns: + string: A string representing the service + """ + + return self.__service + + def set_service(self, service): + """ + The method to set the value to service + + Parameters: + service (string) : A string representing the service + """ + + if service is not None and not isinstance(service, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service EXPECTED TYPE: str', None, None) + + self.__service = service + self.__key_modified['service'] = 1 + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_all_day(self): + """ + The method to get the all_day + + Returns: + bool: A bool representing the all_day + """ + + return self.__all_day + + def set_all_day(self, all_day): + """ + The method to set the value to all_day + + Parameters: + all_day (bool) : A bool representing the all_day + """ + + if all_day is not None and not isinstance(all_day, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: all_day EXPECTED TYPE: bool', None, None) + + self.__all_day = all_day + self.__key_modified['all_day'] = 1 + + def get_tp_calendar_id(self): + """ + The method to get the tp_calendar_id + + Returns: + string: A string representing the tp_calendar_id + """ + + return self.__tp_calendar_id + + def set_tp_calendar_id(self, tp_calendar_id): + """ + The method to set the value to tp_calendar_id + + Parameters: + tp_calendar_id (string) : A string representing the tp_calendar_id + """ + + if tp_calendar_id is not None and not isinstance(tp_calendar_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tp_calendar_id EXPECTED TYPE: str', None, None) + + self.__tp_calendar_id = tp_calendar_id + self.__key_modified['tp_calendar_id'] = 1 + + def get_tp_event_id(self): + """ + The method to get the tp_event_id + + Returns: + string: A string representing the tp_event_id + """ + + return self.__tp_event_id + + def set_tp_event_id(self, tp_event_id): + """ + The method to set the value to tp_event_id + + Parameters: + tp_event_id (string) : A string representing the tp_event_id + """ + + if tp_event_id is not None and not isinstance(tp_event_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tp_event_id EXPECTED TYPE: str', None, None) + + self.__tp_event_id = tp_event_id + self.__key_modified['tp_event_id'] = 1 + + def get_comments(self): + """ + The method to get the comments + + Returns: + string: A string representing the comments + """ + + return self.__comments + + def set_comments(self, comments): + """ + The method to set the value to comments + + Parameters: + comments (string) : A string representing the comments + """ + + if comments is not None and not isinstance(comments, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comments EXPECTED TYPE: str', None, None) + + self.__comments = comments + self.__key_modified['comments'] = 1 + + def get_from(self): + """ + The method to get the from + + Returns: + datetime: An instance of datetime + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (datetime) : An instance of datetime + """ + + from datetime import datetime + + if from_1 is not None and not isinstance(from_1, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: datetime', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + datetime: An instance of datetime + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (datetime) : An instance of datetime + """ + + from datetime import datetime + + if to is not None and not isinstance(to, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: datetime', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_user(self): + """ + The method to get the user + + Returns: + User: An instance of User + """ + + return self.__user + + def set_user(self, user): + """ + The method to set the value to user + + Parameters: + user (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.user import User + except Exception: + from .user import User + + if user is not None and not isinstance(user, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: User', None, None) + + self.__user = user + self.__key_modified['user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability_operations.py new file mode 100644 index 0000000..cd9a775 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability_operations.py @@ -0,0 +1,247 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UsersUnavailabilityOperations(object): + def __init__(self): + """Creates an instance of UsersUnavailabilityOperations""" + pass + + def create_users_unavailability(self, request): + """ + The method to create users unavailability + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/users_unavailability' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_users_unavailability(self, request): + """ + The method to update users unavailability + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/users_unavailability' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_users_unavailability(self, param_instance=None): + """ + The method to get users unavailability + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/users_unavailability' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_user_unavailability(self, id, request): + """ + The method to update user unavailability + + Parameters: + id (string) : A string representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', 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/v7/settings/users_unavailability/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_user_unavailability(self, id, param_instance=None): + """ + The method to get user unavailability + + Parameters: + id (string) : A string representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + 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/v7/settings/users_unavailability/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_user_unavailability(self, id): + """ + The method to delete user unavailability + + Parameters: + id (string) : A string representing the id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/users_unavailability/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetUsersUnavailabilityParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + group_ids = Param('group_ids', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + role_ids = Param('role_ids', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + territory_ids = Param('territory_ids', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + filters = Param('filters', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + + +class GetUserUnavailabilityParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.UsersUnavailability.GetUserUnavailabilityParam') + filters = Param('filters', 'com.zoho.crm.api.UsersUnavailability.GetUserUnavailabilityParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/__init__.py new file mode 100755 index 0000000..f4c05da --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/__init__.py @@ -0,0 +1,15 @@ +from .common_api_handler import CommonAPIHandler +from .converter import Converter +from .json_converter import JSONConverter +from .xml_converter import XMLConverter +from .form_data_converter import FormDataConverter +from .downloader import Downloader +from .api_http_connector import APIHTTPConnector +from .api_response import APIResponse +from .constants import Constants +from .utility import Utility +from .datatype_converter import DataTypeConverter +from .stream_wrapper import StreamWrapper +from .choice import Choice +from .header_param_validator import HeaderParamValidator +from .module_fields_handler import ModuleFieldsHandler diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/api_http_connector.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/api_http_connector.py new file mode 100755 index 0000000..a890b76 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/api_http_connector.py @@ -0,0 +1,177 @@ +try: + import requests + import logging + import json + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + +except Exception: + from .constants import Constants + import requests + import logging + import json + from ..initializer import Initializer + + +class APIHTTPConnector(object): + """ + This module is to make HTTP connections, trigger the requests and receive the response. + """ + + def __init__(self): + + """ + Creates an APIHTTPConnector class instance with the specified parameters. + """ + + self.url = None + self.request_method = None + self.headers = dict() + self.parameters = dict() + self.request_body = None + self.content_type = None + self.file = False + + def add_header(self, header_name, header_value): + + """ + The method to add API request header name and value. + + Parameters: + header_name (str) : A String containing the API request header name. + header_value (str) : A String containing the API request header value. + """ + + self.headers[header_name] = header_value + + def add_param(self, param_name, param_value): + + """ + The method to add API request parameter name and value. + + Parameters: + param_name (str) : A String containing the API request parameter name. + param_value (str) : A String containing the API request parameter value. + """ + + self.parameters[param_name] = param_value + + def fire_request(self, converter_instance): + + """ + This method makes a request to the Zoho CRM Rest API + + Parameters: + converter_instance (Converter) : A Converter class instance to call append_to_request method. + + Returns: + requests.Response : An object of requests.Response + """ + + response = None + proxies = None + logger = logging.getLogger('SDKLogger') + initializer = Initializer.get_initializer() + sdk_config = initializer.sdk_config + read_timeout = sdk_config.get_read_timeout() + connect_timeout = sdk_config.get_connect_timeout() + + if read_timeout is None and connect_timeout is None: + timeout = None + elif read_timeout is None: + timeout = connect_timeout + elif connect_timeout is None: + timeout = read_timeout + else: + timeout = (connect_timeout, read_timeout) + + if self.content_type is not None: + self.set_content_type_header() + + if initializer.request_proxy is not None: + request_proxy = initializer.request_proxy + auth = "" + + if request_proxy is not None: + auth = request_proxy.get_user() + ':' + request_proxy.get_password() + '@' + + if Constants.HTTP in request_proxy.get_host(): + host_split = request_proxy.get_host().split('://') + scheme = host_split[0] + proxies = { + scheme: scheme + '://' + auth + host_split[1] + ':' + str(request_proxy.get_port()) + } + + else: + proxies = { + Constants.HTTP: Constants.HTTP + '://' + auth + request_proxy.get_host() + ':' + str( + request_proxy.get_port()), + Constants.HTTPS: Constants.HTTPS + '://' + auth + request_proxy.get_host() + ':' + str( + request_proxy.get_port()) + } + + logger.info(self.proxy_log(request_proxy)) + + logger.info(self.__str__()) + + if self.request_method == Constants.REQUEST_METHOD_GET: + response = requests.get(url=self.url, headers=self.headers, params=self.parameters, allow_redirects=False, + proxies=proxies, timeout=timeout) + + elif self.request_method == Constants.REQUEST_METHOD_PUT: + data = None + if self.request_body is not None: + data = converter_instance.append_to_request(self, self.request_body) + + response = requests.put(url=self.url, data=data, params=self.parameters, headers=self.headers, + allow_redirects=False, proxies=proxies) + + elif self.request_method == Constants.REQUEST_METHOD_POST: + data = None + if self.request_body is not None: + data = converter_instance.append_to_request(self, self.request_body) + + if self.file: + response = requests.post(url=self.url, files=data, headers=self.headers, allow_redirects=False, data={}, + proxies=proxies) + + else: + response = requests.post(url=self.url, data=data, params=self.parameters, headers=self.headers, + allow_redirects=False, proxies=proxies) + + elif self.request_method == Constants.REQUEST_METHOD_PATCH: + data = None + if self.request_body is not None: + data = converter_instance.append_to_request(self, self.request_body) + + response = requests.patch(url=self.url, data=data, headers=self.headers, params=self.parameters, + allow_redirects=False, proxies=proxies) + + elif self.request_method == Constants.REQUEST_METHOD_DELETE: + response = requests.delete(url=self.url, headers=self.headers, params=self.parameters, + allow_redirects=False, proxies=proxies) + + return response + + def __str__(self): + request_headers = self.headers.copy() + request_headers[Constants.AUTHORIZATION] = Constants.CANT_DISCLOSE + + return self.request_method + ' - ' + Constants.URL + ' = ' + self.url + ' , ' + Constants.HEADERS + ' = ' + \ + json.dumps(request_headers) \ + + ' , ' + Constants.PARAMS + ' = ' + json.dumps(self.parameters) + '.' + + @staticmethod + def proxy_log(request_proxy): + proxy_details = Constants.PROXY_SETTINGS + Constants.PROXY_HOST + str( + request_proxy.get_host()) + ', ' + Constants.PROXY_PORT + str(request_proxy.get_port()) + if request_proxy.user is not None: + proxy_details = proxy_details + ', ' + Constants.PROXY_USER + str(request_proxy.get_user()) + + return proxy_details + + def set_content_type_header(self): + for url in Constants.SET_CONTENT_TYPE_HEADER: + if url in self.url: + self.headers[Constants.CONTENT_TYPE_HEADER] = self.content_type + return diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/api_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/api_response.py new file mode 100755 index 0000000..2f93cef --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/api_response.py @@ -0,0 +1,54 @@ + +class APIResponse(object): + + """ + This class is the common API response object. + """ + + def __init__(self, headers, status_code, object): + + """ + Creates an APIResponse class instance with the specified parameters. + + Parameters: + headers (dict) : A dict containing the API response headers. + status_code (int) : An integer containing the API response HTTP status code. + object (object) : An object containing the API response class instance. + """ + + self.__headers = headers + self.__status_code = status_code + self.__object = object + + def get_headers(self): + + """ + This is a getter method to get API response headers. + + Returns: + dict: A dict representing the API response headers. + """ + + return self.__headers + + def get_status_code(self): + + """ + This is a getter method to get the API response HTTP status code. + + Returns: + int: An integer representing the API response HTTP status code. + """ + + return self.__status_code + + def get_object(self): + + """ + This method to get an API response class instance. + + Returns: + object: An object containing the API response class instance. + """ + + return self.__object diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/choice.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/choice.py new file mode 100755 index 0000000..71bf36e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/choice.py @@ -0,0 +1,13 @@ + +class Choice(object): + + """ + Common Class to provide or obtain a value, when there are multiple supported values. + """ + + def __init__(self, value): + self.__value = value + + def get_value(self): + return self.__value + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/common_api_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/common_api_handler.py new file mode 100755 index 0000000..bb62f6c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/common_api_handler.py @@ -0,0 +1,481 @@ +try: + import json + import platform + import urllib3 + import logging + from zohocrmsdk.src.com.zoho.crm.api.util.api_http_connector import APIHTTPConnector + from zohocrmsdk.src.com.zoho.crm.api.util.json_converter import JSONConverter + from zohocrmsdk.src.com.zoho.crm.api.util.xml_converter import XMLConverter + from zohocrmsdk.src.com.zoho.crm.api.util.form_data_converter import FormDataConverter + from zohocrmsdk.src.com.zoho.crm.api.util.downloader import Downloader + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.api_response import APIResponse + from zohocrmsdk.src.com.zoho.crm.api.header_map import HeaderMap + from zohocrmsdk.src.com.zoho.crm.api.header import Header + from zohocrmsdk.src.com.zoho.crm.api.parameter_map import ParameterMap + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + +except Exception: + import json + import platform + import urllib3 + import logging + from .api_http_connector import APIHTTPConnector + from .json_converter import JSONConverter + from .constants import Constants + from .api_response import APIResponse + from ..header_map import HeaderMap + from ..header import Header + from ..parameter_map import ParameterMap + from ..param import Param + from ..exception import SDKException + + +class CommonAPIHandler(object): + """ + This class to process the API request and its response. + Construct the objects that are to be sent as parameters or request body with the API. + The Request parameter, header and body objects are constructed here. + Process the response JSON and converts it to relevant objects in the library. + """ + logger = logging.getLogger('SDKLogger') + + def __init__(self): + + self.__api_path = None + self.__header = HeaderMap() + self.__param = ParameterMap() + self.__request = None + self.__http_method = None + self.__module_api_name = None + self.__content_type = None + self.__category_method = None + self.__mandatory_checker = None + + def set_content_type(self, content_type): + """ + The method to set the Content Type + + Parameters: + content_type(str): A string containing the Content Type + """ + + self.__content_type = content_type + + def set_api_path(self, api_path): + """ + The method to set the API Path + + Parameters: + api_path(str) : A string containing the API Path + """ + + self.__api_path = api_path + + def add_param(self, param_instance, param_value): + + """ + The method to add an API request parameter. + + Parameters: + param_instance (Param) : A Param instance containing the API request parameter. + param_value (object) : An object containing the API request parameter value. + """ + + if param_value is None: + return + + if self.__param is None: + self.__param = ParameterMap() + + self.__param.add(param_instance, param_value) + + def add_header(self, header_instance, header_value): + """ + The method to add an API request header. + + Parameters: + header_instance (Header) : A Header instance containing the API request header. + header_value (object) : An object containing the API request header value. + """ + + if header_value is None: + return + + if self.__header is None: + self.__header = HeaderMap() + + self.__header.add(header_instance, header_value) + + def set_param(self, param): + """ + The method to set the API request parameter map. + + Parameters: + param(ParameterMap) : A ParameterMap class instance containing the API request parameters + """ + + if param is None: + return + + if self.__param.request_parameters is not None and self.__param.request_parameters: + self.__param.request_parameters.update(param.request_parameters) + else: + self.__param = param + + def get_module_api_name(self): + """ + The method to get the Module API Name + + Returns: + string: A string representing the Module API Name + """ + + return self.__module_api_name + + def set_module_api_name(self, module_api_name): + """ + The method to set the Module API Name + + Parameters: + module_api_name(str): A string containing the Module API Name + """ + + self.__module_api_name = module_api_name + + def set_header(self, header): + """ + The method to set the API request header map. + + Parameters: + header(HeaderMap): A HeaderMap class instance containing the API request headers + """ + + if header is None: + return + + if self.__header.request_headers is not None and self.__header.request_headers: + self.__header.request_headers.update(header.request_headers) + else: + self.__header = header + + def set_request(self, request): + """ + The method to set the request instance. + + Parameters: + request(object): An object containing the request body + + """ + self.__request = request + + def set_http_method(self, http_method): + """ + The method to set the HTTP Method + + Parameters: + http_method(str): A string containing the HTTP method. + """ + + self.__http_method = http_method + + def api_call(self, class_name, encode_type): + + """ + The method to construct API request and response details. To make the Zoho CRM API calls. + + Parameters: + class_name(str): A str containing the method return type. + encode_type(str): A str containing the expected API response content type. + + Returns: + APIResponse: An instance of APIResponse representing the Zoho CRM API response instance + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + if Initializer.get_initializer() is None: + raise SDKException(code=Constants.SDK_UNINITIALIZATION_ERROR, + message=Constants.SDK_UNINITIALIZATION_MESSAGE) + + connector = APIHTTPConnector() + try: + self.set_api_url(connector) + except SDKException as e: + CommonAPIHandler.logger.error(Constants.SET_API_URL_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.SET_API_URL_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + connector.request_method = self.__http_method + connector.content_type = self.__content_type + + if self.__header is not None and len(self.__header.request_headers) > 0: + connector.headers = self.__header.request_headers + + if self.__param is not None and len(self.__param.request_parameters) > 0: + connector.parameters = self.__param.request_parameters + + try: + Initializer.get_initializer().token.authenticate(connector) + except SDKException as e: + CommonAPIHandler.logger.info(Constants.AUTHENTICATION_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.AUTHENTICATION_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + convert_instance = None + + if self.__content_type is not None and \ + self.__http_method in [Constants.REQUEST_METHOD_PATCH, Constants.REQUEST_METHOD_POST, + Constants.REQUEST_METHOD_PUT]: + try: + convert_instance = self.get_converter_class_instance(self.__content_type.lower()) + request = convert_instance.form_request(self.__request, self.__request.__class__.__module__, None, None) + except SDKException as e: + CommonAPIHandler.logger.info(Constants.FORM_REQUEST_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.FORM_REQUEST_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + connector.request_body = request + + try: + connector.headers[ + Constants.ZOHO_SDK] = platform.system() + "/" + \ + platform.release() + "/python-7.0/" + platform.python_version() + ":" + \ + Constants.SDK_VERSION + response = connector.fire_request(convert_instance) + return_object = None + + if Constants.CONTENT_TYPE in response.headers: + content_type = response.headers[Constants.CONTENT_TYPE] + + if ";" in content_type: + content_type = content_type.rpartition(";")[0] + + convert_instance = self.get_converter_class_instance(str(content_type).lower()) + return_object = convert_instance.get_wrapped_response(response, class_name) + + else: + CommonAPIHandler.logger.info(response.__str__()) + + return APIResponse(response.headers, response.status_code, return_object) + except SDKException as e: + CommonAPIHandler.logger.info(Constants.API_CALL_EXCEPTION + e.__str__()) + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.API_CALL_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + def get_converter_class_instance(self, encode_type): + + """ + This method to get a Converter class instance. + :param encode_type: A str containing the API response content type. + :return: A Converter class instance. + """ + + switcher = { + + "application/json": JSONConverter(self), + + "text/plain": JSONConverter(self), + + "application/ld+json": JSONConverter(self), + + "application/xml": XMLConverter(self), + + "text/xml": XMLConverter(self), + + "multipart/form-data": FormDataConverter(self), + + "application/x-download": Downloader(self), + + "image/png": Downloader(self), + + "image/jpeg": Downloader(self), + + "image/gif": Downloader(self), + + "image/tiff": Downloader(self), + + "image/svg+xml": Downloader(self), + + "image/bmp": Downloader(self), + + "image/webp": Downloader(self), + + "text/html": Downloader(self), + + "text/css": Downloader(self), + + "text/javascript": Downloader(self), + + "text/calendar": Downloader(self), + + "application/zip": Downloader(self), + + "application/pdf": Downloader(self), + + "application/java-archive": Downloader(self), + + "application/javascript": Downloader(self), + + "application/xhtml+xml": Downloader(self), + + "application/x-bzip": Downloader(self), + + "application/msword": Downloader(self), + + "application/vnd.openxmlformats-officedocument.wordprocessingml.document": Downloader(self), + + "application/gzip": Downloader(self), + + "application/x-httpd-php": Downloader(self), + + "application/vnd.ms-powerpoint": Downloader(self), + + "application/vnd.rar": Downloader(self), + + "application/x-sh": Downloader(self), + + "application/x-tar": Downloader(self), + + "application/vnd.ms-excel": Downloader(self), + + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": Downloader(self), + + "application/x-7z-compressed": Downloader(self), + + "audio/mpeg": Downloader(self), + + "audio/x-ms-wma": Downloader(self), + + "audio/vnd.rn-realaudio": Downloader(self), + + "audio/x-wav": Downloader(self), + + "audio/3gpp": Downloader(self), + + "audio/3gpp2": Downloader(self), + + "video/mpeg": Downloader(self), + + "video/mp4": Downloader(self), + + "video/webm": Downloader(self), + + "video/3gpp": Downloader(self), + + "video/3gpp2": Downloader(self), + + "font/ttf": Downloader(self), + + "text/csv": Downloader(self), + + "application/octet-stream": Downloader(self), + } + + return switcher.get(encode_type, None) + + def set_api_url(self, connector): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + api_path = '' + + if Constants.HTTP in self.__api_path: + if Constants.CONTENT_API_URL in self.__api_path: + api_path = Initializer.get_initializer().environment.file_upload_url + + try: + url_parse = urllib3.util.parse_url(self.__api_path) + path = url_parse.path + except Exception as ex: + raise SDKException(code=Constants.INVALID_URL_ERROR, cause=ex) + + api_path = api_path + path + else: + if str(self.__api_path)[:1].__eq__('/'): + self.__api_path = self.__api_path[1:] + + api_path = api_path + self.__api_path + else: + api_path = Initializer.get_initializer().environment.url + api_path = api_path + self.__api_path + + connector.url = api_path + + def get_mandatory_checker(self): + """ + The method to get the Mandatory Checker + + Returns: + bool: A boolean representing the Mandatory Checker. + """ + return self.__mandatory_checker + + def set_mandatory_checker(self, mandatory_checker): + """ + The method to set the Mandatory Checker + + Parameters: + mandatory_checker(bool): A boolean containing the Mandatory Checker. + """ + + self.__mandatory_checker = mandatory_checker + + def get_http_method(self): + """ + The method to get the HTTP Method + + Returns: + string: A string representing the HTTP Method + """ + + return self.__http_method + + def get_category_method(self): + """ + The method to get the Category Method + + Returns: + string: A string representing the Category method. + """ + + return self.__category_method + + def set_category_method(self, category_method): + """ + The method to set the Category Method + + Parameters: + category_method(str): A string containing the Category method. + """ + + self.__category_method = category_method + + def get_api_path(self): + """ + The method to get the API Path + + Returns: + string: A string representing the API Path + """ + return self.__api_path diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/constants.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/constants.py new file mode 100644 index 0000000..790f8d0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/constants.py @@ -0,0 +1,777 @@ +from datetime import time, datetime, date + + +class Constants(object): + """ + This class uses the SDK constants name reference. + """ + + DATA_TYPE_ERROR = "DATA TYPE ERROR" + + ERROR = "error" + + REQUEST_METHOD_GET = "GET" + + REQUEST_METHOD_POST = "POST" + + REQUEST_METHOD_PUT = "PUT" + + REQUEST_METHOD_DELETE = "DELETE" + + GIVEN_VALUE = "given-value" + + REQUEST_METHOD_PATCH = 'PATCH' + + OAUTH_HEADER_PREFIX = "Zoho-oauthtoken " + + AUTHORIZATION = "Authorization" + + API_NAME = "api_name" + + PHOTO = "photo" + + API_VERSION = "v7" + + CRM = "crm" + + INPUT_ERROR = "INPUT_ERROR" + + LOGGER_LEVELS = { + "CRITICAL": "CRITICAL", + "ERROR": "ERROR", + "WARNING": "WARNING", + "INFO": "INFO", + "DEBUG": "DEBUG", + "NOTSET": "NOTSET" + } + INVENTORY_MODULES_ITEMS = ["invoiced_items", "quoted_items", "purchase_items", "ordered_items"] + + DEFAULT_MODULE_NAME_VS_API_NAME = { + + "leads": "Leads", + + "contacts": "Contacts", + + "accounts": "Accounts", + + "deals": "Deals", + + "tasks": "Tasks", + + "events": "Events", + + "activities": "Activities", + + "calls": "Calls", + + "products": "Products", + + "quotes": "Quotes", + + "sales_orders": "Sales_Orders", + + "purchase_orders": "Purchase_Orders", + + "invoices": "Invoices", + + "campaigns": "Campaigns", + + "vendors": "Vendors", + + "price_books": "Price_Books", + + "cases": "Cases", + + "solutions": "Solutions", + + "visits": "Visits", + + "approvals": "Approvals", + + "notes": "Notes", + + "attachments": "Attachments", + + "actions_performed": "Actions_Performed", + + } + + PROXY_SETTINGS = "Proxy settings - " + + PROXY_HOST = "Host: " + + PROXY_PORT = "Port: " + + PROXY_USER = "User: " + + PROXY_DOMAIN = "Domain: " + + MERGE_OBJECT = "MERGE_OBJECT" + + GET_TOKEN_BY_USER_NAME_ERROR = "Exception in getToken() - OAuthToken : Given user_name token details not found, Please give required item" + + OAUTH_TOKEN_FIELDS = ["client_id", "client_secret", "redirect_url", "grant_token", "refresh_token", "access_token", + "expires_in", "user_signature", "id"] + + TOKEN_BY_ID_FILE_ERROR = "Exception in FileStore : Given Id not found" + + GET_TOKEN_BY_ID_FILE_ERROR = "Exception in getTokenById - FileStore : Given ID is invalid" + + MYSQL_TABLE_NAME = "oauthtoken" + + SWITCH_USER_ERROR = "SWITCH USER ERROR" + + LOGGER_INITIALIZATION_ERROR = "Exception in Logger Initialization : " + + INVALID_ID_MSG = "The given id seems to be invalid." + + RESOURCE_PATH_INVALID_ERROR_MESSAGE = "Resource Path MUST be a valid directory." + + API_MAX_RECORDS_MSG = "Cannot process more than 100 records at a time." + + INVALID_DATA = "INVALID_DATA" + + CODE_SUCCESS = "SUCCESS" + + STATUS_SUCCESS = "success" + + STATUS_ERROR = "error" + + GRANT_TYPE = "grant_type" + + GRANT_TYPE_AUTH_CODE = "authorization_code" + + ACCESS_TOKEN = "access_token" + + EXPIRES_IN = "expires_in" + + EXPIRES_IN_SEC = "expires_in_sec" + + REFRESH_TOKEN = "refresh_token" + + CLIENT_ID = "client_id" + + CLIENT_SECRET = "client_secret" + + REDIRECT_URI = "redirect_uri" + + REDIRECT_URL = "redirect_url" + + OBJECT = "Object" + + DATA_TYPE = { + "String": str, + "List": list, + "Integer": int, + "HashMap": dict, + "Map": dict, + "Long": int, + "Double": float, + "Float": float, + "DateTime": datetime, + "Date": date, + "Boolean": bool, + "LocalTime": time + } + + OBJECT_KEY = "object" + + PHOTO_SUPPORTED_MODULES = ["leads", "contacts", "accounts", "products", "vendors"] + + GIVEN_LENGTH = "given-length" + + ZOHO_SDK = "X-ZOHO-SDK" + + SDK_VERSION = "1.0.0" + + CONTENT_DISPOSITION = "Content-Disposition" + + TOKEN_ERROR = "TOKEN ERROR" + + SAVE_TOKEN_ERROR = "Exception in saving tokens" + + INVALID_CLIENT_ERROR = "INVALID CLIENT ERROR" + + ERROR_KEY = 'error' + + GET_TOKEN_ERROR = "Exception in getting access token" + + MYSQL_HOST = "localhost" + + MYSQL_DATABASE_NAME = "zohooauth" + + MYSQL_USER_NAME = "root" + + MYSQL_PORT_NUMBER = "3306" + + GET_TOKEN_DB_ERROR = "Exception in getToken - DBStore" + + TOKEN_STORE = "TOKEN_STORE" + + DELETE_TOKEN_DB_ERROR = "Exception in delete_token - DBStore" + + SAVE_TOKEN_DB_ERROR = "Exception in save_token - DBStore" + + USER_NAME = "user_name" + + GRANT_TOKEN = "grant_token" + + EXPIRY_TIME = "expiry_time" + + GET_TOKEN_FILE_ERROR = "Exception in get_token - FileStore" + + SAVE_TOKEN_FILE_ERROR = "Exception in save_token - FileStore" + + DELETE_TOKEN_FILE_ERROR = "Exception in delete_token - FileStore" + + TYPE = "type" + + STREAM_WRAPPER_CLASS_PATH = 'zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper' + + FIELD = "field" + + NAME = "name" + + INDEX = "index" + + CLASS = "class" + + ACCEPTED_TYPE = "accepted_type" + + GIVEN_TYPE = "given_type" + + TYPE_ERROR = "TYPE ERROR" + + VALUES = "values" + + ACCEPTED_VALUES = "accepted_values" + + UNACCEPTED_VALUES_ERROR = "UNACCEPTED VALUES ERROR" + + MIN_LENGTH = "min-length" + + MINIMUM_LENGTH = "minimum-length" + + MINIMUM_LENGTH_ERROR = "MINIMUM LENGTH ERROR" + + UNIQUE = "unique" + + FIRST_INDEX = "first-index" + + NEXT_INDEX = "next-index" + + UNIQUE_KEY_ERROR = "UNIQUE KEY ERROR" + + MAX_LENGTH = "max-length" + + MAXIMUM_LENGTH = "maximum-length" + + MAXIMUM_LENGTH_ERROR = "MAXIMUM LENGTH ERROR" + + REGEX = "regex" + + INSTANCE_NUMBER = "instance-number" + + REGEX_MISMATCH_ERROR = "REGEX MISMATCH ERROR" + + READ_ONLY = "read-only" + + IS_KEY_MODIFIED = 'is_key_modified' + + REQUIRED = "required" + + REQUIRED_IN_UPDATE = "required-in-update" + + PRIMARY = "primary" + + MANDATORY_VALUE_ERROR = "MANDATORY VALUE ERROR" + + MANDATORY_VALUE_NULL_ERROR = "MANDATORY VALUE NULL ERROR" + + MANDATORY_KEY_ERROR = "Value missing or None for mandatory key(s): " + + MANDATORY_KEY_NULL_ERROR = "Null Value for mandatory key : " + + SET_KEY_MODIFIED = "set_key_modified" + + LIST_NAMESPACE = "List" + + MAP_NAMESPACE = "Map" + + HASH_MAP = "HashMap" + + STRUCTURE_NAME = "structure_name" + + KEYS = "keys" + + INTERFACE = "interface" + + RECORD_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Record" + + RECORD_TYPE = "zohocrmsdk.src.com.zoho.crm.api.record.record.Record" + + INVENTORY_LINE_ITEMS = "zohocrmsdk.src.com.zoho.crm.api.record.InventoryLineItems" + + PRICING_DETAILS_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.PricingDetails" + + COMMENT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Comment" + + FIELD_FILE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.FileDetails" + + REMIND_AT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.RemindAt" + + CONSENT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Consent" + + LINE_TAX_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.LineTax" + + TAX_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Tax" + + PRODUCTS = "Products" + + TAX = "TAX" + + TERRITORY = "Territory" + + REMINDER_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Reminder" + + TERRITORY_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Territory" + + IMAGE_UPLOAD_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.ImageUpload" + + ATTACHMENTS_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment" + + RECURRING_ACTIVITY_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.RecurringActivity" + + PARTICIPANTS = "zohocrmsdk.src.com.zoho.crm.api.record.Participants" + + PACKAGE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api." + + USER_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser" + + MODULE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.modules.Modules" + + LAYOUT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts" + + CHOICE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.util.Choice" + + KEY_VALUES = "key_values" + + RECORD_CLASS_NAME = "Record" + + KEY_MODIFIED = "key_modified" + + COMMENTS = "Comments" + + CLASSES = "classes" + + LOGFILE_NAME = "sdk_logs.log" + + USER = "user" + + EXPECTED_TYPE = "expected-type" + + USER_AGENT = "Mozilla/5.0" + + USER_AGENT_KEY = "user-agent" + + AT = '@' + + EXPECTED_TOKEN_TYPES = 'REFRESH, GRANT' + + INITIALIZATION_ERROR = "INITIALIZATION ERROR" + + ENVIRONMENT = "environment" + + STORE = "store" + + TOKEN = "token" + + SDK_CONFIG = "sdk_config" + + USER_PROXY = "proxy" + + JSON_DETAILS_FILE_PATH = 'json_details.json' + + EMAIL = "email" + + USER_SIGNATURE_ERROR = "USERSIGNATURE ERROR" + + USER_INITIALIZATION_ERROR = "Error during User Initialization" + + EMAIL_REGEX = '^[_a-z0-9-]+(.[_a-z0-9-]+)*@[a-z0-9-]+(.[a-z0-9-]+)*(.[a-z]{2,4})$' + + STRING = "String" + + TOKEN_TYPE = "token_type" + + GRANT = "GRANT" + + REFRESH = "REFRESH" + + CONTENT_TYPE = 'Content-Type' + + STRING_NAMESPACE = 'String' + + BOOLEAN_NAMESPACE = 'Boolean' + + INTEGER_NAMESPACE = 'Integer' + + LONG_NAMESPACE = 'Long' + + DOUBLE_NAMESPACE = 'Float' + + DATE_NAMESPACE = 'Date' + + DATETIME_NAMESPACE = 'DateTime' + + DISCOUNT = "DISCOUNT" + + LINEITEM_PRODUCT = "zohocrmsdk.src.com.zoho.crm.api.record.LineItemProduct" + + FILE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper" + + KEYS_TO_SKIP = ['Created_Time', 'Modified_Time', 'Created_By', 'Modified_By', 'Tag'] + + PRODUCT_DETAILS = "Product_Details" + + PRICING_DETAILS = "Pricing_Details" + + PARTICIPANT_API_NAME = "Participants" + + INVENTORY_MODULES = ['invoices', 'sales_orders', 'purchase_orders', 'quotes'] + + PRICE_BOOKS = "price_books" + + EVENTS = "events" + + CALLS = "calls" + + CALL_DURATION = "call_duration" + + SOLUTIONS = "solutions" + + CASES = "cases" + + ACTIVITIES = "activities" + + LAYOUT = "Layout" + + SUBFORM = "subform" + + LOOKUP = "lookup" + + SE_MODULE = "se_module" + + MODULEDETAILS = 'moduleDetails' + + MODULEPACKAGENAME = "modulePackageName" + + UNDERSCORE = "_" + + RELATED_LISTS = "Related_Lists" + + FIELD_DETAILS_DIRECTORY = "resources" + + NO_CONTENT_STATUS_CODE = 204 + + NOT_MODIFIED_STATUS_CODE = 304 + + HREF = "href" + + API_EXCEPTION = "API_EXCEPTION" + + FIELDS_LAST_MODIFIED_TIME = "FIELDS-LAST-MODIFIED-TIME" + + LINE_TAX = "$line_tax" + + CANT_DISCLOSE = " ## can't disclose ## " + + URL = "URL" + + HEADERS = "HEADERS" + + PARAMS = "PARAMS" + + INITIALIZATION_SUCCESSFUL = "Initialization successful " + + INITIALIZATION_SWITCHED = "Initialization switched " + + IN_ENVIRONMENT = " in Environment : " + + FOR_EMAIL_ID = "for Email Id : " + + REFRESH_TOKEN_MESSAGE = "Access Token has expired. Hence refreshing." + + RESOURCE_PATH_ERROR = "EMPTY_RESOURCE_PATH" + + RESOURCE_PATH_ERROR_MESSAGE = "Resource Path MUST NOT be None/empty." + + SET_CONTENT_TYPE_HEADER = ["/crm/bulk/v7/read", "/crm/bulk/v7/write", "/crm/v7/__zia_org_enrichment", "crm/v7/__zia_people_enrichment"] + + CONTENT_TYPE_HEADER = "Content-Type" + + LIST_KEY = "List" + + ATTACHMENT_ID = "attachment_id" + + FILE_ID = "file_id" + + PHOTO_UPLOAD_ERROR_MESSAGE = "The given module is not supported in API." + + INVALID_MODULE = "INVALID_MODULE" + + MULTI_SELECT_LOOKUP = "multiselectlookup" + + MULTI_USER_LOOKUP = "multiuserlookup" + + TERRITORIES = "territories" + + GENERATED_TYPE = "generated_type" + + GENERATED_TYPE_CUSTOM = "custom" + + UPLOAD_PHOTO_UNSUPPORTED_MESSAGE = "Photo Upload Operation is not supported by the module: " + + SDK_MODULE_METADATA = "SDK-MODULE-METADATA" + + INVALID_MODULE_API_NAME_ERROR = "INVALID MODULE API NAME ERROR" + + PROVIDE_VALID_MODULE_API_NAME = "PROVIDE VALID MODULE API NAME: " + + UPLOAD_PHOTO_UNSUPPORTED_ERROR = "UPLOAD PHOTO UNSUPPORTED MODULE" + + DELETE_FIELD_FILE_ERROR = "Exception in deleting Current User Fields file : " + + DELETE_FIELD_FILES_ERROR = "Exception in deleting all Fields files : " + + DELETE_MODULE_FROM_FIELDFILE_ERROR = "Exception in deleting module from Fields file : " + + FILE_BODY_WRAPPER = 'FileBodyWrapper' + + EXCEPTION_IS_KEY_MODIFIED = "Exception in calling is_key_modified : " + + EXCEPTION_SET_KEY_MODIFIED = "Exception in calling set_key_modified : " + + SET_API_URL_EXCEPTION = "Exception in setting API URL : " + + AUTHENTICATION_EXCEPTION = "Exception in authenticating current request : " + + FORM_REQUEST_EXCEPTION = "Exception in forming request body : " + + API_CALL_EXCEPTION = "Exception in current API call execution : " + + HTTP = "http" + + HTTPS = "https" + + CONTENT_API_URL = "content.zohoapis.com" + + EXCEPTION = "Exception" + + MODULE = "module" + + REQUEST_CATEGORY_READ = "READ" + + REQUEST_CATEGORY_CREATE = "CREATE" + + REQUEST_CATEGORY_UPDATE = "UPDATE" + + ID = "id" + + CODE = "code" + + STATUS = "status" + + MESSAGE = "message" + + INVALID_URL_ERROR = "Invalid URL Error" + + REQUEST_CATEGORY_ACTION = "ACTION" + + SKIP_MANDATORY = "skip-mandatory" + + FORMULA = "formula" + ROLLUP_SUMMARY = "rollup_summary" + + PICKLIST = "picklist" + + ACCOUNTS = "accounts" + + PRIMARY_KEY_ERROR = "Value missing or None for required key(s) : " + + REFRESH_SINGLE_MODULE_FIELDS_ERROR = "Exception in refreshing fields of module : " + + REFRESH_ALL_MODULE_FIELDS_ERROR = "Exception in refreshing fields of all modules : " + + GET_TOKENS_DB_ERROR = "Exception in get_tokens - DBStore" + + GET_TOKEN_DB_ERROR1 = "Exception in DBStore : Given user authentication details not found." + + DELETE_TOKENS_DB_ERROR = "Exception in delete_tokens - DBStore" + + GET_TOKENS_FILE_ERROR = "Exception in get_tokens - FileStore" + + GENERATE_TOKEN_ID_ERROR = "Exception in generateId() - DBStore" + + GET_TOKEN_BY_ID_DB_ERROR = "Exception in findTokenById() - DBStore : Given Id is invalid" + + DELETE_TOKENS_FILE_ERROR = "Exception in delete_tokens - FileStore" + + SDK_UNINITIALIZATION_ERROR = "SDK UNINITIALIZED ERROR" + + SDK_UNINITIALIZATION_MESSAGE = "SDK is UnInitialized" + + INITIALIZATION_EXCEPTION = "Exception in initialization" + + SWITCH_USER_EXCEPTION = "Exception in switching user" + + AUTO_REFRESH_FIELDS_ERROR_MESSAGE = "auto_refresh_fields MUST NOT be None." + + HEADER_NONE_ERROR = "NONE HEADER ERROR" + + PRODUCT_NAME = "Product_Name" + + HEADER_INSTANCE_NONE_ERROR = "Header Instance MUST NOT be None" + + PARAM_INSTANCE_NONE_ERROR = "Param Instance MUST NOT be None" + + HEADER_NAME_NONE_ERROR = "NONE HEADER NAME ERROR" + + HEADER_NAME_NULL_ERROR_MESSAGE = "Header Name MUST NOT be null" + + NONE_VALUE_ERROR_MESSAGE = " MUST NOT be None" + + PARAMETER_NONE_ERROR = "NONE PARAMETER ERROR" + + PARAM_NAME_NONE_ERROR = "NONE PARAM NAME ERROR" + + PARAM_NAME_NONE_ERROR_MESSAGE = "Param Name MUST NOT be None" + + USER_PROXY_ERROR = "USERPROXY ERROR" + + HOST_ERROR_MESSAGE = "Host MUST NOT be None" + + PORT_ERROR_MESSAGE = "Port MUST NOT be None" + + USER_ERROR_MESSAGE = "User MUST NOT be None/empty" + + UNSUPPORTED_IN_API = "API UNSUPPORTED OPERATION" + + UNSUPPORTED_IN_API_MESSAGE = " Operation is not supported by API" + + NULL_VALUE = "null" + + NOTES = "notes" + + ATTACHMENTS = "$attachments" + + JSON_FILE_EXTENSION = ".json" + + FILE_ERROR = "file_error" + + FILE_DOES_NOT_EXISTS = "file does not exists" + + CONSENT_LOOKUP = "consent_lookup" + + JSON_DETAILS_ERROR = "ERROR IN READING JSONDETAILS FILE" + + INVALID_TOKEN_ERROR = "INVALID TOKEN ERROR" + + NO_ACCESS_TOKEN_ERROR = "ACCESS TOKEN IS NOT PRESENT IN RESPONSE" + + CLIENT_ID_NULL_ERROR_MESSAGE = "ClientID MUST NOT be null" + + CLIENT_SECRET_NULL_ERROR_MESSAGE = "ClientSecret MUST NOT be null" + + REQUEST_PROXY_ERROR_MESSAGE = "request_proxy must be instance of Request Proxy" + + USER_SIGNATURE_ERROR_MESSAGE = "user must be instance of userSignature." + + ENVIRONMENT_ERROR_MESSAGE = "environment must be instance of Environment." + + SDK_CONFIG_ERROR_MESSAGE = "sdk_config must be instance of sdkConfig." + + TOKEN_ERROR_MESSAGE = "token must be instance of Token." + + STORE_ERROR_MESSAGE = "store must be instance of Store." + + COUNT = "count" + + OWNER_LOOKUP = "ownerlookup" + + TOKEN_FILE = "sdk_tokens.txt" + + LOG_FILE_NAME = "sdk_logs.log" + + SKIP_MODULES = ["deals"] + + PYTHON = "python_" + + OAUTH_MANDATORY_KEYS = ["grant_token", "refresh_token", "id", "access_token"] + + OAUTH_MANDATORY_KEYS1 = ["client_id", "client_secret"] + + OAUTH_MANDATORY_KEYS2 = ["grant_token", "refresh_token"] + + INIT_MANDATORY_KEYS = ["token", "user"] + + ACCESS_TOKEN_USING_REFRESH_TOKEN_MESSAGE = "Access token can be generated by refresh token" + + ACCESS_TOKEN_USING_GRANT_TOKEN_MESSAGE = "Access token can be generated by grant token." + + REVOKE_URL = "/revoke" + + REFRESH_TOKEN_REMOVED = " Refresh token revoked successfully." + + TOKEN_NOT_FOUND = " No tokens exist for the given user-id." + + REVOKE_TOKEN_ERROR = "Exception while revoke the refresh token." + + GET_TOKEN_FILE_ERROR1 = "Exception in FileStore : Given user authentication details not found." + + API_DOMAIN = "api_domain" + + DEVELOPER = "developer" + + SANDBOX = "sandbox" + + DATACENTER_ERROR = "DATACENTER_ERROR" + + ENVIRONMENT_ERROR = "The given DataCenter config not valid. Please check the domain URL" + + US_DATACENTER = ["https://www.zohoapis.com", "https://sandbox.zohoapis.com", "https://developer.zohoapis.com", + "https://accounts.zoho.com/oauth/v2/token", "us"] + + JP_DATACENTER = ["https://www.zohoapis.jp", "https://sandbox.zohoapis.jp", "https://developer.zohoapis.jp", + "https://accounts.zoho.jp/oauth/v2/token", "jp"] + + IN_DATACENTER = ["https://www.zohoapis.in", "https://sandbox.zohoapis.in", "https://developer.zohoapis.in", + "https://accounts.zoho.in/oauth/v2/token", "in"] + + EU_DATACENTER = ["https://www.zohoapis.eu", "https://sandbox.zohoapis.eu", "https://developer.zohoapis.eu", + "https://accounts.zoho.eu/oauth/v2/token", "eu"] + + CN_DATACENTER = ["https://www.zohoapis.com.cn", "https://sandbox.zohoapis.com.cn", + "https://developer.zohoapis.com.cn", "https://accounts.zoho.com.cn/oauth/v2/token", "cn"] + + AU_DATACENTER = ["https://www.zohoapis.com.au", "https://sandbox.zohoapis.com.au", + "https://developer.zohoapis.com.au", "https://accounts.zoho.com.au/oauth/v2/token", "au"] + CA_DATACENTER = ["https://www.zohoapis.ca", "https://sandbox.zohoapis.ca", "https://developer.zohoapis.ca", "https://accounts.zoho.ca/oauth/v2/token", "ca"] + + PRIMITIVE_TYPES = { + "str": "String", + "bool": "Boolean", + "int": "Integer", + "float": "Float", + "date": "Date", + "datetime": "DateTime" + } + + ENVIRONMENT_ERROR_1 = "ENVIRONMENT_ERROR" + + ENVIRONMENT_ERROR_RESPONSE = "Exception in set the api environment." + CURRENTUSER = "CurrentUser" + PARAM_EXCEPTION = "Exception in forming request Parameter : " + HEADER_EXCEPTION = "Exception in forming request Header : " + TIME_RANGE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.TimeRange" + SUB_TYPE = "sub_type" diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/converter.py new file mode 100755 index 0000000..6ad71f1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/converter.py @@ -0,0 +1,312 @@ +try: + from abc import ABC, abstractmethod + import logging + import sys + import zlib + import base64 + import re + import os + import importlib + from zohocrmsdk.src.com.zoho.crm.api.util import Utility, Choice + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + +except Exception: + from abc import ABC, abstractmethod + import logging + import sys + import zlib + import base64 + import re + import os + import importlib + from .utility import Utility + from .choice import Choice + from ..initializer import Initializer + +class Converter(ABC): + """ + This abstract class is to construct API request and response. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + """ + Creates a Converter class instance with the CommonAPIHandler class instance. + :param common_api_handler: A CommonAPIHandler class instance. + """ + + self.common_api_handler = common_api_handler + + @abstractmethod + def get_response(self, response, pack): + + """ + This abstract method to process the API response. + :param response: A object containing the API response contents or response. + :param pack: A str containing the expected method return type. + :return: A object representing the POJO class instance. + """ + + pass + + @abstractmethod + def form_request(self, request_instance, pack, instance_number, class_member_detail): + + """ + This abstract method to construct the API request. + :param request_instance: A Object containing the POJO class instance. + :param pack: A str containing the expected method return type. + :param instance_number: An int containing the POJO class instance list number. + :param class_member_detail : A dict representing the member details + :return: A object representing the API request body object. + """ + + pass + + @abstractmethod + def append_to_request(self, request_base, request_object): + + """ + This abstract method to construct the API request body. + :param request_base: A HttpEntityEnclosingRequestBase class instance. + :param request_object: A object containing the API request body object. + """ + + pass + + @abstractmethod + def get_wrapped_response(self, response, pack): + + """ + This abstract method to process the API response. + :param response: A object containing the HttpResponse class instance. + :param pack: A str containing the expected method return type. + :return: A object representing the POJO class instance. + """ + pass + + def value_checker(self, class_name, member_name, key_details, value, unique_values_map, instance_number): + + """ + This method is to validate if the input values satisfy the constraints for the respective fields. + :param class_name: A str containing the class name. + :param member_name: A str containing the member name. + :param key_details: A JSON object containing the key JSON details. + :param value: A object containing the key value. + :param unique_values_map: A list containing the construct objects. + :param instance_number: An int containing the POJO class instance list number. + :return: A bool representing the key value is expected pattern, unique, length, and values. + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + + except Exception: + from ..exception import SDKException + from .constants import Constants + from ..initializer import Initializer + + details_jo = {} + name = key_details[Constants.NAME] + data_type = key_details[Constants.TYPE] + check = True + given_type = None + + if value is not None: + if Constants.INTERFACE in key_details and key_details[Constants.INTERFACE]: + interface_details = Initializer.get_initializer().json_details[key_details[Constants.STRUCTURE_NAME]] + classes = interface_details[Constants.CLASSES] + check = False + for each_class in classes: + path_split = str(value.__class__.__module__).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + + if pack == each_class: + check = True + break + else: + given_type = value.__class__ + + if data_type in Constants.DATA_TYPE: + if value is not None and isinstance(value, list) and Constants.STRUCTURE_NAME in key_details: + structure_name = key_details[Constants.STRUCTURE_NAME] + index = 0 + path_split = str(structure_name).rpartition('.') + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, path_split[-1]) + + for each_instance in value: + if not isinstance(each_instance, class_holder): + check = False + instance_number = index + data_type = Constants.LIST_KEY + '[' + structure_name + ']' + given_type = each_instance.__module__ + break + + index = index + 1 + elif value is not None and isinstance(value, list) and Constants.SUB_TYPE in key_details: + index = 0 + sub_type1 = key_details[Constants.SUB_TYPE] + sub_type = sub_type1[Constants.TYPE] + if sub_type.lower() == Constants.OBJECT_KEY: + check = True + else: + for each_instance in value: + if not Utility.check_data_type(each_instance, sub_type): + check = False + instance_number = index + if sub_type in Constants.DATA_TYPE: + sub_type = Constants.DATA_TYPE.get(sub_type).__name__ + data_type = Constants.LIST_KEY + '[' + sub_type + ']' + given_type = Constants.LIST_KEY + '[' + each_instance.__class__.__name__ + ']' + break + index = index + 1 + else: + check = Utility.check_data_type(value=value, data_type=data_type) + + elif value is not None and data_type.lower() != Constants.OBJECT_KEY: + if data_type == "TimeZone": + check = True + else: + path_split = str(data_type).rpartition('.') + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, path_split[-1]) + + if not isinstance(value, class_holder): + check = False + if not check and value is not None: + details_jo[Constants.FIELD] = name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.ACCEPTED_TYPE] = data_type + details_jo[Constants.GIVEN_TYPE] = given_type + if instance_number is not None: + details_jo[Constants.INDEX] = instance_number + + raise SDKException(code=Constants.TYPE_ERROR, details=details_jo) + + if Constants.VALUES in key_details and \ + (Constants.PICKLIST not in key_details + or (key_details[Constants.PICKLIST] + and Initializer.get_initializer().sdk_config.get_pick_list_validation())): + values_ja = key_details[Constants.VALUES] + + if isinstance(value, list): + value_1 = value + for value_2 in value_1: + if isinstance(value_2, Choice): + choice = value_2 + value_2 = choice.get_value() + if str(value_2) not in values_ja: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_VALUE] = value + details_jo[Constants.ACCEPTED_VALUES] = values_ja + if instance_number is not None: + details_jo[Constants.INDEX] = instance_number + + raise SDKException(code=Constants.UNACCEPTED_VALUES_ERROR, details=details_jo) + else: + if isinstance(value, Choice): + value = value.get_value() + + if value not in values_ja: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_VALUE] = value + details_jo[Constants.ACCEPTED_VALUES] = values_ja + if instance_number is not None: + details_jo[Constants.INDEX] = instance_number + + raise SDKException(code=Constants.UNACCEPTED_VALUES_ERROR, details=details_jo) + + if Constants.UNIQUE in key_details: + if name not in unique_values_map: + unique_values_map[name] = [] + + values_array = unique_values_map[name] + + if value in values_array: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.FIRST_INDEX] = values_array.index(value) + 1 + details_jo[Constants.NEXT_INDEX] = instance_number + + raise SDKException(code=Constants.UNIQUE_KEY_ERROR, details=details_jo) + + else: + unique_values_map[name].append(value) + + if Constants.MIN_LENGTH in key_details or Constants.MAX_LENGTH in key_details: + count = len(str(value)) + + if isinstance(value, list): + count = len(value) + + if Constants.MAX_LENGTH in key_details and count > key_details[Constants.MAX_LENGTH]: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_LENGTH] = count + details_jo[Constants.MAXIMUM_LENGTH] = key_details[Constants.MAX_LENGTH] + + raise SDKException(code=Constants.MAXIMUM_LENGTH_ERROR, details=details_jo) + + if Constants.MIN_LENGTH in key_details and count < key_details[Constants.MIN_LENGTH]: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_LENGTH] = count + details_jo[Constants.MINIMUM_LENGTH] = key_details[Constants.MIN_LENGTH] + + raise SDKException(code=Constants.MINIMUM_LENGTH_ERROR, details=details_jo) + + return True + + def module_to_class(self, module_name): + class_name = module_name + + if "_" in module_name: + class_name = '' + module_split = str(module_name).split('_') + for each_name in module_split: + each_name = each_name.capitalize() + class_name += each_name + else: + class_name = module_name[0].upper() + module_name[1:] + + return class_name + + @classmethod + def get_encoded_file_name(self): + + try: + from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken + except: + from ....api.authenticator.oauth_token import OAuthToken + initializer = Initializer.get_initializer() + token = initializer.token + token_key = "" + if isinstance(token, OAuthToken): + oauth_token = token + if oauth_token.get_user_signature() is not None: + token_key = oauth_token.get_user_signature().get_name() + else: + refresh_token = oauth_token.get_refresh_token() + if refresh_token is not None and len(refresh_token) > 0: + token_key = refresh_token[0:len(refresh_token) - 32] + else: + access_token = oauth_token.get_access_token() + if access_token is not None and len(access_token) > 0: + token_key = access_token[0:len(access_token) - 32] + + file_name = initializer.environment.url + if token_key is not None and len(token_key) > 0: + file_name = file_name + token_key + + input_bytes = file_name.encode("UTF-8") + encoded_string = base64.b64encode(input_bytes) + encoded_string = str(encoded_string.decode("UTF-8")) + return encoded_string + '.json' diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/datatype_converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/datatype_converter.py new file mode 100755 index 0000000..1585b77 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/datatype_converter.py @@ -0,0 +1,125 @@ +try: + from dateutil.tz import tz + import dateutil.parser + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from datetime import date, datetime,time +except Exception: + from dateutil.tz import tz + import dateutil.parser + from .constants import Constants + from datetime import date, datetime,time + + +class DataTypeConverter(object): + + """ + This class converts JSON value to the expected object type and vice versa. + """ + + pre_converter_map = {} + + post_converter_map = {} + + @staticmethod + def init(): + + """ + The method to initialize the PreConverter and PostConverter lambda functions. + """ + + if len(DataTypeConverter.pre_converter_map) != 0 and len(DataTypeConverter.post_converter_map) != 0: + return + + DataTypeConverter.add_to_map("String", lambda obj: str(obj), lambda obj: str(obj)) + DataTypeConverter.add_to_map("Integer", lambda obj: int(obj), lambda obj: int(obj)) + DataTypeConverter.add_to_map("Long", lambda obj: int(obj) if str(obj) != Constants.NULL_VALUE else None, lambda obj: int(obj)) + DataTypeConverter.add_to_map("Boolean", lambda obj: bool(obj), lambda obj: bool(obj)) + DataTypeConverter.add_to_map("Float", lambda obj: float(obj), lambda obj: float(obj)) + DataTypeConverter.add_to_map("Double", lambda obj: float(obj), lambda obj: float(obj)) + DataTypeConverter.add_to_map("Date", lambda obj: dateutil.parser.isoparse(obj).date(), lambda obj: obj.isoformat()) + DataTypeConverter.add_to_map("DateTime", lambda obj: dateutil.parser.isoparse(obj).astimezone(tz.tzlocal()), lambda obj: obj.replace(microsecond=0).astimezone(tz.tzlocal()).isoformat()) + DataTypeConverter.add_to_map("Object", lambda obj: DataTypeConverter.pre_convert_object_data(obj), lambda obj: DataTypeConverter.post_convert_object_data(obj)) + DataTypeConverter.add_to_map("TimeZone", lambda obj: str(obj), lambda obj: str(obj)) + DataTypeConverter.add_to_map("LocalTime", lambda obj: DataTypeConverter.string_to_local_time(obj), lambda obj: DataTypeConverter.local_time_to_sting(obj)) + + @ staticmethod + def local_time_to_sting(obj): + return str(obj.hour) + ':' + str(obj.minute) + + @staticmethod + def string_to_local_time(obj): + value = str(obj).split(':') + return time(int(value[0]), int(value[1])) + + @staticmethod + def pre_convert_object_data(obj): + return obj + + @staticmethod + def post_convert_object_data(obj): + + if obj is None: + return None + if isinstance(obj, list): + list_value = [] + for data in obj: + list_value.append(DataTypeConverter.post_convert_object_data(data)) + + return list_value + + elif isinstance(obj, dict): + dict_value = {} + for key, value in obj.items(): + dict_value[key] = DataTypeConverter.post_convert_object_data(value) + + return dict_value + + elif isinstance(obj, date): + return DataTypeConverter.post_convert(obj, Constants.DATE_NAMESPACE) + + elif isinstance(obj, datetime): + return DataTypeConverter.post_convert(obj, Constants.DATETIME_NAMESPACE) + + else: + return obj + + @staticmethod + def add_to_map(name, pre_converter, post_converter): + + """ + This method to add PreConverter and PostConverter instance. + :param name: A str containing the data type class name. + :param pre_converter: A pre_converter instance. + :param post_converter: A post_converter instance. + """ + + DataTypeConverter.pre_converter_map[name] = pre_converter + DataTypeConverter.post_converter_map[name] = post_converter + + @staticmethod + def pre_convert(obj, data_type): + + """ + The method to convert JSON value to expected data value. + :param obj: An object containing the JSON value. + :param data_type: A str containing the expected method return type. + :return: An object containing the expected data value. + """ + + DataTypeConverter.init() + if data_type in DataTypeConverter.pre_converter_map: + return DataTypeConverter.pre_converter_map[data_type](obj) + + @staticmethod + def post_convert(obj, data_type): + + """ + The method to convert python data to JSON data value. + :param obj: A object containing the python data value. + :param data_type: A str containing the expected method return type. + :return: An object containing the expected data value. + """ + + DataTypeConverter.init() + if data_type in DataTypeConverter.post_converter_map: + return DataTypeConverter.post_converter_map[data_type](obj) diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/downloader.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/downloader.py new file mode 100755 index 0000000..39927a8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/downloader.py @@ -0,0 +1,97 @@ +try: + import importlib + import logging + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util import Converter, Constants, JSONConverter +except Exception: + import importlib + import logging + import re + from .converter import Converter + from .constants import Constants + from .json_converter import JSONConverter + + +class Downloader(Converter): + + """ + This class to process the download file and stream response. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + self.unique_dict = {} + self.common_api_handler = common_api_handler + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + + return None + + def append_to_request(self, request_base, request_object): + + return + + def get_wrapped_response(self, response, pack): + + return self.get_response(response, pack) + + def get_response(self, response, pack): + + try: + from zohocrmsdk.src.com.zoho.crm.api import Initializer + + except Exception: + from ..initializer import Initializer + + path_split = str(pack).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + class_detail = dict(Initializer.json_details[str(pack)]) + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + classes = class_detail[Constants.CLASSES] + + for each_class in classes: + if Constants.FILE_BODY_WRAPPER in each_class: + return self.get_response(response, each_class) + else: + instance = self.get_class(class_name, path_split[0])() + + for member_name, member_detail in class_detail.items(): + data_type = member_detail[Constants.TYPE] + instance_value = None + + if data_type == Constants.STREAM_WRAPPER_CLASS_PATH: + file_name = '' + content_disposition = response.headers[Constants.CONTENT_DISPOSITION] + + if "'" in content_disposition: + start_index = content_disposition.rindex("'") + file_name = content_disposition[start_index + 1:] + + elif '"' in content_disposition: + start_index = content_disposition.rindex('=') + file_name = content_disposition[start_index + 1:].replace('"', '') + + stream_path_split = str(data_type).rpartition(".") + stream_class_name = self.module_to_class(stream_path_split[-1]) + instance_value = self.get_class(stream_class_name, stream_path_split[0])(file_name, response) + + setattr(instance, + self.construct_private_member(class_name=class_name, member_name=member_name), instance_value) + + return instance + + @staticmethod + def construct_private_member(class_name, member_name): + return '_' + class_name + '__' + member_name + + @staticmethod + def get_class(class_name, class_path): + imported_module = importlib.import_module(class_path) + class_holder = getattr(imported_module, class_name) + return class_holder diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/form_data_converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/form_data_converter.py new file mode 100755 index 0000000..29f59c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/form_data_converter.py @@ -0,0 +1,198 @@ +try: + import importlib + import logging + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util import Utility,Converter, Constants, StreamWrapper + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + +except Exception: + import importlib + import logging + import re + from .converter import Converter + from .constants import Constants + from .utility import Utility + from .stream_wrapper import StreamWrapper + from ..exception import SDKException + + +class FormDataConverter(Converter): + """ + This class to process the upload file and stream. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + self.unique_dict = {} + self.common_api_handler = common_api_handler + + def append_to_request(self, request_base, request_object): + form_data_request_body = [] + self.add_file_body(request_object, form_data_request_body) + request_base.file = True + return form_data_request_body + + def add_file_body(self, request_object, request_body): + for key_name, key_value in request_object.items(): + if isinstance(key_value, list): + for each_object in key_value: + if isinstance(each_object, StreamWrapper): + request_body.append((key_name, each_object.get_stream())) + else: + request_body.append((key_name, key_value)) + elif isinstance(key_value, StreamWrapper): + entry = (key_name, key_value.get_stream()) + request_body.append(entry) + else: + entry = (key_name, key_value) + request_body.append(entry) + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + path_split = str(pack).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + class_detail = dict(Initializer.json_details[str(pack)]) + request = dict() + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + request_object_class_name = request_instance.__class__.__module__ + request_object_class_name = str(request_object_class_name) + path_split = str(request_object_class_name).rpartition(".") + request_class_name = self.module_to_class(path_split[-1]) + request_object_class_name = path_split[0] + "." + request_class_name + classes = class_detail[Constants.CLASSES] + + for class_name in classes: + class_name_interface_lower = str(class_name).lower() + request_class_path_lower = request_object_class_name.lower() + if class_name_interface_lower == request_class_path_lower: + class_detail = dict(Initializer.json_details[str(class_name)]) + class_name = str(class_name).rpartition(".") + class_name = self.module_to_class(class_name[-1]) + break + + for member_name, member_detail in class_detail.items(): + modification = None + + if (Constants.READ_ONLY in member_detail and bool( + member_detail[Constants.READ_ONLY])) or Constants.NAME not in member_detail: + continue + + try: + modification = getattr(request_instance, Constants.IS_KEY_MODIFIED)(member_name) + except Exception as e: + raise SDKException(code=Constants.EXCEPTION_IS_KEY_MODIFIED, cause=e) + + if (modification is None or modification == 0) and Constants.REQUIRED in member_detail and bool( + member_detail[Constants.REQUIRED]): + raise SDKException(Constants.MANDATORY_VALUE_ERROR, + Constants.MANDATORY_KEY_ERROR + member_name) + + field_value = getattr(request_instance, self.construct_private_member(class_name=class_name, member_name=member_name)) + + if modification is not None and modification != 0 and field_value is not None and self.value_checker( + class_name=class_name, + member_name=member_name, + key_details=member_detail, + value=field_value, + unique_values_map=self.unique_dict, + instance_number=instance_number) is True: + key_name = member_detail.get(Constants.NAME) + data_type = member_detail.get(Constants.TYPE) + + if data_type == Constants.LIST_NAMESPACE: + request[key_name] = self.set_json_array(field_value, member_detail) + + elif data_type == Constants.MAP_NAMESPACE: + request[key_name] = self.set_json_object(field_value, member_detail) + + elif Constants.STRUCTURE_NAME in member_detail: + request[key_name] = \ + self.form_request(field_value, member_detail.get(Constants.STRUCTURE_NAME), 0, member_detail) + + else: + request[key_name] = field_value + + return request + + def set_json_object(self, field_value, member_detail): + json_object = {} + request_object = dict(field_value) + + if member_detail is None: + for key, value in request_object.items(): + json_object[key] = self.redirector_for_object_to_json(value) + + else: + keys_detail = member_detail[Constants.KEYS] + + for key_detail in keys_detail: + key_name = key_detail[Constants.NAME] + key_value = None + + if key_name in request_object and request_object[key_name] is not None: + if Constants.STRUCTURE_NAME in key_detail: + key_value = self.form_request(field_value[key_name], + key_detail[Constants.STRUCTURE_NAME], 0, member_detail) + + else: + key_value = self.redirector_for_object_to_json(field_value[key_name]) + + json_object[key_name] = key_value + + return json_object + + def set_json_array(self, field_value, member_detail): + json_array = [] + request_objects = list(field_value) + + if member_detail is None: + for request in request_objects: + json_array.append(self.redirector_for_object_to_json(request)) + + else: + if Constants.STRUCTURE_NAME in member_detail: + instance_count = 0 + pack = member_detail[Constants.STRUCTURE_NAME] + + for request in request_objects: + json_array.append(self.form_request(request, pack, instance_count, member_detail)) + instance_count += 1 + + else: + for request in field_value: + json_array.append(self.redirector_for_object_to_json(request)) + + return json_array + + def redirector_for_object_to_json(self, request): + if isinstance(request, list): + return self.set_json_array(request, None) + + if isinstance(request, dict): + return self.set_json_object(request, None) + + else: + return request + + def get_wrapped_response(self, response, pack): + return None + + def get_response(self, response, pack): + return None + + @staticmethod + def construct_private_member(class_name, member_name): + return '_' + class_name + '__' + member_name + + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/header_param_validator.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/header_param_validator.py new file mode 100755 index 0000000..a9865cf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/header_param_validator.py @@ -0,0 +1,114 @@ +try: + import os + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + +except Exception: + import os + import re + import json + from .datatype_converter import DataTypeConverter + from ..exception import SDKException + from .constants import Constants + + +class HeaderParamValidator(object): + """ + This class validates the Header and Parameter values with the type accepted by the CRM APIs. + """ + + def validate(self, name, class_name, value): + json_details = self.get_json_details() + json_class_name = self.get_file_name(class_name) + type_detail = None + + if json_class_name in json_details: + type_detail = self.get_key_json_details(name, json_details[json_class_name]) + + if type_detail is not None: + try: + from zohocrmsdk.src.com.zoho.crm.api.util.utility import Utility + except Exception: + from .utility import Utility + if not Utility.check_data_type(value, type_detail[Constants.TYPE]): + param_or_header = 'PARAMETER' if json_class_name is not None and json_class_name.endswith( + 'Param') else 'HEADER' + error_details = { + param_or_header: name, + Constants.CLASS: json_class_name, + Constants.ACCEPTED_TYPE: Constants.DATA_TYPE.get(type_detail[Constants.TYPE]).__name__ if + type_detail[Constants.TYPE] in Constants.DATA_TYPE else type_detail[Constants.TYPE] + } + raise SDKException(code=Constants.TYPE_ERROR, details=error_details) + if Constants.STRUCTURE_NAME in type_detail: + try: + from zohocrmsdk.src.com.zoho.crm.api.util.json_converter import JSONConverter + from zohocrmsdk.src.com.zoho.crm.api.util.common_api_handler import CommonAPIHandler + except Exception: + from .json_converter import JSONConverter + from .common_api_handler import CommonAPIHandler + return json.dumps(JSONConverter(CommonAPIHandler()).form_request(value, type_detail[Constants.TYPE], None, None)) + return self.parse_data(value, type_detail[Constants.TYPE]) + return value + + def parse_data(self, value, type): + if type == Constants.MAP_NAMESPACE: + json_object = {} + request_object = dict(value) + if len(request_object) > 0: + for key, field_value in request_object.items(): + json_object[key] = self.parse_data(field_value, type) + return json_object + elif type == Constants.LIST_NAMESPACE: + json_array = [] + request_objects = list(value) + if len(request_objects) > 0: + for request_object in request_objects: + json_array.append(self.parse_data(request_object, type)) + return json_array + elif type == Constants.CHOICE_NAMESPACE: + return value.get_value() + else: + return DataTypeConverter.post_convert(value, type) + + def get_key_json_details(self, name, json_details): + for key_name in json_details.keys(): + detail = json_details[key_name] + + if Constants.NAME in detail: + if detail[Constants.NAME].lower() == name.lower(): + return detail + + def get_file_name(self, name): + if "." in name: + sdk_name = 'zohocrmsdk.src.' + name_split = str(name).split('.') + class_name = name_split.pop() + package_name = name_split.pop() + pack_split = re.findall('[A-Z][^A-Z]*', package_name) + sdk_package_name = pack_split[0].lower() + if len(pack_split) > 1: + for i in range(1, len(pack_split)): + sdk_package_name += '_' + pack_split[i].lower() + name_split = list(map(lambda x: x.lower(), name_split)) + sdk_name = sdk_name + '.'.join(name_split) + '.' + sdk_package_name + '.' + class_name + return sdk_name + return name + + def get_json_details(self): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + if Initializer.json_details is None: + dir_name = os.path.dirname(__file__) + filename = os.path.join(dir_name, '..', '..', '..', '..', '..', Constants.JSON_DETAILS_FILE_PATH) + + with open(filename, mode='r') as JSON: + Initializer.json_details = json.load(JSON) + + return Initializer.json_details diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/json_converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/json_converter.py new file mode 100755 index 0000000..146e80f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/json_converter.py @@ -0,0 +1,779 @@ +try: + import importlib + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util.converter import Converter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.util.utility import Utility + from zohocrmsdk.src.com.zoho.crm.api.util.choice import Choice + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +except Exception: + import importlib + import re + from ..exception import SDKException + from .converter import Converter + from .constants import Constants + from .datatype_converter import DataTypeConverter + from .utility import Utility + from .choice import Choice + + +class JSONConverter(Converter): + """ + This class processes the API response to the object and an object to a JSON object, containing the request body. + """ + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + self.unique_dict = {} + self.common_api_handler = common_api_handler + + def append_to_request(self, request_base, request_object): + return json.dumps(request_object).encode('utf-8') + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + path_split = str(pack).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + class_detail = dict(Initializer.json_details[str(pack)]) + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + request_object_class_name = request_instance.__class__.__module__ + request_object_class_name = str(request_object_class_name) + path_split = str(request_object_class_name).rpartition(".") + request_class_name = self.module_to_class(path_split[-1]) + request_object_class_name = path_split[0] + "." + request_class_name + classes = class_detail[Constants.CLASSES] + + for class_name in classes: + class_name_interface_lower = str(class_name).lower() + request_class_path_lower = request_object_class_name.lower() + if class_name_interface_lower == request_class_path_lower: + class_detail = dict(Initializer.json_details[str(class_name)]) + class_name = str(class_name).rpartition(".") + class_name = self.module_to_class(class_name[-1]) + break + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if isinstance(request_instance, Record): + module_api_name = self.common_api_handler.get_module_api_name() + return_json = self.is_record_request(request_instance, class_detail, instance_number, class_member_detail) + self.common_api_handler.set_module_api_name(module_api_name) + return return_json + + else: + return self.is_not_record_request(request_instance, class_name, class_detail, + instance_number, class_member_detail) + + def is_not_record_request(self, request_instance, class_name, class_detail, instance_number, class_member_detail): + try: + from zohocrmsdk.src.com.zoho.crm.api.record import FileDetails + except Exception: + from ..record import FileDetails + + lookup = False + skip_mandatory = False + class_member_name = None + if class_member_detail is not None: + lookup = class_member_detail[Constants.LOOKUP] if Constants.LOOKUP in class_member_detail else False + skip_mandatory = class_member_detail[Constants.SKIP_MANDATORY] \ + if Constants.SKIP_MANDATORY in class_member_detail else False + class_member_name = class_member_detail[Constants.NAME] + + request_json = {} + required_keys, primary_keys, required_in_update_keys = {}, {}, {} + + for member_name, member_detail in class_detail.items(): + if Constants.READ_ONLY in member_name or (Constants.NAME not in member_detail): + continue + + key_name = member_detail[Constants.NAME] + try: + modification = getattr(request_instance, Constants.IS_KEY_MODIFIED)(key_name) + except Exception as e: + raise SDKException(code=Constants.EXCEPTION_IS_KEY_MODIFIED, cause=e) + + if Constants.REQUIRED in member_detail and member_detail[Constants.REQUIRED]: + required_keys[key_name] = True + + if Constants.PRIMARY in member_detail and member_detail[Constants.PRIMARY] and \ + (Constants.REQUIRED_IN_UPDATE not in member_detail or member_detail[Constants.REQUIRED_IN_UPDATE]): + primary_keys[key_name] = True + + if Constants.REQUIRED_IN_UPDATE in member_detail and member_detail[Constants.REQUIRED_IN_UPDATE]: + required_in_update_keys[key_name] = True + + field_value = None + if modification is not None and modification != 0: + field_value = getattr(request_instance, + self.construct_private_member(class_name=class_name, member_name=member_name)) + if field_value is not None: + + if self.value_checker(class_name=class_name, member_name=member_name, key_details=member_detail, + value=field_value, unique_values_map=self.unique_dict, + instance_number=instance_number) is True: + required_keys.pop(key_name, None) + primary_keys.pop(key_name, None) + required_in_update_keys.pop(key_name, None) + + if isinstance(request_instance, FileDetails): + if field_value is None or (isinstance(field_value, str) and field_value == "null"): + request_json[key_name.lower()] = None if field_value is None else field_value + else: + request_json[key_name.lower()] = field_value + + else: + request_json[key_name] = self.set_data(member_detail, field_value) + + if skip_mandatory or self.check_exception(class_member_name, request_instance, instance_number, + lookup, required_keys, primary_keys, required_in_update_keys) is True: + return request_json + + def check_exception(self, member_name, request_instance, instance_number, + lookup, required_keys, primary_keys, required_in_update_keys): + if bool(required_in_update_keys) and self.common_api_handler.get_category_method() is not None and \ + self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_UPDATE: + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(required_in_update_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.MANDATORY_KEY_ERROR, error) + + if self.common_api_handler.get_mandatory_checker() is not None and \ + self.common_api_handler.get_mandatory_checker(): + if self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_CREATE: + if lookup: + if bool(primary_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(primary_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.MANDATORY_KEY_ERROR, error) + + elif bool(required_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(required_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.MANDATORY_KEY_ERROR, error) + + if self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_UPDATE and \ + bool(primary_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(primary_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.PRIMARY_KEY_ERROR, error) + + elif lookup and self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_UPDATE: + if bool(primary_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(primary_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.PRIMARY_KEY_ERROR, error) + + return True + + def is_record_request(self, record_instance, class_detail, instance_number, member_detail): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + lookup = False + skip_mandatory = False + class_member_name = None + if member_detail is not None: + lookup = member_detail[Constants.LOOKUP] if Constants.LOOKUP in member_detail else False + skip_mandatory = member_detail[ + Constants.SKIP_MANDATORY] if Constants.SKIP_MANDATORY in member_detail else False + class_member_name = member_detail[Constants.NAME] + + request_json, module_detail = {}, {} + module_api_name = self.common_api_handler.get_module_api_name() + class_name = record_instance.__class__.__name__ + + if module_api_name is not None: + self.common_api_handler.set_module_api_name(None) + module_detail = self.__get_module_detail_from_user_spec_json(module_api_name) + else: + module_detail = class_detail + class_detail = Initializer.json_details[Constants.RECORD_NAMESPACE] + + class_list = record_instance.__class__.mro() + + for each_class in class_list: + if Constants.RECORD_TYPE in str(each_class): + class_name = Constants.RECORD_CLASS_NAME + break + + key_values = getattr(record_instance, self.construct_private_member(class_name, Constants.KEY_VALUES)) + key_modified = getattr(record_instance, self.construct_private_member(class_name, Constants.KEY_MODIFIED)) + + required_keys, primary_keys = {}, {} + + if not skip_mandatory: + for key_name, key_detail in module_detail.items(): + if Constants.NAME in key_detail: + name = key_detail[Constants.NAME] + if key_detail is not None and Constants.REQUIRED in key_detail and key_detail[Constants.REQUIRED]: + required_keys[name] = True + + if key_detail is not None and Constants.PRIMARY in key_detail and key_detail[Constants.PRIMARY]: + primary_keys[name] = True + + for key_name, key_detail in class_detail.items(): + name = key_detail[Constants.NAME] + if Constants.REQUIRED in key_detail and key_detail[Constants.REQUIRED]: + required_keys[name] = True + + if Constants.PRIMARY in key_detail and key_detail[Constants.PRIMARY]: + primary_keys[name] = True + + for key_name in key_modified.keys(): + if key_modified.get(key_name) != 1: + continue + + key_detail = {} + key_value = key_values.get(key_name) if key_name in key_values else None + json_value = None + member_name = self.build_name(key_name) + + custom_handling = False + + if len(module_detail) > 0 and (member_name in module_detail or key_name in module_detail): + key_detail = module_detail[key_name] if key_name in module_detail else module_detail[member_name] + + elif member_name in class_detail: + key_detail = class_detail[member_name] + + else: + custom_handling = True + + if key_value is not None: + if key_detail is not None and len(key_detail) > 0: + if (Constants.READ_ONLY in key_detail and bool(key_detail[Constants.READ_ONLY])) or \ + (Constants.NAME not in key_detail): + continue + + if self.value_checker(class_name, key_name, key_detail, key_value, self.unique_dict, instance_number): + json_value = self.set_data(key_detail, key_value) + else: + if key_detail is None or len(key_detail) == 0: + custom_handling = True + if custom_handling and not isinstance(key_value, list) and not isinstance(key_value, dict) and not isinstance(key_value, Choice): + if key_value.__class__.__name__ in Constants.PRIMITIVE_TYPES: + key_detail[Constants.TYPE] = Constants.PRIMITIVE_TYPES.get(key_value.__class__.__name__) + json_value = self.set_data(key_detail, key_value) + elif self.get_class_name(key_value.__module__) in Initializer.json_details: + key_detail[Constants.STRUCTURE_NAME] = self.get_class_name(key_value.__module__) + key_detail[Constants.NAME] = key_name + key_detail[Constants.TYPE] = self.get_class_name(key_value.__module__) + json_value = self.set_data(key_detail, key_value) + else: + if custom_handling and isinstance(key_value, list): + class_of_keyvalue = self.get_class_name(key_value[0].__module__) + if class_of_keyvalue in Initializer.json_details: + key_detail[Constants.STRUCTURE_NAME] = class_of_keyvalue + key_detail[Constants.NAME] = key_name + key_detail[Constants.TYPE] = class_of_keyvalue + json_value = self.set_json_array(key_value, key_detail) + else: + json_value = self.redirector_for_object_to_json(key_value) + else: + json_value = self.redirector_for_object_to_json(key_value) + + else: + json_value = None + + if key_value is not None: + required_keys.pop(key_name, None) + primary_keys.pop(key_name, None) + + request_json[key_name] = json_value + + if skip_mandatory or self.check_exception(class_member_name, record_instance, instance_number, + lookup, required_keys, primary_keys, {}) is True: + return request_json + + @staticmethod + def get_class_name(class_name): + class_name_array = class_name.split(".") + class_array = class_name_array[-1].split("_") + for i in range(len(class_array)): + class_array[i] = class_array[i].capitalize() + class_name = "".join(class_array) + class_name_array[-1] = class_name + return ".".join(class_name_array) + + def set_data(self, member_detail, field_value): + if field_value is not None: + data_type = member_detail[Constants.TYPE] + return self.set_data_value(data_type, member_detail, field_value) + return field_value + + def set_data_value(self, data_type, member_detail, field_value): + if data_type == Constants.LIST_NAMESPACE: + return self.set_json_array(field_value, member_detail) + elif data_type == Constants.MAP_NAMESPACE: + return self.set_json_object(field_value, member_detail) + elif data_type == Constants.CHOICE_NAMESPACE or \ + (Constants.STRUCTURE_NAME in member_detail and + member_detail[Constants.STRUCTURE_NAME] == Constants.CHOICE_NAMESPACE): + return field_value.get_value() + elif Constants.STRUCTURE_NAME in member_detail and Constants.MODULE in member_detail: + return self.is_record_request( + field_value, self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), None, member_detail) + elif Constants.STRUCTURE_NAME in member_detail: + return self.form_request(field_value, member_detail[Constants.STRUCTURE_NAME], None, member_detail) + else: + return DataTypeConverter.post_convert(field_value, data_type) + + def set_json_object(self, field_value, member_detail): + json_object = {} + request_object = dict(field_value) + + if len(request_object) > 0: + if member_detail is None or (member_detail is not None and Constants.KEYS not in member_detail): + for key, value in request_object.items(): + json_object[key] = self.redirector_for_object_to_json(value) + + else: + if Constants.KEYS in member_detail: + keys_detail = member_detail[Constants.KEYS] + + for key_detail in keys_detail: + key_name = key_detail[Constants.NAME] + + if key_name in request_object and request_object[key_name] is not None: + key_value = self.set_data(key_detail, request_object[key_name]) + json_object[key_name] = key_value + + return json_object + + def set_json_array(self, field_value, member_detail): + json_array = [] + request_objects = list(field_value) + + if len(request_objects) > 0: + if member_detail is None or (member_detail is not None and Constants.STRUCTURE_NAME not in member_detail): + if member_detail is not None and Constants.SUB_TYPE in member_detail: + sub_type = member_detail[Constants.SUB_TYPE] + data_type = sub_type[Constants.TYPE] + if data_type == Constants.CHOICE_NAMESPACE: + for request in request_objects: + json_array.append(request.get_value()) + else: + for request in request_objects: + json_array.append(self.set_data_value(data_type, member_detail, request)) + else: + for request in request_objects: + json_array.append(self.redirector_for_object_to_json(request)) + else: + pack = member_detail[Constants.STRUCTURE_NAME] + + if pack == Constants.CHOICE_NAMESPACE: + for request in request_objects: + json_array.append(request.get_value()) + + elif Constants.MODULE in member_detail and member_detail[Constants.MODULE] is not None: + instance_count = 0 + for request in request_objects: + json_array.append( + self.is_record_request(request, + self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), instance_count, member_detail)) + instance_count += 1 + + else: + instance_count = 0 + for request in request_objects: + json_array.append(self.form_request(request, pack, instance_count, member_detail)) + instance_count += 1 + + return json_array + + def redirector_for_object_to_json(self, request): + if isinstance(request, list): + return self.set_json_array(request, None) + + elif isinstance(request, dict): + return self.set_json_object(request, None) + + elif isinstance(request, Choice): + return request.get_value() + + else: + return request + + def get_wrapped_response(self, response, pack): + try: + return self.get_response(response.json(), pack) + + except ValueError: + return None + + def get_response(self, response, package_name): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + if response is None or response == '' or response == "None" or response == "null": + return None + if isinstance(response, str) or isinstance(response, int) or isinstance(response, float) or isinstance(response, bool): + response_json = response + else: + response_json = dict(response) + + path_split = str(package_name).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + package_name = path_split[0] + "." + class_name + class_detail = dict(Initializer.json_details[str(package_name)]) + instance = None + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + classes = class_detail[Constants.CLASSES] + instance = self.find_match(classes, response_json) + else: + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, class_name) + instance = class_holder() + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if isinstance(instance, Record): + module_api_name = self.common_api_handler.get_module_api_name() + instance = self.is_record_response(response_json, class_detail, package_name) + self.common_api_handler.set_module_api_name(module_api_name) + + else: + instance = self.not_record_response(instance=instance, class_name=class_name, + response_json=response_json, class_detail=class_detail) + + return instance + + def not_record_response(self, instance, class_name, response_json, class_detail): + for member_name, key_detail in class_detail.items(): + key_name = key_detail[Constants.NAME] if Constants.NAME in key_detail else None + + if key_name is not None and key_name in response_json and response_json.get(key_name) is not None: + key_data = response_json[key_name] + member_value = self.get_data(key_data, key_detail) + setattr(instance, self.construct_private_member(class_name=class_name, member_name=member_name), + member_value) + + return instance + + def is_record_response(self, response_json, class_detail, pack): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + response_json = dict(response_json) + record_instance = JSONConverter.__get_instance_from_name(pack) + module_api_name = self.common_api_handler.get_module_api_name() + + module_detail = {} + class_name = Constants.RECORD_NAMESPACE.rpartition('.')[-1] + + if module_api_name is not None: + self.common_api_handler.set_module_api_name(None) + module_detail = self.__get_module_detail_from_user_spec_json(module_api_name) + + for key, value in class_detail.items(): + if module_detail is None: + module_detail = {} + module_detail[key] = value + + record_detail = Initializer.json_details[Constants.RECORD_NAMESPACE] + + class_list = record_instance.__class__.mro() + + for each_class in class_list: + if Constants.RECORD_TYPE in str(each_class): + class_name = Constants.RECORD_CLASS_NAME + break + + key_values = {} + + for key_name in response_json.keys(): + member_name = self.build_name(key_name) + key_detail = {} + + if len(module_detail) > 0 and (key_name in module_detail or member_name in module_detail): + key_detail = module_detail[key_name] if key_name in module_detail.keys() else module_detail[member_name] + + elif member_name in record_detail: + key_detail = record_detail[member_name] + + key_data = response_json[key_name] + key_value = None + + if key_detail is not None and len(key_detail) > 0: + key_name = key_detail[Constants.NAME] + key_value = self.get_data(key_data, key_detail) + + else: + key_value = self.redirector_for_json_to_object(key_data) + + key_values[key_name] = key_value + + setattr(record_instance, self.construct_private_member(class_name, Constants.KEY_VALUES), key_values) + + return record_instance + + def get_data(self, key_data, member_detail): + member_value = None + if key_data is not None: + data_type = member_detail.get(Constants.TYPE) + return self.get_data_value(data_type, key_data, member_detail) + return member_value + + def get_data_value(self, data_type, key_data, member_detail): + member_value = None + if data_type == Constants.LIST_NAMESPACE: + member_value = self.get_collections_data(key_data, member_detail) + elif data_type == Constants.MAP_NAMESPACE: + member_value = self.get_map_data(key_data, member_detail) + elif data_type == Constants.CHOICE_NAMESPACE or ( + Constants.STRUCTURE_NAME in member_detail and member_detail[ + Constants.STRUCTURE_NAME] == Constants.CHOICE_NAMESPACE): + member_value = self.__get_choice_instance(key_data) + elif Constants.STRUCTURE_NAME in member_detail and Constants.MODULE in member_detail: + member_value = self.is_record_response(key_data, self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), member_detail[Constants.STRUCTURE_NAME]) + elif Constants.STRUCTURE_NAME in member_detail: + member_value = self.get_response(key_data, member_detail[Constants.STRUCTURE_NAME]) + else: + member_value = DataTypeConverter.pre_convert(key_data, data_type) + return member_value + + def get_map_data(self, response, member_detail): + map_instance = {} + + if len(response) > 0: + if member_detail is None or (member_detail is not None and Constants.KEYS not in member_detail): + for key, value in response.items(): + map_instance[key] = self.redirector_for_json_to_object(value) + + else: + if Constants.KEYS in member_detail: + keys_detail = member_detail[Constants.KEYS] + + for key_detail in keys_detail: + key_name = key_detail[Constants.NAME] + if key_name in response and response[key_name] is not None: + key_value = self.get_data(response[key_name], key_detail) + map_instance[key_name] = key_value + + return map_instance + + def get_collections_data(self, responses, member_detail): + values = [] + if len(responses) > 0: + if member_detail is None or (member_detail is not None and Constants.STRUCTURE_NAME not in member_detail): + if member_detail is not None and Constants.SUB_TYPE not in member_detail: + sub_type = member_detail[Constants.SUB_TYPE] + type = sub_type[Constants.TYPE] + if type == Constants.CHOICE_NAMESPACE: + for response in responses: + values.append(self.__get_choice_instance(response)) + else: + for response in responses: + values.append(self.get_data_value(type, response, member_detail)) + else: + for response in responses: + values.append(self.redirector_for_json_to_object(response)) + else: + pack = member_detail[Constants.STRUCTURE_NAME] + if pack == Constants.CHOICE_NAMESPACE: + for response in responses: + values.append(self.__get_choice_instance(response)) + + elif Constants.MODULE in member_detail and member_detail[Constants.MODULE] is not None: + for response in responses: + values.append(self.is_record_response(response, self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), pack)) + + else: + for response in responses: + values.append(self.get_response(response, pack)) + + return values + + def __get_module_detail_from_user_spec_json(self, module): + try: + import os + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + import os + from ..initializer import Initializer + + record_field_details_path = os.path.join(Initializer.get_initializer().resource_path, + Constants.FIELD_DETAILS_DIRECTORY, Converter.get_encoded_file_name()) + + record_field_details = Initializer.get_json(record_field_details_path) + module_detail = Utility.get_json_object(record_field_details, module) + if module_detail is not None and len(module_detail) == 0: + with open(record_field_details_path, mode="w") as file: + del record_field_details[module.lower()] + json.dump(record_field_details, file) + file.flush() + file.close() + + return module_detail + + def redirector_for_json_to_object(self, key_data): + if isinstance(key_data, dict): + return self.get_map_data(key_data, None) + + elif isinstance(key_data, list): + return self.get_collections_data(key_data, None) + + elif key_data is None: + return None + + else: + return key_data + + def find_match(self, classes, response_json): + pack = "" + ratio = 0 + + for class_name in classes: + match_ratio = self.find_ratio(class_name, response_json) + + if match_ratio == 1.0: + pack = class_name + ratio = 1 + break + + elif match_ratio > ratio: + ratio = match_ratio + pack = class_name + + return self.get_response(response_json, pack) + + def find_ratio(self, class_name, response_json): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + class_detail = dict(Initializer.json_details[str(class_name)]) + total_points = len(class_detail.keys()) + matches = 0 + + if total_points == 0: + return + + else: + for member_name in class_detail: + member_detail = class_detail[member_name] + key_name = member_detail[Constants.NAME] if Constants.NAME in member_detail else None + if key_name is not None and key_name in response_json and response_json.get(key_name) is not None: + key_data = response_json[key_name] + data_type = type(key_data).__name__ + structure_name = member_detail[ + Constants.STRUCTURE_NAME] if Constants.STRUCTURE_NAME in member_detail else None + + if isinstance(key_data, dict): + data_type = Constants.MAP_NAMESPACE + + if isinstance(key_data, list): + data_type = Constants.LIST_NAMESPACE + + if data_type == member_detail[Constants.TYPE] or ( + member_detail[Constants.TYPE] in Constants.DATA_TYPE and + isinstance(key_data, Constants.DATA_TYPE.get(member_detail[Constants.TYPE]))): + + matches += 1 + elif key_name.lower() == Constants.COUNT.lower() and \ + member_detail[Constants.TYPE].lower() == Constants.LONG_NAMESPACE.lower(): + matches += 1 + elif member_detail[Constants.TYPE] == Constants.CHOICE_NAMESPACE: + values = list(member_detail[Constants.VALUES]) + for value in values: + if value == key_data: + matches += 1 + break + + if structure_name is not None and structure_name == member_detail[Constants.TYPE]: + if Constants.VALUES in member_detail: + for value in member_detail[Constants.VALUES]: + if value == key_data: + matches += 1 + break + else: + matches += 1 + + return matches / total_points + + def build_name(self, key_name): + name_split = str(key_name).split('_') + sdk_name = name_split[0].lower() + + if len(name_split) > 1: + for i in range(1, len(name_split)): + if len(name_split[i]) > 0: + sdk_name += '_' + name_split[i].lower() + + return sdk_name + + @staticmethod + def __get_instance_from_name(class_path): + path_split = str(class_path).rpartition('.') + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, path_split[-1]) + + return class_holder() + + def construct_private_member(self, class_name, member_name): + return '_' + class_name + '__' + member_name + + def __get_choice_instance(self, data): + choice_split = Constants.CHOICE_NAMESPACE.rpartition('.') + imported_module = importlib.import_module(choice_split[0]) + class_holder = getattr(imported_module, choice_split[-1]) + choice_instance = class_holder(data) + + return choice_instance diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py new file mode 100644 index 0000000..c99ed96 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py @@ -0,0 +1,156 @@ +try: + import threading + import os + import json + import logging + import shutil + from zohocrmsdk.src.com.zoho.crm.api.util import Constants, Converter, Utility + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + +except Exception: + import threading + import os + import json + import logging + import shutil + from .constants import Constants + from .converter import Converter + from .utility import Utility + from ..initializer import Initializer + from ..exception import SDKException + + +class ModuleFieldsHandler(object): + logger = logging.getLogger('SDKLogger') + lock = threading.Lock() + + @staticmethod + def __get_directory(): + + """ + The method to obtain resources directory path. + + Returns: + str: A String representing the directory's absolute path. + """ + return os.path.join(Initializer.get_initializer().resource_path, Constants.FIELD_DETAILS_DIRECTORY) + + @staticmethod + def delete_fields_file(): + """ + The method to delete fields JSON File of the current user. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + record_field_details_path = os.path.join(ModuleFieldsHandler.__get_directory(), Converter.get_encoded_file_name()) + if os.path.exists(record_field_details_path): + os.remove(record_field_details_path) + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.DELETE_FIELD_FILE_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def delete_all_field_files(): + """ + The method to delete all the field JSON files under resources directory. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + record_field_details_directory = ModuleFieldsHandler.__get_directory() + if os.path.exists(record_field_details_directory): + files_list = [os.path.join(record_field_details_directory, file) for file in os.listdir(record_field_details_directory) if os.path.isfile(os.path.join(record_field_details_directory, file))] + for each_file in files_list: + if Constants.JSON_FILE_EXTENSION in each_file: + os.remove(each_file) + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.DELETE_FIELD_FILES_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def delete_fields(module): + """ + The method to delete fields of the given module from the current user's fields JSON file. + + Parameters: + module(str): A string representing the module. + + Raises: + SDKException + """ + + try: + if module is None: + raise Exception("module should not be None") + + record_field_details_path = os.path.join(ModuleFieldsHandler.__get_directory(), Converter.get_encoded_file_name()) + if os.path.exists(record_field_details_path): + record_field_details_json = Initializer.get_json(record_field_details_path) + if module.lower() in record_field_details_json: + Utility.delete_fields(record_field_details_json, module) + with open(record_field_details_path, mode="w") as file: + json.dump(record_field_details_json, file) + file.flush() + file.close() + + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.DELETE_MODULE_FROM_FIELDFILE_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def refresh_fields(module): + """ + The method to force-refresh fields of a module. + + Parameters: + module(str): A string representing the module. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + if module is None: + raise Exception("module should not be None") + + ModuleFieldsHandler.delete_fields(module) + Utility.get_fields_info(module) + except SDKException as ex: + ModuleFieldsHandler.logger.info(Constants.REFRESH_SINGLE_MODULE_FIELDS_ERROR + module + ex.__str__()) + raise ex + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.REFRESH_SINGLE_MODULE_FIELDS_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def refresh_all_modules(): + """ + The method to force-refresh fields of all the available modules. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + Utility.refresh_modules() + except SDKException as ex: + ModuleFieldsHandler.logger.info(Constants.REFRESH_ALL_MODULE_FIELDS_ERROR + ex.__str__()) + raise ex + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.REFRESH_ALL_MODULE_FIELDS_ERROR + sdk_exception.__str__()) + raise sdk_exception diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/stream_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/stream_wrapper.py new file mode 100755 index 0000000..455a109 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/stream_wrapper.py @@ -0,0 +1,59 @@ +try: + import os + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + import os + from ..exception import SDKException + from .constants import Constants + + +class StreamWrapper(object): + + """ + This class handles the file stream and name. + """ + + def __init__(self, name=None, stream=None, file_path=None): + + """ + Creates a StreamWrapper class instance with the specified parameters. + + Parameters: + name (str) : A string containing the file name. + stream (stream) : A stream containing the file stream. + file_path (str) : A string containing the absolute file path. + """ + + if file_path is not None: + if not os.path.exists(file_path): + raise SDKException(Constants.FILE_ERROR, Constants.FILE_DOES_NOT_EXISTS) + + self.__name = os.path.basename(file_path) + self.__stream = open(file_path, 'rb') + + else: + self.__name = name + self.__stream = stream + + def get_name(self): + + """ + This is a getter method to get the file name. + + Returns: + string : A string representing the file name. + """ + + return self.__name + + def get_stream(self): + + """ + This is a getter method to get the file input stream. + + Returns: + stream : A stream representing the file stream. + """ + + return self.__stream diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/utility.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/utility.py new file mode 100644 index 0000000..6185dc1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/utility.py @@ -0,0 +1,1011 @@ +try: + import logging + import threading + import datetime + import time + import os + import json + import zlib + import base64 + import re + from zohocrmsdk.src.com.zoho.crm.api.util import Constants, Choice + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.header_map import HeaderMap + from zohocrmsdk.src.com.zoho.crm.api.parameter_map import ParameterMap + from zohocrmsdk.src.com.zoho.crm.api.header import Header + +except Exception: + import logging + import threading + import os + import json + import time + import datetime + import zlib + import base64 + import re + from .constants import Constants + from ..initializer import Initializer + from ..exception import SDKException + from ..header_map import HeaderMap + from ..parameter_map import ParameterMap + from ..header import Header + + +class Utility(object): + """ + This class handles module field details. + """ + + apitype_vs_datatype = {} + apitype_vs_structurename = {} + new_file = False + get_modified_modules = False + force_refresh = False + module_api_name = None + api_supported_modules = {} + lock = threading.RLock() + logger = logging.getLogger('SDKLogger') + + @staticmethod + def file_exists_flow(module_api_name, record_field_details_path, last_modified_time): + with Utility.lock: + record_field_details_json = Initializer.get_json(record_field_details_path) + + initializer = Initializer.get_initializer() + + if initializer.sdk_config.get_auto_refresh_fields() and not Utility.new_file and not Utility.get_modified_modules and ( + Constants.FIELDS_LAST_MODIFIED_TIME not in record_field_details_json or Utility.force_refresh or ( + time.time() * 1000 - record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME]) > 3600000): + Utility.get_modified_modules = True + last_modified_time = record_field_details_json[ + Constants.FIELDS_LAST_MODIFIED_TIME] if not Utility.force_refresh and Constants.FIELDS_LAST_MODIFIED_TIME in record_field_details_json else None + Utility.modify_fields(record_field_details_path, last_modified_time) + Utility.get_modified_modules = False + + elif not Initializer.get_initializer().sdk_config.get_auto_refresh_fields() and Utility.force_refresh and not Utility.get_modified_modules: + Utility.get_modified_modules = True + Utility.modify_fields(record_field_details_path, last_modified_time) + Utility.get_modified_modules = False + + record_field_details_json = Initializer.get_json(record_field_details_path) + + if module_api_name is None or ( + module_api_name.lower() in record_field_details_json and record_field_details_json[ + module_api_name.lower()] is not None): + return + + else: + Utility.fill_data_type() + record_field_details_json[module_api_name.lower()] = {} + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + field_details = Utility.get_fields_details(module_api_name) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[module_api_name.lower()] = field_details + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + @staticmethod + def verify_module_api_name(module_api_name): + if module_api_name is not None and module_api_name.lower() in Constants.DEFAULT_MODULE_NAME_VS_API_NAME and Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get( + module_api_name.lower()) is not None: + return Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get(module_api_name.lower()) + + record_field_details_path = Utility.get_file_name() + if os.path.exists(record_field_details_path) and module_api_name is not None: + fields_json = Initializer.get_json(record_field_details_path) + if Constants.SDK_MODULE_METADATA in fields_json and module_api_name.lower() in fields_json[ + Constants.SDK_MODULE_METADATA]: + return fields_json[Constants.SDK_MODULE_METADATA][module_api_name.lower()][Constants.API_NAME] + + return module_api_name + + @staticmethod + def set_handler_api_path(module_api_name, handler_instance): + if handler_instance is None: + return + + api_path = handler_instance.get_api_path() + + if module_api_name.lower() in api_path.lower(): + api_path_split = api_path.split("/") + + for i in range(len(api_path_split)): + split_lower = api_path_split[i].lower() + if split_lower == module_api_name.lower(): + api_path_split[i] = module_api_name + elif split_lower in Constants.DEFAULT_MODULE_NAME_VS_API_NAME and \ + Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get(split_lower) is not None: + api_path_split[i] = Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get(split_lower) + + api_path = "/".join(api_path_split) + handler_instance.set_api_path(api_path) + + @staticmethod + def get_fields(module_api_name, handler_instance=None): + with Utility.lock: + if "," in module_api_name: + name_split = str(module_api_name).split(',') + if len(name_split) > 1: + for name in name_split: + Utility.module_api_name = name + Utility.get_fields_info(name, handler_instance) + else: + Utility.module_api_name = module_api_name + Utility.get_fields_info(module_api_name, handler_instance) + + @staticmethod + def get_fields_info(module_api_name, handler_instance=None): + + """ + This method to fetch field details of the current module for the current user and store the result in a JSON file. + + Parameters: + module_api_name (str) : A string containing the CRM module API name. + handler_instance (CommonAPIHandler) : A CommonAPIHandler instance. + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + last_modified_time = None + + record_field_details_path = None + + try: + with Utility.lock: + initializer = Initializer.get_initializer() + + resources_path = os.path.join(initializer.resource_path, + Constants.FIELD_DETAILS_DIRECTORY) + + if not os.path.exists(resources_path): + os.makedirs(resources_path) + if module_api_name is not None: + module_api_name = Utility.verify_module_api_name(module_api_name) + + Utility.set_handler_api_path(module_api_name, handler_instance) + + if handler_instance is not None and handler_instance.get_module_api_name() is None and module_api_name.lower() not in Constants.SKIP_MODULES: + return + + record_field_details_path = Utility.get_file_name() + + if os.path.exists(record_field_details_path): + Utility.file_exists_flow(module_api_name, record_field_details_path, last_modified_time) + elif initializer.sdk_config.get_auto_refresh_fields(): + Utility.new_file = True + Utility.fill_data_type() + if len(Utility.api_supported_modules) == 0: + Utility.api_supported_modules = Utility.get_modules(None) + record_field_details_json = Initializer.get_json(record_field_details_path) if os.path.exists( + record_field_details_path) else {} + + record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] = time.time() * 1000 + + if len(Utility.api_supported_modules) > 0: + for module in Utility.api_supported_modules: + if module.lower() not in record_field_details_json: + module_data = Utility.api_supported_modules[module] + record_field_details_json[module.lower()] = {} + Utility.write_to_file(file_path=record_field_details_path, + file_contents=record_field_details_json) + field_details = Utility.get_fields_details(module_data[Constants.API_NAME]) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[module.lower()] = field_details + Utility.write_to_file(file_path=record_field_details_path, + file_contents=record_field_details_json) + + Utility.new_file = False + + elif Utility.force_refresh and not Utility.get_modified_modules: + Utility.get_modified_modules = True + record_field_details_json = {} + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + Utility.modify_fields(record_field_details_path, last_modified_time) + Utility.get_modified_modules = False + + else: + Utility.fill_data_type() + record_field_details_json = {module_api_name.lower(): {}} + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + field_details = Utility.get_fields_details(module_api_name) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[module_api_name.lower()] = field_details + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + except Exception as e: + if record_field_details_path is not None and os.path.exists(record_field_details_path): + try: + record_field_details_json = Initializer.get_json(record_field_details_path) + if module_api_name is not None and module_api_name.lower() in record_field_details_json: + del record_field_details_json[module_api_name.lower()] + + if Utility.new_file: + if Constants.FIELDS_LAST_MODIFIED_TIME in record_field_details_json: + del record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] + Utility.new_file = False + + if Utility.get_modified_modules or Utility.force_refresh: + Utility.get_modified_modules = False + Utility.force_refresh = False + + if last_modified_time is not None: + record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] = last_modified_time + + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + except Exception as ex: + sdk_exception = SDKException(cause=ex) + Utility.logger.error(Constants.EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + if not isinstance(e, SDKException): + e = SDKException(cause=e) + Utility.logger.info(Constants.EXCEPTION + e.__str__()) + + raise e + + @staticmethod + def modify_fields(record_field_details_path, modified_time): + modified_modules = Utility.get_modules(modified_time) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] = time.time() * 1000 + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + if len(modified_modules) > 0: + for module in modified_modules.keys(): + if module.lower() in record_field_details_json: + Utility.delete_fields(record_field_details_json, module) + + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + for module in modified_modules.keys(): + module_data = modified_modules[module] + Utility.get_fields_info(module_data[Constants.API_NAME]) + + @staticmethod + def delete_fields(record_field_details_json, module): + subform_modules = [] + fields_json = record_field_details_json[module.lower()] + for key, value in fields_json.items(): + if Constants.SUBFORM in value and value[Constants.SUBFORM] and ( + value[Constants.MODULE]).lower() in record_field_details_json: + subform_modules.append(value[Constants.MODULE]) + + del record_field_details_json[module.lower()] + + if len(subform_modules) > 0: + for subform_module in subform_modules: + Utility.delete_fields(record_field_details_json, subform_module) + + @staticmethod + def get_file_name(): + from zohocrmsdk.src.com.zoho.crm.api.util.converter import Converter + + return os.path.join(Initializer.get_initializer().resource_path, Constants.FIELD_DETAILS_DIRECTORY, + Converter.get_encoded_file_name()) + + @staticmethod + def get_related_lists(related_module_name, module_api_name, common_api_handler): + with Utility.lock: + try: + is_new_data = False + key = (module_api_name + Constants.UNDERSCORE + Constants.RELATED_LISTS).lower() + resources_path = os.path.join(Initializer.get_initializer().resource_path, + Constants.FIELD_DETAILS_DIRECTORY) + + if not os.path.exists(resources_path): + os.makedirs(resources_path) + record_field_details_path = Utility.get_file_name() + + if not os.path.exists(record_field_details_path) or ( + os.path.exists(record_field_details_path) and ( + key not in Initializer.get_json(record_field_details_path) or ( + Initializer.get_json(record_field_details_path)[key] is None or len( + Initializer.get_json(record_field_details_path)[key]) <= 0))): + is_new_data = True + module_api_name = Utility.verify_module_api_name(module_api_name) + related_list_values = Utility.get_related_list_details(module_api_name) + record_field_details_json = Initializer.get_json(record_field_details_path) if os.path.exists( + record_field_details_path) else {} + record_field_details_json[key] = related_list_values + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + record_field_details_json = Initializer.get_json(record_field_details_path) + module_related_list = record_field_details_json[key] if key in record_field_details_json else {} + + if not Utility.check_related_list_exists(related_module_name, module_related_list, + common_api_handler) and not is_new_data: + del record_field_details_json[key] + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + Utility.get_related_lists(related_module_name, module_api_name, common_api_handler) + + except SDKException as e: + Utility.logger.error(Constants.EXCEPTION + e.__str__()) + raise e + + except Exception as e: + sdk_exception = SDKException(cause=e) + Utility.logger.error(Constants.EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def check_related_list_exists(related_module_name, module_related_list_array, common_api_handler): + for related_list_jo in module_related_list_array: + if related_list_jo[Constants.API_NAME] is not None and related_list_jo[ + Constants.API_NAME].lower() == related_module_name.lower(): + if related_list_jo[Constants.HREF] == Constants.NULL_VALUE: + raise SDKException(code=Constants.UNSUPPORTED_IN_API, + message=common_api_handler.get_http_method() + ' ' + common_api_handler.get_api_path() + Constants.UNSUPPORTED_IN_API_MESSAGE) + + if related_list_jo[Constants.MODULE] != Constants.NULL_VALUE: + common_api_handler.set_module_api_name(related_list_jo[Constants.MODULE]) + Utility.get_fields_info(related_list_jo[Constants.MODULE], common_api_handler) + return True + + return False + + @staticmethod + def get_related_list_details(module_api_name): + + param_instance = ParameterMap() + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists import GetRelatedListsParam + except: + from ..related_lists import GetRelatedListsParam + param_instance.add(GetRelatedListsParam.module, module_api_name) + + import zohocrmsdk.src.com.zoho.crm.api.related_lists as RelatedLists + + related_list_array = [] + + response = RelatedLists.RelatedListsOperations(None).get_related_lists(param_instance) + + if response is not None: + if response.get_status_code() == Constants.NO_CONTENT_STATUS_CODE: + return related_list_array + + data_object = response.get_object() + + if data_object is not None: + if isinstance(data_object, RelatedLists.ResponseWrapper): + related_lists = data_object.get_related_lists() + + for related_list in related_lists: + related_list_detail = { + Constants.API_NAME: related_list.get_api_name(), + Constants.MODULE: related_list.get_module().get_api_name() if related_list.get_module() is not None else Constants.NULL_VALUE, + Constants.NAME: related_list.get_name(), + Constants.HREF: related_list.get_href() if related_list.get_href() is not None else Constants.NULL_VALUE + } + related_list_array.append(related_list_detail) + + elif isinstance(data_object, RelatedLists.APIException): + error_response = { + Constants.CODE: data_object.get_code().get_value(), + Constants.STATUS: data_object.get_status().get_value(), + Constants.MESSAGE: data_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + else: + error_response = { + Constants.CODE: response.get_status_code() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + else: + error_response = { + Constants.CODE: response.get_status_code() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + return related_list_array + + @staticmethod + def get_fields_details(module_api_name): + + """ + This method to get module field data from Zoho CRM. + :param module_api_name: A str containing the CRM module API name. + :return: A object representing the Zoho CRM module field details. + """ + import zohocrmsdk.src.com.zoho.crm.api.fields as Field + + fields_details = {} + + param_instance = ParameterMap() + + param_instance.add(Field.GetFieldsParam.module, module_api_name) + + response = Field.FieldsOperations().get_fields(param_instance) + + if response is not None: + if response.get_status_code() == Constants.NO_CONTENT_STATUS_CODE: + return fields_details + + response_object = response.get_object() + + if isinstance(response_object, Field.ResponseWrapper): + fields = response_object.get_fields() + + for field in fields: + if field.get_api_name() in Constants.KEYS_TO_SKIP: + continue + + field_detail = {} + + Utility.set_data_type(field_detail, field, module_api_name) + + fields_details[field.get_api_name()] = field_detail + + if module_api_name.lower() in Constants.INVENTORY_MODULES: + field_detail = { + Constants.NAME: Constants.LINE_TAX, + Constants.TYPE: Constants.LIST_NAMESPACE, + Constants.STRUCTURE_NAME: Constants.LINE_TAX_NAMESPACE + } + fields_details[Constants.LINE_TAX] = field_detail + + if module_api_name.lower() == Constants.NOTES: + field_detail = { + Constants.NAME: Constants.ATTACHMENTS, + Constants.TYPE: Constants.LIST_NAMESPACE, + Constants.STRUCTURE_NAME: Constants.ATTACHMENTS_NAMESPACE + } + fields_details[Constants.ATTACHMENTS] = field_detail + + elif isinstance(response_object, Field.APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + + exception = SDKException(code=Constants.API_EXCEPTION, details=error_response) + + if Utility.module_api_name is not None and Utility.module_api_name.lower() == module_api_name.lower(): + raise + Utility.logger.info(Constants.API_EXCEPTION + exception.__str__()) + + else: + error_response = { + Constants.CODE: response.get_status_code() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + return fields_details + + @staticmethod + def verify_photo_support(module_api_name): + with Utility.lock: + try: + module_api_name = Utility.verify_module_api_name(module_api_name) + if module_api_name.lower() in Constants.PHOTO_SUPPORTED_MODULES: + return True + + modules = Utility.get_module_names() + if module_api_name.lower() in modules and modules[module_api_name.lower()] is not None: + module_meta_data = modules[module_api_name.lower()] + + if Constants.GENERATED_TYPE in module_meta_data and module_meta_data[ + Constants.GENERATED_TYPE] != Constants.GENERATED_TYPE_CUSTOM: + raise SDKException(code=Constants.UPLOAD_PHOTO_UNSUPPORTED_ERROR, + message=Constants.UPLOAD_PHOTO_UNSUPPORTED_MESSAGE + module_api_name) + except SDKException as e: + raise e + + except Exception as e: + sdk_exception = SDKException(message=Constants.EXCEPTION, cause=e) + raise sdk_exception + + return True + + @staticmethod + def get_module_names(): + module_data = {} + resources_path = os.path.join(Initializer.get_initializer().resource_path, + Constants.FIELD_DETAILS_DIRECTORY) + if not os.path.exists(resources_path): + os.makedirs(resources_path) + + record_field_details_path = Utility.get_file_name() + + is_null = False + if os.path.exists(record_field_details_path): + json = Initializer.get_json(record_field_details_path) + if Constants.SDK_MODULE_METADATA not in json: + is_null = True + elif json[Constants.SDK_MODULE_METADATA] is None or len(json[Constants.SDK_MODULE_METADATA]) == 0: + is_null = True + + if not os.path.exists(record_field_details_path) or is_null: + module_data = Utility.get_modules(None) + Utility.write_module_meta_data(record_field_details_path, module_data) + return module_data + + record_field_details_json = Initializer.get_json(record_field_details_path) + module_data = record_field_details_json[Constants.SDK_MODULE_METADATA] + return module_data + + @staticmethod + def write_module_meta_data(record_field_details_path, module_data): + field_details_json = Initializer.get_json(record_field_details_path) if os.path.exists( + record_field_details_path) else {} + field_details_json[Constants.SDK_MODULE_METADATA] = module_data + Utility.write_to_file(record_field_details_path, field_details_json) + + @staticmethod + def get_modules(header): + import zohocrmsdk.src.com.zoho.crm.api.modules as Modules + + api_names = {} + header_map = HeaderMap() + if header is not None: + header_value = datetime.datetime.fromtimestamp(header / 1000.0) + header_map.add(Modules.GetModulesHeader.if_modified_since, header_value) + + response = Modules.ModulesOperations().get_modules(header_map) + + if response is not None: + if response.get_status_code() in [Constants.NO_CONTENT_STATUS_CODE, Constants.NOT_MODIFIED_STATUS_CODE]: + return api_names + + response_object = response.get_object() + + if isinstance(response_object, Modules.ResponseWrapper): + modules = response_object.get_modules() + for module in modules: + if module.get_api_supported(): + module_details = dict() + module_details[Constants.API_NAME] = module.get_api_name() + module_details[Constants.GENERATED_TYPE] = module.get_generated_type().get_value() + api_names[module.get_api_name().lower()] = module_details + + elif isinstance(response_object, Modules.APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + if header is None: + try: + Utility.write_module_meta_data(Utility.get_file_name(), api_names) + except Exception as e: + + raise SDKException(message=Constants.EXCEPTION, cause=e) + + return api_names + + @staticmethod + def refresh_modules(): + Utility.force_refresh = True + Utility.get_fields_info(None) + Utility.force_refresh = False + + @staticmethod + def get_json_object(json, key): + for key_in_json in json.keys(): + if key_in_json.lower() == key.lower(): + return json[key_in_json] + + return None + + @staticmethod + def set_data_type(field_detail, field, module_api_name): + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except: + from ..modules.minified_module import MinifiedModule + + api_type = field.get_data_type() + module = MinifiedModule() + key_name = field.get_api_name() + + if field.get_system_mandatory() is not None and field.get_system_mandatory() and not ( + module_api_name.lower() == Constants.CALLS and key_name.lower() == Constants.CALL_DURATION): + field_detail[Constants.REQUIRED] = True + + if key_name.lower() == Constants.PRICING_DETAILS.lower() and module_api_name.lower() == Constants.PRICE_BOOKS: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.PRICING_DETAILS_NAMESPACE + field_detail[Constants.SKIP_MANDATORY] = True + + return + + elif key_name.lower() == Constants.PARTICIPANT_API_NAME.lower() and ( + module_api_name.lower() == Constants.EVENTS or module_api_name.lower() == Constants.ACTIVITIES): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.PARTICIPANTS + field_detail[Constants.SKIP_MANDATORY] = True + + return + + elif key_name.lower() == Constants.COMMENTS.lower() and \ + (module_api_name.lower() == Constants.SOLUTIONS or module_api_name.lower() == Constants.CASES): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.COMMENT_NAMESPACE + field_detail[Constants.LOOKUP] = True + + return + + elif key_name.lower() == Constants.LAYOUT.lower(): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LAYOUT_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.LAYOUT_NAMESPACE + field_detail[Constants.LOOKUP] = True + + return + + + elif ( + key_name.lower() == Constants.TERRITORIES.lower() or key_name.lower() == Constants.TERRITORY.lower()) and field.get_custom_field() is not None and field.get_custom_field() == False: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.TERRITORY_NAMESPACE + field_detail[Constants.LOOKUP] = True + + return + + elif key_name.lower() == Constants.PRODUCT_NAME.lower() and module_api_name.lower() in Constants.INVENTORY_MODULES_ITEMS: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LINEITEM_PRODUCT + field_detail[Constants.STRUCTURE_NAME] = Constants.LINEITEM_PRODUCT + field_detail[Constants.SKIP_MANDATORY] = True + + return + elif key_name.lower() == Constants.DISCOUNT.lower() and module_api_name.lower() in Constants.INVENTORY_MODULES_ITEMS: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.STRING_NAMESPACE + + return + elif key_name.lower() == Constants.TAX.lower() and module_api_name.lower() == Constants.PRODUCTS.lower(): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.TAX_NAMESPACE + + return + elif api_type in Utility.apitype_vs_datatype: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(api_type) + + elif api_type == Constants.FORMULA.lower(): + if field.get_formula() is not None: + return_type = field.get_formula().get_return_type() + if return_type is not None and return_type in Utility.apitype_vs_datatype and Utility.apitype_vs_datatype.get( + return_type) is not None: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(return_type) + + field_detail[Constants.READ_ONLY] = True + elif api_type == Constants.ROLLUP_SUMMARY.lower(): + if field.get_rollup_summary() is not None: + return_type = field.get_rollup_summary().get_return_type() + if return_type is not None and return_type in Utility.apitype_vs_datatype and Utility.apitype_vs_datatype.get( + return_type) is not None: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(return_type) + elif field.get_json_type() is not None and field.get_json_type() in Utility.apitype_vs_datatype and Utility.apitype_vs_datatype.get( + field.get_json_type()) is not None: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(field.get_json_type()) + else: + return + + if Constants.LOOKUP in api_type.lower(): + field_detail[Constants.LOOKUP] = True + + if Constants.CONSENT_LOOKUP in api_type.lower() or Constants.OWNER_LOOKUP in api_type.lower(): + field_detail[Constants.SKIP_MANDATORY] = True + + if Constants.MULTI_SELECT_LOOKUP in api_type.lower(): + field_detail[Constants.SKIP_MANDATORY] = True + if field.get_multiselectlookup() is not None and field.get_multiselectlookup().get_linking_module() is not None: + linking_module = field.get_multiselectlookup().get_linking_module() + field_detail[Constants.MODULE] = linking_module.get_api_name() + module = linking_module + + field_detail[Constants.SUBFORM] = True + + if Constants.MULTI_USER_LOOKUP in api_type.lower(): + field_detail[Constants.SKIP_MANDATORY] = True + if field.get_multiuserlookup() is not None and field.get_multiuserlookup().get_linking_module() is not None: + linking_module = field.get_multiuserlookup().get_linking_module() + field_detail[Constants.MODULE] = linking_module.get_api_name() + module = linking_module + + field_detail[Constants.SUBFORM] = True + + if api_type in Utility.apitype_vs_structurename: + field_detail[Constants.STRUCTURE_NAME] = Utility.apitype_vs_structurename.get(api_type) + + if api_type.lower() == Constants.PICKLIST and field.get_pick_list_values() is not None and len( + field.get_pick_list_values()) > 0: + field_detail[Constants.PICKLIST] = True + values = list(map(lambda x: x.get_display_value(), field.get_pick_list_values())) + field_detail[Constants.VALUES] = values + + if api_type.lower() == Constants.SUBFORM and field.get_associated_module() is not None: + module.set_api_name(field.get_associated_module().get_module()) + field_detail[Constants.MODULE] = module.get_api_name() + field_detail[Constants.SKIP_MANDATORY] = True + field_detail[Constants.SUBFORM] = True + + if api_type == Constants.LOOKUP and field.get_lookup() is not None: + module1 = field.get_lookup().get_module() + + if module1 is not None and not module1.get_api_name() == Constants.SE_MODULE: + module.set_api_name(module1.get_api_name()) + module.set_id(module1.get_id()) + field_detail[Constants.MODULE] = module.get_api_name() + if module1.get_api_name().lower() == Constants.ACCOUNTS and not ( + field.get_custom_field() and not field.get_custom_field()): + field_detail[Constants.SKIP_MANDATORY] = True + + else: + module = MinifiedModule() + + field_detail[Constants.LOOKUP] = True + + if module is not None and module.get_api_name() is not None and len(module.get_api_name()) > 0: + Utility.get_fields_info(module.get_api_name(), None) + + field_detail[Constants.NAME] = key_name + + @staticmethod + def fill_data_type(): + if len(Utility.apitype_vs_datatype) > 0: + return + + field_api_names_string = ["textarea", "text", "website", "email", "phone", "mediumtext", + "profileimage", "autonumber"] + + field_api_names_integer = ['integer'] + + field_api_names_boolean = ['boolean'] + + field_api_names_long = ['long', 'bigint'] + + field_api_names_double = ['double', 'percent', 'lookup', 'currency'] + + field_api_names_field_file = ['fileupload'] + + field_api_names_datetime = ['datetime', 'event_reminder'] + + field_api_names_date = ['date'] + + field_api_names_lookup = ['lookup'] + + field_api_names_picklist = ['picklist'] + + field_api_names_multiselect_picklist = ['multiselectpicklist'] + + field_api_names_subform = ['subform'] + + field_api_names_owner_lookup = ['ownerlookup', 'userlookup'] + + field_api_names_multiuser_lookup = ['multiuserlookup'] + + field_api_name_task_remind_at = ['ALARM'] + + field_api_name_recurring_activity = ['RRULE'] + + field_api_name_reminder = ['multireminder'] + + field_api_name_consent_lookup = ['consent_lookup'] + + field_api_name_image_upload = ["imageupload"] + + field_api_name_multiselect_lookup = ["multiselectlookup"] + + field_api_name_line_tax = ["linetax"] + field_api_name_module = ["module"] + field_api_name_layout = ["layout"] + field_api_name_multi_module_look_up = ["multi_module_lookup"] + field_api_name_time_range = ["time_range"] + + for field_api_name in field_api_names_string: + Utility.apitype_vs_datatype[field_api_name] = Constants.STRING_NAMESPACE + + for field_api_name in field_api_names_integer: + Utility.apitype_vs_datatype[field_api_name] = Constants.INTEGER_NAMESPACE + + for field_api_name in field_api_names_boolean: + Utility.apitype_vs_datatype[field_api_name] = Constants.BOOLEAN_NAMESPACE + + for field_api_name in field_api_names_double: + Utility.apitype_vs_datatype[field_api_name] = Constants.DOUBLE_NAMESPACE + + for field_api_name in field_api_names_long: + Utility.apitype_vs_datatype[field_api_name] = Constants.INTEGER_NAMESPACE + + for field_api_name in field_api_names_datetime: + Utility.apitype_vs_datatype[field_api_name] = Constants.DATETIME_NAMESPACE + + for field_api_name in field_api_names_date: + Utility.apitype_vs_datatype[field_api_name] = Constants.DATE_NAMESPACE + + for field_api_name in field_api_names_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.RECORD_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_names_owner_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.USER_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.USER_NAMESPACE + + for field_api_name in field_api_names_multiuser_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_names_picklist: + Utility.apitype_vs_datatype[field_api_name] = Constants.CHOICE_NAMESPACE + + for field_api_name in field_api_names_multiselect_picklist: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.CHOICE_NAMESPACE + + for field_api_name in field_api_names_subform: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_names_field_file: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.FIELD_FILE_NAMESPACE + + for field_api_name in field_api_name_task_remind_at: + Utility.apitype_vs_datatype[field_api_name] = Constants.REMIND_AT_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.REMIND_AT_NAMESPACE + + for field_api_name in field_api_name_recurring_activity: + Utility.apitype_vs_datatype[field_api_name] = Constants.RECURRING_ACTIVITY_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECURRING_ACTIVITY_NAMESPACE + + for field_api_name in field_api_name_reminder: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.REMINDER_NAMESPACE + + for field_api_name in field_api_name_consent_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.CONSENT_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.CONSENT_NAMESPACE + + for field_api_name in field_api_name_image_upload: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.IMAGE_UPLOAD_NAMESPACE + + for field_api_name in field_api_name_multiselect_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_name_line_tax: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.LINE_TAX_NAMESPACE + for field_api_name in field_api_name_multi_module_look_up: + Utility.apitype_vs_datatype[field_api_name] = Constants.RECORD_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + for field_api_name in field_api_name_module: + Utility.apitype_vs_datatype[field_api_name] = Constants.MODULE_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.MODULE_NAMESPACE + for field_api_name in field_api_name_layout: + Utility.apitype_vs_datatype[field_api_name] = Constants.LAYOUT_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.LAYOUT_NAMESPACE + for field_api_name in field_api_name_time_range: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.TIME_RANGE_NAMESPACE + + @staticmethod + def check_data_type(value, data_type): + if value is None: + return False + if data_type.lower() == Constants.OBJECT.lower(): + return True + if data_type in Constants.DATA_TYPE: + data_type = Constants.DATA_TYPE.get(data_type) + class_name1 = value.__class__ + if class_name1 == data_type: + return True + else: + class_name = value.__class__.__module__ + if class_name.lower() == data_type.lower(): + return True + return False + + @staticmethod + def write_to_file(file_path, file_contents): + with open(file_path, mode="w") as file: + json.dump(file_contents, file) + file.flush() + file.close() + + @staticmethod + def get_user_name(token): + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users.response_wrapper import ResponseWrapper + from zohocrmsdk.src.com.zoho.crm.api.users.users_operations import GetUsersParam + from zohocrmsdk.src.com.zoho.crm.api.users.api_exception import APIException + from zohocrmsdk.src.com.zoho.crm.api.util import CommonAPIHandler + from zohocrmsdk.src.com.zoho.crm.api.util.choice import Choice + except Exception: + from ..users.response_handler import ResponseHandler + from ..users.response_wrapper import ResponseWrapper + from ..users.users_operations import GetUsersParam + from ..users.api_exception import APIException + from ..util.common_api_handler import CommonAPIHandler + from ..util.choice import Choice + user_name = None + param_instance = ParameterMap() + param_instance.add(GetUsersParam.type, Choice(Constants.CURRENTUSER)) + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users' + 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.set_param(param_instance) + header_instance = HeaderMap() + header_instance.add(Header(Constants.AUTHORIZATION, Constants.STRING_NAMESPACE), + Constants.OAUTH_HEADER_PREFIX + token) + handler_instance.set_header(header_instance) + response = handler_instance.api_call(ResponseHandler.__module__, 'application/json') + if response is not None: + if response.get_status_code() in [204, 304]: + return None + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + user_list = response_object.get_users() + for user in user_list: + user_name = user.get_email() + break + elif isinstance(response_object, APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + return user_name + ":" + Utility.get_user_org_id(token) + + @staticmethod + def get_user_org_id(token): + try: + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.org.response_wrapper import ResponseWrapper + from zohocrmsdk.src.com.zoho.crm.api.org.api_exception import APIException + from zohocrmsdk.src.com.zoho.crm.api.util import CommonAPIHandler + except Exception: + from ..org.response_handler import ResponseHandler + from ..org.response_wrapper import ResponseWrapper + from ..org.api_exception import APIException + from ..util import CommonAPIHandler + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org' + 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) + header_instance = HeaderMap() + header_instance.add(Header(Constants.AUTHORIZATION, Constants.STRING_NAMESPACE), + Constants.OAUTH_HEADER_PREFIX + token) + handler_instance.set_header(header_instance) + response = handler_instance.api_call(ResponseHandler.__module__, 'application/json') + if response is not None: + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + org_list = response_object.get_org() + for org in org_list: + return org.get_zgid() + elif isinstance(response_object, APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + return None diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/xml_converter.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/xml_converter.py new file mode 100755 index 0000000..51d1db0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/util/xml_converter.py @@ -0,0 +1,48 @@ +try: + from .converter import Converter + import importlib + import logging + import re + import json + +except Exception: + import importlib + from .converter import Converter + import logging + import re + import json + + +class XMLConverter(Converter): + + """ + This class processes the API response object to the POJO object and POJO object to an XML object. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + + self.unique_dict = {} + + self.count = 0 + + self.common_api_handler = common_api_handler + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + + return None + + def append_to_request(self, request_base, request_object): + + return None + + def get_wrapped_response(self, response, pack): + + return None + + def get_response(self, response, pack): + + return None diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/__init__.py new file mode 100644 index 0000000..fac839c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .minified_variable_group import MinifiedVariableGroup +from .response_wrapper import ResponseWrapper +from .variable_group import VariableGroup +from .variable_groups_operations import VariableGroupsOperations diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/api_exception.py new file mode 100644 index 0000000..ad1ca2b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/minified_variable_group.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/minified_variable_group.py new file mode 100644 index 0000000..cc56855 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/minified_variable_group.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedVariableGroup(object): + def __init__(self): + """Creates an instance of MinifiedVariableGroup""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_wrapper.py new file mode 100644 index 0000000..a73fea4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__variable_groups = None + self.__key_modified = dict() + + def get_variable_groups(self): + """ + The method to get the variable_groups + + Returns: + list: An instance of list + """ + + return self.__variable_groups + + def set_variable_groups(self, variable_groups): + """ + The method to set the value to variable_groups + + Parameters: + variable_groups (list) : An instance of list + """ + + if variable_groups is not None and not isinstance(variable_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variable_groups EXPECTED TYPE: list', None, None) + + self.__variable_groups = variable_groups + self.__key_modified['variable_groups'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_group.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_group.py new file mode 100644 index 0000000..7a4057b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_group.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class VariableGroup(object): + def __init__(self): + """Creates an instance of VariableGroup""" + + self.__display_label = None + self.__api_name = None + self.__name = None + self.__description = None + self.__id = None + self.__source = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_groups_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_groups_operations.py new file mode 100644 index 0000000..1f58352 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_groups_operations.py @@ -0,0 +1,95 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class VariableGroupsOperations(object): + def __init__(self): + """Creates an instance of VariableGroupsOperations""" + pass + + def get_variable_groups(self): + """ + The method to get variable groups + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/variable_groups' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_variable_group_by_id(self, id): + """ + The method to get variable group by id + + Parameters: + id (string) : A string representing the id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/variable_groups/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_variable_group_by_api_name(self, api_name): + """ + The method to get variable group by api name + + Parameters: + api_name (string) : A string representing the api_name + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/variable_groups/' + api_path = api_path + str(api_name) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/__init__.py new file mode 100644 index 0000000..fd94fe3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/__init__.py @@ -0,0 +1,11 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .variables_operations import VariablesOperations, GetVariablesParam, DeleteVariablesParam, GetVariableByIDParam, UpdateVariableByIDParam, UpdateVariableByAPINameParam, GetVariableByAPINameParam +from .variable import Variable +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .variable_group import VariableGroup diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_wrapper.py new file mode 100644 index 0000000..bcd5e52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__variables = None + self.__key_modified = dict() + + def get_variables(self): + """ + The method to get the variables + + Returns: + list: An instance of list + """ + + return self.__variables + + def set_variables(self, variables): + """ + The method to set the value to variables + + Parameters: + variables (list) : An instance of list + """ + + if variables is not None and not isinstance(variables, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variables EXPECTED TYPE: list', None, None) + + self.__variables = variables + self.__key_modified['variables'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/api_exception.py new file mode 100644 index 0000000..e4cca69 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/body_wrapper.py new file mode 100644 index 0000000..7c2a13f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__variables = None + self.__key_modified = dict() + + def get_variables(self): + """ + The method to get the variables + + Returns: + list: An instance of list + """ + + return self.__variables + + def set_variables(self, variables): + """ + The method to set the value to variables + + Parameters: + variables (list) : An instance of list + """ + + if variables is not None and not isinstance(variables, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variables EXPECTED TYPE: list', None, None) + + self.__variables = variables + self.__key_modified['variables'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/response_wrapper.py new file mode 100644 index 0000000..81e9e83 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__variables = None + self.__key_modified = dict() + + def get_variables(self): + """ + The method to get the variables + + Returns: + list: An instance of list + """ + + return self.__variables + + def set_variables(self, variables): + """ + The method to set the value to variables + + Parameters: + variables (list) : An instance of list + """ + + if variables is not None and not isinstance(variables, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variables EXPECTED TYPE: list', None, None) + + self.__variables = variables + self.__key_modified['variables'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/success_response.py new file mode 100644 index 0000000..33718fc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variable.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variable.py new file mode 100644 index 0000000..f06605f --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variable.py @@ -0,0 +1,276 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Variable(object): + def __init__(self): + """Creates an instance of Variable""" + + self.__api_name = None + self.__name = None + self.__description = None + self.__source = None + self.__id = None + self.__type = None + self.__variable_group = None + self.__read_only = None + self.__value = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_variable_group(self): + """ + The method to get the variable_group + + Returns: + VariableGroup: An instance of VariableGroup + """ + + return self.__variable_group + + def set_variable_group(self, variable_group): + """ + The method to set the value to variable_group + + Parameters: + variable_group (VariableGroup) : An instance of VariableGroup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.variable_group import VariableGroup + except Exception: + from .variable_group import VariableGroup + + if variable_group is not None and not isinstance(variable_group, VariableGroup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variable_group EXPECTED TYPE: VariableGroup', None, None) + + self.__variable_group = variable_group + self.__key_modified['variable_group'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variable_group.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variable_group.py new file mode 100644 index 0000000..e915aee --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variable_group.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class VariableGroup(object): + def __init__(self): + """Creates an instance of VariableGroup""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variables_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variables_operations.py new file mode 100644 index 0000000..ede6160 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/variables/variables_operations.py @@ -0,0 +1,394 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class VariablesOperations(object): + def __init__(self): + """Creates an instance of VariablesOperations""" + pass + + def get_variables(self, param_instance=None): + """ + The method to get variables + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/variables' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_variables(self, request): + """ + The method to create variables + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/variables' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_variables(self, request): + """ + The method to update variables + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/variables' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_variables(self, param_instance=None): + """ + The method to delete variables + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/variables' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_variable_by_id(self, id, param_instance=None): + """ + The method to get variable by id + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/variables/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_variable_by_id(self, id, request, param_instance=None): + """ + The method to update variable by id + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + 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/v7/settings/variables/' + api_path = api_path + str(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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_variable(self, id): + """ + The method to delete variable + + 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/v7/settings/variables/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_variable_by_apiname(self, api_name, request, param_instance=None): + """ + The method to update variable by apiname + + Parameters: + api_name (string) : A string representing the api_name + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', 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) + + 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/v7/settings/variables/' + api_path = api_path + str(api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_variable_by_apiname(self, api_name, param_instance=None): + """ + The method to get variable by apiname + + Parameters: + api_name (string) : A string representing the api_name + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + 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/v7/settings/variables/' + api_path = api_path + str(api_name) + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetVariablesParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.GetVariablesParam') + + +class DeleteVariablesParam(object): + ids = Param('ids', 'com.zoho.crm.api.Variables.DeleteVariablesParam') + + +class GetVariableByIDParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.GetVariableByIDParam') + + +class UpdateVariableByIDParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.UpdateVariableByIDParam') + + +class UpdateVariableByAPINameParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.UpdateVariableByAPINameParam') + + +class GetVariableByAPINameParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.GetVariableByAPINameParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/__init__.py new file mode 100644 index 0000000..93530f6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/__init__.py @@ -0,0 +1,28 @@ +from .acknowledge_visitor import AcknowledgeVisitor +from .button_attributes import ButtonAttributes +from .auto_response_rule import AutoResponseRule +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .webforms_operations import WebformsOperations, GetWebFormsParam, CreateWebFormsParam, UpdateWebFormsParam, GetWebFormParam, UpdateWebFormParam, DeleteWebFormsParam, GetWebformsPreviewParam +from .success_response import SuccessResponse +from .abtesting import Abtesting +from .action_handler import ActionHandler +from .from_address import FromAddress +from .owner import Owner +from .action_wrapper import ActionWrapper +from .acknowledge_visitors import AcknowledgeVisitors +from .analytics_data import AnalyticsData +from .suggestion import Suggestion +from .module import Module +from .font_attributes import FontAttributes +from .web_form import WebForm +from .body_wrapper import BodyWrapper +from .form_attributes import FormAttributes +from .tags import Tags +from .layout import Layout +from .assignment_rule import AssignmentRule +from .response_wrapper import ResponseWrapper +from .fields import Fields +from .user import User +from .spam_controll import SpamControll diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/abtesting.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/abtesting.py new file mode 100644 index 0000000..de235ae --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/abtesting.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Abtesting(object): + def __init__(self): + """Creates an instance of Abtesting""" + + self.__module = None + self.__name = None + self.__id = None + self.__status = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitor.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitor.py new file mode 100644 index 0000000..285a60b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitor.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AcknowledgeVisitor(object): + def __init__(self): + """Creates an instance of AcknowledgeVisitor""" + + self.__auto_response_rule = None + self.__template_id = None + self.__key_modified = dict() + + def get_auto_response_rule(self): + """ + The method to get the auto_response_rule + + Returns: + AutoResponseRule: An instance of AutoResponseRule + """ + + return self.__auto_response_rule + + def set_auto_response_rule(self, auto_response_rule): + """ + The method to set the value to auto_response_rule + + Parameters: + auto_response_rule (AutoResponseRule) : An instance of AutoResponseRule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.auto_response_rule import AutoResponseRule + except Exception: + from .auto_response_rule import AutoResponseRule + + if auto_response_rule is not None and not isinstance(auto_response_rule, AutoResponseRule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_response_rule EXPECTED TYPE: AutoResponseRule', None, None) + + self.__auto_response_rule = auto_response_rule + self.__key_modified['auto_response_rule'] = 1 + + def get_template_id(self): + """ + The method to get the template_id + + Returns: + int: An int representing the template_id + """ + + return self.__template_id + + def set_template_id(self, template_id): + """ + The method to set the value to template_id + + Parameters: + template_id (int) : An int representing the template_id + """ + + if template_id is not None and not isinstance(template_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template_id EXPECTED TYPE: int', None, None) + + self.__template_id = template_id + self.__key_modified['template_id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitors.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitors.py new file mode 100644 index 0000000..b52a3fa --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitors.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AcknowledgeVisitors(object): + def __init__(self): + """Creates an instance of AcknowledgeVisitors""" + + self.__template_name = None + self.__template_id = None + self.__from_address = None + self.__key_modified = dict() + + def get_template_name(self): + """ + The method to get the template_name + + Returns: + string: A string representing the template_name + """ + + return self.__template_name + + def set_template_name(self, template_name): + """ + The method to set the value to template_name + + Parameters: + template_name (string) : A string representing the template_name + """ + + if template_name is not None and not isinstance(template_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template_name EXPECTED TYPE: str', None, None) + + self.__template_name = template_name + self.__key_modified['template_name'] = 1 + + def get_template_id(self): + """ + The method to get the template_id + + Returns: + int: An int representing the template_id + """ + + return self.__template_id + + def set_template_id(self, template_id): + """ + The method to set the value to template_id + + Parameters: + template_id (int) : An int representing the template_id + """ + + if template_id is not None and not isinstance(template_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template_id EXPECTED TYPE: int', None, None) + + self.__template_id = template_id + self.__key_modified['template_id'] = 1 + + def get_from_address(self): + """ + The method to get the from_address + + Returns: + FromAddress: An instance of FromAddress + """ + + return self.__from_address + + def set_from_address(self, from_address): + """ + The method to set the value to from_address + + Parameters: + from_address (FromAddress) : An instance of FromAddress + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.from_address import FromAddress + except Exception: + from .from_address import FromAddress + + if from_address is not None and not isinstance(from_address, FromAddress): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_address EXPECTED TYPE: FromAddress', None, None) + + self.__from_address = from_address + self.__key_modified['from_address'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_wrapper.py new file mode 100644 index 0000000..9966dfc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__webforms = None + self.__key_modified = dict() + + def get_webforms(self): + """ + The method to get the webforms + + Returns: + list: An instance of list + """ + + return self.__webforms + + def set_webforms(self, webforms): + """ + The method to set the value to webforms + + Parameters: + webforms (list) : An instance of list + """ + + if webforms is not None and not isinstance(webforms, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webforms EXPECTED TYPE: list', None, None) + + self.__webforms = webforms + self.__key_modified['webforms'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/analytics_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/analytics_data.py new file mode 100644 index 0000000..c534d14 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/analytics_data.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsData(object): + def __init__(self): + """Creates an instance of AnalyticsData""" + + self.__iframe_url_tracking_code = None + self.__url_analytics_enabled = None + self.__analytics_enabled = None + self.__analytics_enabled_time = None + self.__tracking_code = None + self.__key_modified = dict() + + def get_iframe_url_tracking_code(self): + """ + The method to get the iframe_url_tracking_code + + Returns: + string: A string representing the iframe_url_tracking_code + """ + + return self.__iframe_url_tracking_code + + def set_iframe_url_tracking_code(self, iframe_url_tracking_code): + """ + The method to set the value to iframe_url_tracking_code + + Parameters: + iframe_url_tracking_code (string) : A string representing the iframe_url_tracking_code + """ + + if iframe_url_tracking_code is not None and not isinstance(iframe_url_tracking_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iframe_url_tracking_code EXPECTED TYPE: str', None, None) + + self.__iframe_url_tracking_code = iframe_url_tracking_code + self.__key_modified['iframe_url_tracking_code'] = 1 + + def get_url_analytics_enabled(self): + """ + The method to get the url_analytics_enabled + + Returns: + bool: A bool representing the url_analytics_enabled + """ + + return self.__url_analytics_enabled + + def set_url_analytics_enabled(self, url_analytics_enabled): + """ + The method to set the value to url_analytics_enabled + + Parameters: + url_analytics_enabled (bool) : A bool representing the url_analytics_enabled + """ + + if url_analytics_enabled is not None and not isinstance(url_analytics_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: url_analytics_enabled EXPECTED TYPE: bool', None, None) + + self.__url_analytics_enabled = url_analytics_enabled + self.__key_modified['url_analytics_enabled'] = 1 + + def get_analytics_enabled(self): + """ + The method to get the analytics_enabled + + Returns: + bool: A bool representing the analytics_enabled + """ + + return self.__analytics_enabled + + def set_analytics_enabled(self, analytics_enabled): + """ + The method to set the value to analytics_enabled + + Parameters: + analytics_enabled (bool) : A bool representing the analytics_enabled + """ + + if analytics_enabled is not None and not isinstance(analytics_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics_enabled EXPECTED TYPE: bool', None, None) + + self.__analytics_enabled = analytics_enabled + self.__key_modified['analytics_enabled'] = 1 + + def get_analytics_enabled_time(self): + """ + The method to get the analytics_enabled_time + + Returns: + datetime: An instance of datetime + """ + + return self.__analytics_enabled_time + + def set_analytics_enabled_time(self, analytics_enabled_time): + """ + The method to set the value to analytics_enabled_time + + Parameters: + analytics_enabled_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if analytics_enabled_time is not None and not isinstance(analytics_enabled_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics_enabled_time EXPECTED TYPE: datetime', None, None) + + self.__analytics_enabled_time = analytics_enabled_time + self.__key_modified['analytics_enabled_time'] = 1 + + def get_tracking_code(self): + """ + The method to get the tracking_code + + Returns: + string: A string representing the tracking_code + """ + + return self.__tracking_code + + def set_tracking_code(self, tracking_code): + """ + The method to set the value to tracking_code + + Parameters: + tracking_code (string) : A string representing the tracking_code + """ + + if tracking_code is not None and not isinstance(tracking_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tracking_code EXPECTED TYPE: str', None, None) + + self.__tracking_code = tracking_code + self.__key_modified['tracking_code'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/api_exception.py new file mode 100644 index 0000000..ec59637 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/assignment_rule.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/assignment_rule.py new file mode 100644 index 0000000..bbf3f23 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/assignment_rule.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignmentRule(object): + def __init__(self): + """Creates an instance of AssignmentRule""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/auto_response_rule.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/auto_response_rule.py new file mode 100644 index 0000000..9ce896a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/auto_response_rule.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutoResponseRule(object): + def __init__(self): + """Creates an instance of AutoResponseRule""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/body_wrapper.py new file mode 100644 index 0000000..8440791 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__webforms = None + self.__key_modified = dict() + + def get_webforms(self): + """ + The method to get the webforms + + Returns: + list: An instance of list + """ + + return self.__webforms + + def set_webforms(self, webforms): + """ + The method to set the value to webforms + + Parameters: + webforms (list) : An instance of list + """ + + if webforms is not None and not isinstance(webforms, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webforms EXPECTED TYPE: list', None, None) + + self.__webforms = webforms + self.__key_modified['webforms'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/button_attributes.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/button_attributes.py new file mode 100644 index 0000000..c1a32cb --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/button_attributes.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ButtonAttributes(object): + def __init__(self): + """Creates an instance of ButtonAttributes""" + + self.__color = None + self.__name = None + self.__key_modified = dict() + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/fields.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/fields.py new file mode 100644 index 0000000..2afcc23 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/fields.py @@ -0,0 +1,464 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__layout = None + self.__help = None + self.__field = None + self.__module = None + self.__secret_key = None + self.__recaptcha_label = None + self.__hidden = None + self.__site_key = None + self.__advanced = None + self.__api_name = None + self.__field_label = None + self.__theme = None + self.__id = None + self.__required = None + self.__field_name = None + self.__date_format = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_help(self): + """ + The method to get the help + + Returns: + string: A string representing the help + """ + + return self.__help + + def set_help(self, help): + """ + The method to set the value to help + + Parameters: + help (string) : A string representing the help + """ + + if help is not None and not isinstance(help, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: help EXPECTED TYPE: str', None, None) + + self.__help = help + self.__key_modified['help'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Fields: An instance of Fields + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Fields) : An instance of Fields + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.fields import Fields + except Exception: + from .fields import Fields + + if field is not None and not isinstance(field, Fields): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Fields', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_secret_key(self): + """ + The method to get the secret_key + + Returns: + string: A string representing the secret_key + """ + + return self.__secret_key + + def set_secret_key(self, secret_key): + """ + The method to set the value to secret_key + + Parameters: + secret_key (string) : A string representing the secret_key + """ + + if secret_key is not None and not isinstance(secret_key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secret_key EXPECTED TYPE: str', None, None) + + self.__secret_key = secret_key + self.__key_modified['secret_key'] = 1 + + def get_recaptcha_label(self): + """ + The method to get the recaptcha_label + + Returns: + string: A string representing the recaptcha_label + """ + + return self.__recaptcha_label + + def set_recaptcha_label(self, recaptcha_label): + """ + The method to set the value to recaptcha_label + + Parameters: + recaptcha_label (string) : A string representing the recaptcha_label + """ + + if recaptcha_label is not None and not isinstance(recaptcha_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recaptcha_label EXPECTED TYPE: str', None, None) + + self.__recaptcha_label = recaptcha_label + self.__key_modified['recaptcha_label'] = 1 + + def get_hidden(self): + """ + The method to get the hidden + + Returns: + bool: A bool representing the hidden + """ + + return self.__hidden + + def set_hidden(self, hidden): + """ + The method to set the value to hidden + + Parameters: + hidden (bool) : A bool representing the hidden + """ + + if hidden is not None and not isinstance(hidden, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hidden EXPECTED TYPE: bool', None, None) + + self.__hidden = hidden + self.__key_modified['hidden'] = 1 + + def get_site_key(self): + """ + The method to get the site_key + + Returns: + string: A string representing the site_key + """ + + return self.__site_key + + def set_site_key(self, site_key): + """ + The method to set the value to site_key + + Parameters: + site_key (string) : A string representing the site_key + """ + + if site_key is not None and not isinstance(site_key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: site_key EXPECTED TYPE: str', None, None) + + self.__site_key = site_key + self.__key_modified['site_key'] = 1 + + def get_advanced(self): + """ + The method to get the advanced + + Returns: + bool: A bool representing the advanced + """ + + return self.__advanced + + def set_advanced(self, advanced): + """ + The method to set the value to advanced + + Parameters: + advanced (bool) : A bool representing the advanced + """ + + if advanced is not None and not isinstance(advanced, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: advanced EXPECTED TYPE: bool', None, None) + + self.__advanced = advanced + self.__key_modified['advanced'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_theme(self): + """ + The method to get the theme + + Returns: + string: A string representing the theme + """ + + return self.__theme + + def set_theme(self, theme): + """ + The method to set the value to theme + + Parameters: + theme (string) : A string representing the theme + """ + + if theme is not None and not isinstance(theme, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: theme EXPECTED TYPE: str', None, None) + + self.__theme = theme + self.__key_modified['theme'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_field_name(self): + """ + The method to get the field_name + + Returns: + string: A string representing the field_name + """ + + return self.__field_name + + def set_field_name(self, field_name): + """ + The method to set the value to field_name + + Parameters: + field_name (string) : A string representing the field_name + """ + + if field_name is not None and not isinstance(field_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_name EXPECTED TYPE: str', None, None) + + self.__field_name = field_name + self.__key_modified['field_name'] = 1 + + def get_date_format(self): + """ + The method to get the date_format + + Returns: + string: A string representing the date_format + """ + + return self.__date_format + + def set_date_format(self, date_format): + """ + The method to set the value to date_format + + Parameters: + date_format (string) : A string representing the date_format + """ + + if date_format is not None and not isinstance(date_format, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date_format EXPECTED TYPE: str', None, None) + + self.__date_format = date_format + self.__key_modified['date_format'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/font_attributes.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/font_attributes.py new file mode 100644 index 0000000..67b5d92 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/font_attributes.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FontAttributes(object): + def __init__(self): + """Creates an instance of FontAttributes""" + + self.__size = None + self.__color = None + self.__family = None + self.__key_modified = dict() + + def get_size(self): + """ + The method to get the size + + Returns: + int: An int representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (int) : An int representing the size + """ + + if size is not None and not isinstance(size, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: int', None, None) + + self.__size = size + self.__key_modified['size'] = 1 + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_family(self): + """ + The method to get the family + + Returns: + string: A string representing the family + """ + + return self.__family + + def set_family(self, family): + """ + The method to set the value to family + + Parameters: + family (string) : A string representing the family + """ + + if family is not None and not isinstance(family, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: family EXPECTED TYPE: str', None, None) + + self.__family = family + self.__key_modified['family'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/form_attributes.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/form_attributes.py new file mode 100644 index 0000000..cb13a64 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/form_attributes.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FormAttributes(object): + def __init__(self): + """Creates an instance of FormAttributes""" + + self.__color = None + self.__width = None + self.__font_attributes = None + self.__align = None + self.__display_form_name = None + self.__key_modified = dict() + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_width(self): + """ + The method to get the width + + Returns: + int: An int representing the width + """ + + return self.__width + + def set_width(self, width): + """ + The method to set the value to width + + Parameters: + width (int) : An int representing the width + """ + + if width is not None and not isinstance(width, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: width EXPECTED TYPE: int', None, None) + + self.__width = width + self.__key_modified['width'] = 1 + + def get_font_attributes(self): + """ + The method to get the font_attributes + + Returns: + FontAttributes: An instance of FontAttributes + """ + + return self.__font_attributes + + def set_font_attributes(self, font_attributes): + """ + The method to set the value to font_attributes + + Parameters: + font_attributes (FontAttributes) : An instance of FontAttributes + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.font_attributes import FontAttributes + except Exception: + from .font_attributes import FontAttributes + + if font_attributes is not None and not isinstance(font_attributes, FontAttributes): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: font_attributes EXPECTED TYPE: FontAttributes', None, None) + + self.__font_attributes = font_attributes + self.__key_modified['font_attributes'] = 1 + + def get_align(self): + """ + The method to get the align + + Returns: + string: A string representing the align + """ + + return self.__align + + def set_align(self, align): + """ + The method to set the value to align + + Parameters: + align (string) : A string representing the align + """ + + if align is not None and not isinstance(align, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: align EXPECTED TYPE: str', None, None) + + self.__align = align + self.__key_modified['align'] = 1 + + def get_display_form_name(self): + """ + The method to get the display_form_name + + Returns: + string: A string representing the display_form_name + """ + + return self.__display_form_name + + def set_display_form_name(self, display_form_name): + """ + The method to set the value to display_form_name + + Parameters: + display_form_name (string) : A string representing the display_form_name + """ + + if display_form_name is not None and not isinstance(display_form_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_form_name EXPECTED TYPE: str', None, None) + + self.__display_form_name = display_form_name + self.__key_modified['display_form_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/from_address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/from_address.py new file mode 100644 index 0000000..5780ece --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/from_address.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FromAddress(object): + def __init__(self): + """Creates an instance of FromAddress""" + + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/layout.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/layout.py new file mode 100644 index 0000000..50dd4c2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/module.py new file mode 100644 index 0000000..1288ec5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__module_name = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/owner.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/response_wrapper.py new file mode 100644 index 0000000..9a4a2a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__webforms = None + self.__key_modified = dict() + + def get_webforms(self): + """ + The method to get the webforms + + Returns: + list: An instance of list + """ + + return self.__webforms + + def set_webforms(self, webforms): + """ + The method to set the value to webforms + + Parameters: + webforms (list) : An instance of list + """ + + if webforms is not None and not isinstance(webforms, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webforms EXPECTED TYPE: list', None, None) + + self.__webforms = webforms + self.__key_modified['webforms'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/spam_controll.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/spam_controll.py new file mode 100644 index 0000000..26f6f80 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/spam_controll.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SpamControll(object): + def __init__(self): + """Creates an instance of SpamControll""" + + self.__status = None + self.__exclude_score = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_exclude_score(self): + """ + The method to get the exclude_score + + Returns: + string: A string representing the exclude_score + """ + + return self.__exclude_score + + def set_exclude_score(self, exclude_score): + """ + The method to set the value to exclude_score + + Parameters: + exclude_score (string) : A string representing the exclude_score + """ + + if exclude_score is not None and not isinstance(exclude_score, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_score EXPECTED TYPE: str', None, None) + + self.__exclude_score = exclude_score + self.__key_modified['exclude_score'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/success_response.py new file mode 100644 index 0000000..ee7624b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/suggestion.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/suggestion.py new file mode 100644 index 0000000..3839d27 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/suggestion.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Suggestion(object): + def __init__(self): + """Creates an instance of Suggestion""" + + self.__available = None + self.__type = None + self.__key_modified = dict() + + def get_available(self): + """ + The method to get the available + + Returns: + bool: A bool representing the available + """ + + return self.__available + + def set_available(self, available): + """ + The method to set the value to available + + Parameters: + available (bool) : A bool representing the available + """ + + if available is not None and not isinstance(available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available EXPECTED TYPE: bool', None, None) + + self.__available = available + self.__key_modified['available'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/tags.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/tags.py new file mode 100644 index 0000000..b96e1e2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/tags.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tags(object): + def __init__(self): + """Creates an instance of Tags""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/web_form.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/web_form.py new file mode 100644 index 0000000..e38c611 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/web_form.py @@ -0,0 +1,1113 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class WebForm(object): + def __init__(self): + """Creates an instance of WebForm""" + + self.__google_site = None + self.__encrypted_form_id = None + self.__owner = None + self.__user_type = None + self.__acknowledge_visitor = None + self.__button_attributes = None + self.__encrypted_zgid = None + self.__created_time = None + self.__analytics_data = None + self.__module = None + self.__encrypted_module = None + self.__active = None + self.__adword_enabled = None + self.__notify_owner = None + self.__created_by = None + self.__form_attributes = None + self.__location_url = None + self.__landing_url = None + self.__double_optin_enabled = None + self.__layout = None + self.__tags = None + self.__approval_request = None + self.__type = None + self.__create_contact = None + self.__assignment_rule = None + self.__name = None + self.__id = None + self.__spam_control = None + self.__fields = None + self.__form_fields = None + self.__abtesting = None + self.__visitor_tracking = None + self.__last_submitted_time = None + self.__action_on_submit = None + self.__action_value = None + self.__suggestion = None + self.__embed_code = None + self.__code_formats = None + self.__source_code = None + self.__iframe_code = None + self.__key_modified = dict() + + def get_google_site(self): + """ + The method to get the google_site + + Returns: + string: A string representing the google_site + """ + + return self.__google_site + + def set_google_site(self, google_site): + """ + The method to set the value to google_site + + Parameters: + google_site (string) : A string representing the google_site + """ + + if google_site is not None and not isinstance(google_site, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: google_site EXPECTED TYPE: str', None, None) + + self.__google_site = google_site + self.__key_modified['google_site'] = 1 + + def get_encrypted_form_id(self): + """ + The method to get the encrypted_form_id + + Returns: + string: A string representing the encrypted_form_id + """ + + return self.__encrypted_form_id + + def set_encrypted_form_id(self, encrypted_form_id): + """ + The method to set the value to encrypted_form_id + + Parameters: + encrypted_form_id (string) : A string representing the encrypted_form_id + """ + + if encrypted_form_id is not None and not isinstance(encrypted_form_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encrypted_form_id EXPECTED TYPE: str', None, None) + + self.__encrypted_form_id = encrypted_form_id + self.__key_modified['encrypted_form_id'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + User: An instance of User + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.user import User + except Exception: + from .user import User + + if user_type is not None and not isinstance(user_type, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: User', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def get_acknowledge_visitor(self): + """ + The method to get the acknowledge_visitor + + Returns: + AcknowledgeVisitors: An instance of AcknowledgeVisitors + """ + + return self.__acknowledge_visitor + + def set_acknowledge_visitor(self, acknowledge_visitor): + """ + The method to set the value to acknowledge_visitor + + Parameters: + acknowledge_visitor (AcknowledgeVisitors) : An instance of AcknowledgeVisitors + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.acknowledge_visitors import AcknowledgeVisitors + except Exception: + from .acknowledge_visitors import AcknowledgeVisitors + + if acknowledge_visitor is not None and not isinstance(acknowledge_visitor, AcknowledgeVisitors): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: acknowledge_visitor EXPECTED TYPE: AcknowledgeVisitors', None, None) + + self.__acknowledge_visitor = acknowledge_visitor + self.__key_modified['acknowledge_visitor'] = 1 + + def get_button_attributes(self): + """ + The method to get the button_attributes + + Returns: + list: An instance of list + """ + + return self.__button_attributes + + def set_button_attributes(self, button_attributes): + """ + The method to set the value to button_attributes + + Parameters: + button_attributes (list) : An instance of list + """ + + if button_attributes is not None and not isinstance(button_attributes, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: button_attributes EXPECTED TYPE: list', None, None) + + self.__button_attributes = button_attributes + self.__key_modified['button_attributes'] = 1 + + def get_encrypted_zgid(self): + """ + The method to get the encrypted_zgid + + Returns: + string: A string representing the encrypted_zgid + """ + + return self.__encrypted_zgid + + def set_encrypted_zgid(self, encrypted_zgid): + """ + The method to set the value to encrypted_zgid + + Parameters: + encrypted_zgid (string) : A string representing the encrypted_zgid + """ + + if encrypted_zgid is not None and not isinstance(encrypted_zgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encrypted_zgid EXPECTED TYPE: str', None, None) + + self.__encrypted_zgid = encrypted_zgid + self.__key_modified['encrypted_zgid'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_analytics_data(self): + """ + The method to get the analytics_data + + Returns: + AnalyticsData: An instance of AnalyticsData + """ + + return self.__analytics_data + + def set_analytics_data(self, analytics_data): + """ + The method to set the value to analytics_data + + Parameters: + analytics_data (AnalyticsData) : An instance of AnalyticsData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.analytics_data import AnalyticsData + except Exception: + from .analytics_data import AnalyticsData + + if analytics_data is not None and not isinstance(analytics_data, AnalyticsData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics_data EXPECTED TYPE: AnalyticsData', None, None) + + self.__analytics_data = analytics_data + self.__key_modified['analytics_data'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_encrypted_module(self): + """ + The method to get the encrypted_module + + Returns: + string: A string representing the encrypted_module + """ + + return self.__encrypted_module + + def set_encrypted_module(self, encrypted_module): + """ + The method to set the value to encrypted_module + + Parameters: + encrypted_module (string) : A string representing the encrypted_module + """ + + if encrypted_module is not None and not isinstance(encrypted_module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encrypted_module EXPECTED TYPE: str', None, None) + + self.__encrypted_module = encrypted_module + self.__key_modified['encrypted_module'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_adword_enabled(self): + """ + The method to get the adword_enabled + + Returns: + bool: A bool representing the adword_enabled + """ + + return self.__adword_enabled + + def set_adword_enabled(self, adword_enabled): + """ + The method to set the value to adword_enabled + + Parameters: + adword_enabled (bool) : A bool representing the adword_enabled + """ + + if adword_enabled is not None and not isinstance(adword_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: adword_enabled EXPECTED TYPE: bool', None, None) + + self.__adword_enabled = adword_enabled + self.__key_modified['adword_enabled'] = 1 + + def get_notify_owner(self): + """ + The method to get the notify_owner + + Returns: + Owner: An instance of Owner + """ + + return self.__notify_owner + + def set_notify_owner(self, notify_owner): + """ + The method to set the value to notify_owner + + Parameters: + notify_owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.owner import Owner + except Exception: + from .owner import Owner + + if notify_owner is not None and not isinstance(notify_owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_owner EXPECTED TYPE: Owner', None, None) + + self.__notify_owner = notify_owner + self.__key_modified['notify_owner'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_form_attributes(self): + """ + The method to get the form_attributes + + Returns: + FormAttributes: An instance of FormAttributes + """ + + return self.__form_attributes + + def set_form_attributes(self, form_attributes): + """ + The method to set the value to form_attributes + + Parameters: + form_attributes (FormAttributes) : An instance of FormAttributes + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.form_attributes import FormAttributes + except Exception: + from .form_attributes import FormAttributes + + if form_attributes is not None and not isinstance(form_attributes, FormAttributes): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_attributes EXPECTED TYPE: FormAttributes', None, None) + + self.__form_attributes = form_attributes + self.__key_modified['form_attributes'] = 1 + + def get_location_url(self): + """ + The method to get the location_url + + Returns: + list: An instance of list + """ + + return self.__location_url + + def set_location_url(self, location_url): + """ + The method to set the value to location_url + + Parameters: + location_url (list) : An instance of list + """ + + if location_url is not None and not isinstance(location_url, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: location_url EXPECTED TYPE: list', None, None) + + self.__location_url = location_url + self.__key_modified['location_url'] = 1 + + def get_landing_url(self): + """ + The method to get the landing_url + + Returns: + string: A string representing the landing_url + """ + + return self.__landing_url + + def set_landing_url(self, landing_url): + """ + The method to set the value to landing_url + + Parameters: + landing_url (string) : A string representing the landing_url + """ + + if landing_url is not None and not isinstance(landing_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: landing_url EXPECTED TYPE: str', None, None) + + self.__landing_url = landing_url + self.__key_modified['landing_url'] = 1 + + def get_double_optin_enabled(self): + """ + The method to get the double_optin_enabled + + Returns: + bool: A bool representing the double_optin_enabled + """ + + return self.__double_optin_enabled + + def set_double_optin_enabled(self, double_optin_enabled): + """ + The method to set the value to double_optin_enabled + + Parameters: + double_optin_enabled (bool) : A bool representing the double_optin_enabled + """ + + if double_optin_enabled is not None and not isinstance(double_optin_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: double_optin_enabled EXPECTED TYPE: bool', None, None) + + self.__double_optin_enabled = double_optin_enabled + self.__key_modified['double_optin_enabled'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_approval_request(self): + """ + The method to get the approval_request + + Returns: + bool: A bool representing the approval_request + """ + + return self.__approval_request + + def set_approval_request(self, approval_request): + """ + The method to set the value to approval_request + + Parameters: + approval_request (bool) : A bool representing the approval_request + """ + + if approval_request is not None and not isinstance(approval_request, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approval_request EXPECTED TYPE: bool', None, None) + + self.__approval_request = approval_request + self.__key_modified['approval_request'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_create_contact(self): + """ + The method to get the create_contact + + Returns: + bool: A bool representing the create_contact + """ + + return self.__create_contact + + def set_create_contact(self, create_contact): + """ + The method to set the value to create_contact + + Parameters: + create_contact (bool) : A bool representing the create_contact + """ + + if create_contact is not None and not isinstance(create_contact, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create_contact EXPECTED TYPE: bool', None, None) + + self.__create_contact = create_contact + self.__key_modified['create_contact'] = 1 + + def get_assignment_rule(self): + """ + The method to get the assignment_rule + + Returns: + AssignmentRule: An instance of AssignmentRule + """ + + return self.__assignment_rule + + def set_assignment_rule(self, assignment_rule): + """ + The method to set the value to assignment_rule + + Parameters: + assignment_rule (AssignmentRule) : An instance of AssignmentRule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.assignment_rule import AssignmentRule + except Exception: + from .assignment_rule import AssignmentRule + + if assignment_rule is not None and not isinstance(assignment_rule, AssignmentRule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment_rule EXPECTED TYPE: AssignmentRule', None, None) + + self.__assignment_rule = assignment_rule + self.__key_modified['assignment_rule'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_spam_control(self): + """ + The method to get the spam_control + + Returns: + SpamControll: An instance of SpamControll + """ + + return self.__spam_control + + def set_spam_control(self, spam_control): + """ + The method to set the value to spam_control + + Parameters: + spam_control (SpamControll) : An instance of SpamControll + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.spam_controll import SpamControll + except Exception: + from .spam_controll import SpamControll + + if spam_control is not None and not isinstance(spam_control, SpamControll): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: spam_control EXPECTED TYPE: SpamControll', None, None) + + self.__spam_control = spam_control + self.__key_modified['spam_control'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_form_fields(self): + """ + The method to get the form_fields + + Returns: + list: An instance of list + """ + + return self.__form_fields + + def set_form_fields(self, form_fields): + """ + The method to set the value to form_fields + + Parameters: + form_fields (list) : An instance of list + """ + + if form_fields is not None and not isinstance(form_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_fields EXPECTED TYPE: list', None, None) + + self.__form_fields = form_fields + self.__key_modified['form_fields'] = 1 + + def get_abtesting(self): + """ + The method to get the abtesting + + Returns: + list: An instance of list + """ + + return self.__abtesting + + def set_abtesting(self, abtesting): + """ + The method to set the value to abtesting + + Parameters: + abtesting (list) : An instance of list + """ + + if abtesting is not None and not isinstance(abtesting, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: abtesting EXPECTED TYPE: list', None, None) + + self.__abtesting = abtesting + self.__key_modified['abtesting'] = 1 + + def get_visitor_tracking(self): + """ + The method to get the visitor_tracking + + Returns: + string: A string representing the visitor_tracking + """ + + return self.__visitor_tracking + + def set_visitor_tracking(self, visitor_tracking): + """ + The method to set the value to visitor_tracking + + Parameters: + visitor_tracking (string) : A string representing the visitor_tracking + """ + + if visitor_tracking is not None and not isinstance(visitor_tracking, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visitor_tracking EXPECTED TYPE: str', None, None) + + self.__visitor_tracking = visitor_tracking + self.__key_modified['visitor_tracking'] = 1 + + def get_last_submitted_time(self): + """ + The method to get the last_submitted_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_submitted_time + + def set_last_submitted_time(self, last_submitted_time): + """ + The method to set the value to last_submitted_time + + Parameters: + last_submitted_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_submitted_time is not None and not isinstance(last_submitted_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_submitted_time EXPECTED TYPE: datetime', None, None) + + self.__last_submitted_time = last_submitted_time + self.__key_modified['last_submitted_time'] = 1 + + def get_action_on_submit(self): + """ + The method to get the action_on_submit + + Returns: + string: A string representing the action_on_submit + """ + + return self.__action_on_submit + + def set_action_on_submit(self, action_on_submit): + """ + The method to set the value to action_on_submit + + Parameters: + action_on_submit (string) : A string representing the action_on_submit + """ + + if action_on_submit is not None and not isinstance(action_on_submit, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_on_submit EXPECTED TYPE: str', None, None) + + self.__action_on_submit = action_on_submit + self.__key_modified['action_on_submit'] = 1 + + def get_action_value(self): + """ + The method to get the action_value + + Returns: + string: A string representing the action_value + """ + + return self.__action_value + + def set_action_value(self, action_value): + """ + The method to set the value to action_value + + Parameters: + action_value (string) : A string representing the action_value + """ + + if action_value is not None and not isinstance(action_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_value EXPECTED TYPE: str', None, None) + + self.__action_value = action_value + self.__key_modified['action_value'] = 1 + + def get_suggestion(self): + """ + The method to get the suggestion + + Returns: + Suggestion: An instance of Suggestion + """ + + return self.__suggestion + + def set_suggestion(self, suggestion): + """ + The method to set the value to suggestion + + Parameters: + suggestion (Suggestion) : An instance of Suggestion + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.suggestion import Suggestion + except Exception: + from .suggestion import Suggestion + + if suggestion is not None and not isinstance(suggestion, Suggestion): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suggestion EXPECTED TYPE: Suggestion', None, None) + + self.__suggestion = suggestion + self.__key_modified['suggestion'] = 1 + + def get_embed_code(self): + """ + The method to get the embed_code + + Returns: + string: A string representing the embed_code + """ + + return self.__embed_code + + def set_embed_code(self, embed_code): + """ + The method to set the value to embed_code + + Parameters: + embed_code (string) : A string representing the embed_code + """ + + if embed_code is not None and not isinstance(embed_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: embed_code EXPECTED TYPE: str', None, None) + + self.__embed_code = embed_code + self.__key_modified['embed_code'] = 1 + + def get_code_formats(self): + """ + The method to get the code_formats + + Returns: + list: An instance of list + """ + + return self.__code_formats + + def set_code_formats(self, code_formats): + """ + The method to set the value to code_formats + + Parameters: + code_formats (list) : An instance of list + """ + + if code_formats is not None and not isinstance(code_formats, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code_formats EXPECTED TYPE: list', None, None) + + self.__code_formats = code_formats + self.__key_modified['code_formats'] = 1 + + def get_source_code(self): + """ + The method to get the source_code + + Returns: + string: A string representing the source_code + """ + + return self.__source_code + + def set_source_code(self, source_code): + """ + The method to set the value to source_code + + Parameters: + source_code (string) : A string representing the source_code + """ + + if source_code is not None and not isinstance(source_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source_code EXPECTED TYPE: str', None, None) + + self.__source_code = source_code + self.__key_modified['source_code'] = 1 + + def get_iframe_code(self): + """ + The method to get the iframe_code + + Returns: + string: A string representing the iframe_code + """ + + return self.__iframe_code + + def set_iframe_code(self, iframe_code): + """ + The method to set the value to iframe_code + + Parameters: + iframe_code (string) : A string representing the iframe_code + """ + + if iframe_code is not None and not isinstance(iframe_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iframe_code EXPECTED TYPE: str', None, None) + + self.__iframe_code = iframe_code + self.__key_modified['iframe_code'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/webforms_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/webforms_operations.py new file mode 100644 index 0000000..4be840d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/webforms/webforms_operations.py @@ -0,0 +1,289 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class WebformsOperations(object): + def __init__(self, module=None): + """ + Creates an instance of WebformsOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def get_web_forms(self): + """ + The method to get web forms + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms' + 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.Webforms.GetWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_web_forms(self, request): + """ + The method to create web forms + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/webforms' + 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('module', 'com.zoho.crm.api.Webforms.CreateWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_web_forms(self, request): + """ + The method to update web forms + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/webforms' + 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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.Webforms.UpdateWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_web_form(self, form_id): + """ + The method to get web form + + Parameters: + form_id (int) : An int representing the form_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms/' + api_path = api_path + str(form_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.Webforms.GetWebFormParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_web_form(self, form_id, request): + """ + The method to update web form + + Parameters: + form_id (int) : An int representing the form_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_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/v7/settings/webforms/' + api_path = api_path + str(form_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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.Webforms.UpdateWebFormParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_web_forms(self, form_id): + """ + The method to delete web forms + + Parameters: + form_id (int) : An int representing the form_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms/' + api_path = api_path + str(form_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.Webforms.DeleteWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_webforms_preview(self, form_id): + """ + The method to get webforms preview + + Parameters: + form_id (int) : An int representing the form_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms/' + api_path = api_path + str(form_id) + api_path = api_path + '/actions/preview' + 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.Webforms.GetWebformsPreviewParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetWebFormsParam(object): + pass + + +class CreateWebFormsParam(object): + pass + + +class UpdateWebFormsParam(object): + pass + + +class GetWebFormParam(object): + pass + + +class UpdateWebFormParam(object): + pass + + +class DeleteWebFormsParam(object): + pass + + +class GetWebformsPreviewParam(object): + pass diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/__init__.py new file mode 100644 index 0000000..1d79eb4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/__init__.py @@ -0,0 +1,23 @@ +from .container import Container +from .wizards_operations import WizardsOperations, GetWizardByIDParam +from .button_background import ButtonBackground +from .chart_data import ChartData +from .portal_user_type import PortalUserType +from .resource import Resource +from .criteria import Criteria +from .screen import Screen +from .message import Message +from .transition import Transition +from .conditional_rules import ConditionalRules +from .button import Button +from .api_exception import APIException +from .node import Node +from .response_handler import ResponseHandler +from .field import Field +from .exempted_portal_user_type import ExemptedPortalUserType +from .segment import Segment +from .response_wrapper import ResponseWrapper +from .connection import Connection +from .wizard import Wizard +from .actions import Actions +from .element import Element diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/actions.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/actions.py new file mode 100644 index 0000000..2040e1c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/actions.py @@ -0,0 +1,236 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Actions(object): + def __init__(self): + """Creates an instance of Actions""" + + self.__id = None + self.__type = None + self.__segment = None + self.__fields = None + self.__field = None + self.__value = None + self.__exempted_profiles = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_segment(self): + """ + The method to get the segment + + Returns: + Segment: An instance of Segment + """ + + return self.__segment + + def set_segment(self, segment): + """ + The method to set the value to segment + + Parameters: + segment (Segment) : An instance of Segment + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.segment import Segment + except Exception: + from .segment import Segment + + if segment is not None and not isinstance(segment, Segment): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: segment EXPECTED TYPE: Segment', None, None) + + self.__segment = segment + self.__key_modified['segment'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + Fields: An instance of Fields + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (Fields) : An instance of Fields + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields + except Exception: + from ..fields import Fields + + if fields is not None and not isinstance(fields, Fields): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Fields', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Fields: An instance of Fields + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Fields) : An instance of Fields + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields + except Exception: + from ..fields import Fields + + if field is not None and not isinstance(field, Fields): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Fields', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_exempted_profiles(self): + """ + The method to get the exempted_profiles + + Returns: + list: An instance of list + """ + + return self.__exempted_profiles + + def set_exempted_profiles(self, exempted_profiles): + """ + The method to set the value to exempted_profiles + + Parameters: + exempted_profiles (list) : An instance of list + """ + + if exempted_profiles is not None and not isinstance(exempted_profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exempted_profiles EXPECTED TYPE: list', None, None) + + self.__exempted_profiles = exempted_profiles + self.__key_modified['exempted_profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/api_exception.py new file mode 100644 index 0000000..542fc48 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/button.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/button.py new file mode 100644 index 0000000..d6095b2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/button.py @@ -0,0 +1,441 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Button(object): + def __init__(self): + """Creates an instance of Button""" + + self.__id = None + self.__sequence_number = None + self.__display_label = None + self.__criteria = None + self.__target_screen = None + self.__type = None + self.__message = None + self.__color = None + self.__shape = None + self.__background_color = None + self.__visibility = None + self.__resource = None + self.__transition = None + self.__category = None + self.__reference_id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_target_screen(self): + """ + The method to get the target_screen + + Returns: + Screen: An instance of Screen + """ + + return self.__target_screen + + def set_target_screen(self, target_screen): + """ + The method to set the value to target_screen + + Parameters: + target_screen (Screen) : An instance of Screen + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.screen import Screen + except Exception: + from .screen import Screen + + if target_screen is not None and not isinstance(target_screen, Screen): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: target_screen EXPECTED TYPE: Screen', None, None) + + self.__target_screen = target_screen + self.__key_modified['target_screen'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Message: An instance of Message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (Message) : An instance of Message + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.message import Message + except Exception: + from .message import Message + + if message is not None and not isinstance(message, Message): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Message', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_shape(self): + """ + The method to get the shape + + Returns: + string: A string representing the shape + """ + + return self.__shape + + def set_shape(self, shape): + """ + The method to set the value to shape + + Parameters: + shape (string) : A string representing the shape + """ + + if shape is not None and not isinstance(shape, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shape EXPECTED TYPE: str', None, None) + + self.__shape = shape + self.__key_modified['shape'] = 1 + + def get_background_color(self): + """ + The method to get the background_color + + Returns: + string: A string representing the background_color + """ + + return self.__background_color + + def set_background_color(self, background_color): + """ + The method to set the value to background_color + + Parameters: + background_color (string) : A string representing the background_color + """ + + if background_color is not None and not isinstance(background_color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: background_color EXPECTED TYPE: str', None, None) + + self.__background_color = background_color + self.__key_modified['background_color'] = 1 + + def get_visibility(self): + """ + The method to get the visibility + + Returns: + string: A string representing the visibility + """ + + return self.__visibility + + 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 get_resource(self): + """ + The method to get the resource + + Returns: + Object: A Object representing the resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Object) : A Object representing the resource + """ + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_transition(self): + """ + The method to get the transition + + Returns: + Transition: An instance of Transition + """ + + return self.__transition + + def set_transition(self, transition): + """ + The method to set the value to transition + + Parameters: + transition (Transition) : An instance of Transition + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.transition import Transition + except Exception: + from .transition import Transition + + if transition is not None and not isinstance(transition, Transition): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transition EXPECTED TYPE: Transition', None, None) + + self.__transition = transition + self.__key_modified['transition'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_reference_id(self): + """ + The method to get the reference_id + + Returns: + string: A string representing the reference_id + """ + + return self.__reference_id + + def set_reference_id(self, reference_id): + """ + The method to set the value to reference_id + + Parameters: + reference_id (string) : A string representing the reference_id + """ + + if reference_id is not None and not isinstance(reference_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reference_id EXPECTED TYPE: str', None, None) + + self.__reference_id = reference_id + self.__key_modified['reference_id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/button_background.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/button_background.py new file mode 100644 index 0000000..bda31f0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/button_background.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ButtonBackground(object): + def __init__(self): + """Creates an instance of ButtonBackground""" + + self.__button_background = None + self.__key_modified = dict() + + def get_button_background(self): + """ + The method to get the button_background + + Returns: + list: An instance of list + """ + + return self.__button_background + + def set_button_background(self, button_background): + """ + The method to set the value to button_background + + Parameters: + button_background (list) : An instance of list + """ + + if button_background is not None and not isinstance(button_background, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: button_background EXPECTED TYPE: list', None, None) + + self.__button_background = button_background + self.__key_modified['button_background'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/chart_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/chart_data.py new file mode 100644 index 0000000..6f99c04 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/chart_data.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ChartData(object): + def __init__(self): + """Creates an instance of ChartData""" + + self.__nodes = None + self.__connections = None + self.__color_palette = None + self.__canvas_width = None + self.__canvas_height = None + self.__key_modified = dict() + + def get_nodes(self): + """ + The method to get the nodes + + Returns: + list: An instance of list + """ + + return self.__nodes + + def set_nodes(self, nodes): + """ + The method to set the value to nodes + + Parameters: + nodes (list) : An instance of list + """ + + if nodes is not None and not isinstance(nodes, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: nodes EXPECTED TYPE: list', None, None) + + self.__nodes = nodes + self.__key_modified['nodes'] = 1 + + def get_connections(self): + """ + The method to get the connections + + Returns: + list: An instance of list + """ + + return self.__connections + + 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 get_color_palette(self): + """ + The method to get the color_palette + + Returns: + ButtonBackground: An instance of ButtonBackground + """ + + return self.__color_palette + + def set_color_palette(self, color_palette): + """ + The method to set the value to color_palette + + Parameters: + color_palette (ButtonBackground) : An instance of ButtonBackground + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.button_background import ButtonBackground + except Exception: + from .button_background import ButtonBackground + + if color_palette is not None and not isinstance(color_palette, ButtonBackground): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_palette EXPECTED TYPE: ButtonBackground', None, None) + + self.__color_palette = color_palette + self.__key_modified['color_palette'] = 1 + + def get_canvas_width(self): + """ + The method to get the canvas_width + + Returns: + int: An int representing the canvas_width + """ + + return self.__canvas_width + + 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 get_canvas_height(self): + """ + The method to get the canvas_height + + Returns: + int: An int representing the canvas_height + """ + + return self.__canvas_height + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/conditional_rules.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/conditional_rules.py new file mode 100644 index 0000000..3e3d452 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/conditional_rules.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ConditionalRules(object): + def __init__(self): + """Creates an instance of ConditionalRules""" + + self.__query_id = None + self.__execute_on = None + self.__criteria = None + self.__actions = None + self.__key_modified = dict() + + def get_query_id(self): + """ + The method to get the query_id + + Returns: + int: An int representing the query_id + """ + + return self.__query_id + + def set_query_id(self, query_id): + """ + The method to set the value to query_id + + Parameters: + query_id (int) : An int representing the query_id + """ + + if query_id is not None and not isinstance(query_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_id EXPECTED TYPE: int', None, None) + + self.__query_id = query_id + self.__key_modified['query_id'] = 1 + + def get_execute_on(self): + """ + The method to get the execute_on + + Returns: + Choice: An instance of Choice + """ + + return self.__execute_on + + def set_execute_on(self, execute_on): + """ + The method to set the value to execute_on + + Parameters: + execute_on (Choice) : An instance of Choice + """ + + if execute_on is not None and not isinstance(execute_on, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execute_on EXPECTED TYPE: Choice', None, None) + + self.__execute_on = execute_on + self.__key_modified['execute_on'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_actions(self): + """ + The method to get the actions + + Returns: + list: An instance of list + """ + + return self.__actions + + def set_actions(self, actions): + """ + The method to set the value to actions + + Parameters: + actions (list) : An instance of list + """ + + if actions is not None and not isinstance(actions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actions EXPECTED TYPE: list', None, None) + + self.__actions = actions + self.__key_modified['actions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/connection.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/connection.py new file mode 100644 index 0000000..7ec6f1e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/connection.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Connection(object): + def __init__(self): + """Creates an instance of Connection""" + + self.__source_button = None + self.__target_screen = None + self.__id = None + self.__key_modified = dict() + + def get_source_button(self): + """ + The method to get the source_button + + Returns: + Button: An instance of Button + """ + + return self.__source_button + + def set_source_button(self, source_button): + """ + The method to set the value to source_button + + Parameters: + source_button (Button) : An instance of Button + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.button import Button + except Exception: + from .button import Button + + if source_button is not None and not isinstance(source_button, Button): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source_button EXPECTED TYPE: Button', None, None) + + self.__source_button = source_button + self.__key_modified['source_button'] = 1 + + def get_target_screen(self): + """ + The method to get the target_screen + + Returns: + Screen: An instance of Screen + """ + + return self.__target_screen + + def set_target_screen(self, target_screen): + """ + The method to set the value to target_screen + + Parameters: + target_screen (Screen) : An instance of Screen + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.screen import Screen + except Exception: + from .screen import Screen + + if target_screen is not None and not isinstance(target_screen, Screen): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: target_screen EXPECTED TYPE: Screen', None, None) + + self.__target_screen = target_screen + self.__key_modified['target_screen'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/container.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/container.py new file mode 100644 index 0000000..9bd9c59 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/container.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Container(object): + def __init__(self): + """Creates an instance of Container""" + + self.__id = None + self.__layout = None + self.__chart_data = None + self.__screens = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layouts: An instance of Layouts + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layouts) : An instance of Layouts + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts import Layouts + except Exception: + from ..layouts import Layouts + + if layout is not None and not isinstance(layout, Layouts): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layouts', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_chart_data(self): + """ + The method to get the chart_data + + Returns: + ChartData: An instance of ChartData + """ + + return self.__chart_data + + def set_chart_data(self, chart_data): + """ + The method to set the value to chart_data + + Parameters: + chart_data (ChartData) : An instance of ChartData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.chart_data import ChartData + except Exception: + from .chart_data import ChartData + + if chart_data is not None and not isinstance(chart_data, ChartData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_data EXPECTED TYPE: ChartData', None, None) + + self.__chart_data = chart_data + self.__key_modified['chart_data'] = 1 + + def get_screens(self): + """ + The method to get the screens + + Returns: + list: An instance of list + """ + + return self.__screens + + def set_screens(self, screens): + """ + The method to set the value to screens + + Parameters: + screens (list) : An instance of list + """ + + if screens is not None and not isinstance(screens, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screens EXPECTED TYPE: list', None, None) + + self.__screens = screens + self.__key_modified['screens'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/criteria.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/criteria.py new file mode 100644 index 0000000..e3c4ef2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/element.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/element.py new file mode 100644 index 0000000..7ae0756 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/element.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Element(object): + def __init__(self): + """Creates an instance of Element""" + + self.__type = None + self.__resource = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + Resource: An instance of Resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Resource) : An instance of Resource + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.resource import Resource + except Exception: + from .resource import Resource + + if resource is not None and not isinstance(resource, Resource): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Resource', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/exempted_portal_user_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/exempted_portal_user_type.py new file mode 100644 index 0000000..850d60a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/exempted_portal_user_type.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExemptedPortalUserType(object): + def __init__(self): + """Creates an instance of ExemptedPortalUserType""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/message.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/message.py new file mode 100644 index 0000000..66dec0c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/message.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Message(object): + def __init__(self): + """Creates an instance of Message""" + + self.__title = None + self.__content = None + self.__key_modified = dict() + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/node.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/node.py new file mode 100644 index 0000000..5b821a8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/node.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Node(object): + def __init__(self): + """Creates an instance of Node""" + + self.__pos_y = None + self.__pos_x = None + self.__start_node = None + self.__screen = None + self.__key_modified = dict() + + def get_pos_y(self): + """ + The method to get the pos_y + + Returns: + int: An int representing the pos_y + """ + + return self.__pos_y + + def set_pos_y(self, pos_y): + """ + The method to set the value to pos_y + + Parameters: + pos_y (int) : An int representing the pos_y + """ + + if pos_y is not None and not isinstance(pos_y, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pos_y EXPECTED TYPE: int', None, None) + + self.__pos_y = pos_y + self.__key_modified['pos_y'] = 1 + + def get_pos_x(self): + """ + The method to get the pos_x + + Returns: + int: An int representing the pos_x + """ + + return self.__pos_x + + def set_pos_x(self, pos_x): + """ + The method to set the value to pos_x + + Parameters: + pos_x (int) : An int representing the pos_x + """ + + if pos_x is not None and not isinstance(pos_x, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pos_x EXPECTED TYPE: int', None, None) + + self.__pos_x = pos_x + self.__key_modified['pos_x'] = 1 + + def get_start_node(self): + """ + The method to get the start_node + + Returns: + bool: A bool representing the start_node + """ + + return self.__start_node + + def set_start_node(self, start_node): + """ + The method to set the value to start_node + + Parameters: + start_node (bool) : A bool representing the start_node + """ + + if start_node is not None and not isinstance(start_node, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_node EXPECTED TYPE: bool', None, None) + + self.__start_node = start_node + self.__key_modified['start_node'] = 1 + + def get_screen(self): + """ + The method to get the screen + + Returns: + Screen: An instance of Screen + """ + + return self.__screen + + def set_screen(self, screen): + """ + The method to set the value to screen + + Parameters: + screen (Screen) : An instance of Screen + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.screen import Screen + except Exception: + from .screen import Screen + + if screen is not None and not isinstance(screen, Screen): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screen EXPECTED TYPE: Screen', None, None) + + self.__screen = screen + self.__key_modified['screen'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/portal_user_type.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/portal_user_type.py new file mode 100644 index 0000000..217233b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/portal_user_type.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PortalUserType(object): + def __init__(self): + """Creates an instance of PortalUserType""" + + self.__id = None + self.__layout = None + self.__chart_data = None + self.__screens = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layouts: An instance of Layouts + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layouts) : An instance of Layouts + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts import Layouts + except Exception: + from ..layouts import Layouts + + if layout is not None and not isinstance(layout, Layouts): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layouts', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_chart_data(self): + """ + The method to get the chart_data + + Returns: + ChartData: An instance of ChartData + """ + + return self.__chart_data + + def set_chart_data(self, chart_data): + """ + The method to set the value to chart_data + + Parameters: + chart_data (ChartData) : An instance of ChartData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.chart_data import ChartData + except Exception: + from .chart_data import ChartData + + if chart_data is not None and not isinstance(chart_data, ChartData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_data EXPECTED TYPE: ChartData', None, None) + + self.__chart_data = chart_data + self.__key_modified['chart_data'] = 1 + + def get_screens(self): + """ + The method to get the screens + + Returns: + list: An instance of list + """ + + return self.__screens + + def set_screens(self, screens): + """ + The method to set the value to screens + + Parameters: + screens (list) : An instance of list + """ + + if screens is not None and not isinstance(screens, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screens EXPECTED TYPE: list', None, None) + + self.__screens = screens + self.__key_modified['screens'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/resource.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/resource.py new file mode 100644 index 0000000..92687f5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/response_wrapper.py new file mode 100644 index 0000000..2b98dc0 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__wizards = None + self.__key_modified = dict() + + def get_wizards(self): + """ + The method to get the wizards + + Returns: + list: An instance of list + """ + + return self.__wizards + + def set_wizards(self, wizards): + """ + The method to set the value to wizards + + Parameters: + wizards (list) : An instance of list + """ + + if wizards is not None and not isinstance(wizards, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wizards EXPECTED TYPE: list', None, None) + + self.__wizards = wizards + self.__key_modified['wizards'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/screen.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/screen.py new file mode 100644 index 0000000..84c6791 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/screen.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Screen(object): + def __init__(self): + """Creates an instance of Screen""" + + self.__display_label = None + self.__api_name = None + self.__id = None + self.__reference_id = None + self.__conditional_rules = None + self.__segments = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_reference_id(self): + """ + The method to get the reference_id + + Returns: + string: A string representing the reference_id + """ + + return self.__reference_id + + def set_reference_id(self, reference_id): + """ + The method to set the value to reference_id + + Parameters: + reference_id (string) : A string representing the reference_id + """ + + if reference_id is not None and not isinstance(reference_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reference_id EXPECTED TYPE: str', None, None) + + self.__reference_id = reference_id + self.__key_modified['reference_id'] = 1 + + def get_conditional_rules(self): + """ + The method to get the conditional_rules + + Returns: + list: An instance of list + """ + + return self.__conditional_rules + + def set_conditional_rules(self, conditional_rules): + """ + The method to set the value to conditional_rules + + Parameters: + conditional_rules (list) : An instance of list + """ + + if conditional_rules is not None and not isinstance(conditional_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: conditional_rules EXPECTED TYPE: list', None, None) + + self.__conditional_rules = conditional_rules + self.__key_modified['conditional_rules'] = 1 + + def get_segments(self): + """ + The method to get the segments + + Returns: + list: An instance of list + """ + + return self.__segments + + def set_segments(self, segments): + """ + The method to set the value to segments + + Parameters: + segments (list) : An instance of list + """ + + if segments is not None and not isinstance(segments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: segments EXPECTED TYPE: list', None, None) + + self.__segments = segments + self.__key_modified['segments'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/segment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/segment.py new file mode 100644 index 0000000..6da580e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/segment.py @@ -0,0 +1,249 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Segment(object): + def __init__(self): + """Creates an instance of Segment""" + + self.__sequence_number = None + self.__display_label = None + self.__column_count = None + self.__id = None + self.__type = None + self.__fields = None + self.__buttons = None + self.__elements = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_count(self): + """ + The method to get the column_count + + Returns: + int: An int representing the column_count + """ + + return self.__column_count + + def set_column_count(self, column_count): + """ + The method to set the value to column_count + + Parameters: + column_count (int) : An int representing the column_count + """ + + if column_count is not None and not isinstance(column_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: int', None, None) + + self.__column_count = column_count + self.__key_modified['column_count'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_buttons(self): + """ + The method to get the buttons + + Returns: + list: An instance of list + """ + + return self.__buttons + + def set_buttons(self, buttons): + """ + The method to set the value to buttons + + Parameters: + buttons (list) : An instance of list + """ + + if buttons is not None and not isinstance(buttons, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: buttons EXPECTED TYPE: list', None, None) + + self.__buttons = buttons + self.__key_modified['buttons'] = 1 + + def get_elements(self): + """ + The method to get the elements + + Returns: + list: An instance of list + """ + + return self.__elements + + def set_elements(self, elements): + """ + The method to set the value to elements + + Parameters: + elements (list) : An instance of list + """ + + if elements is not None and not isinstance(elements, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: elements EXPECTED TYPE: list', None, None) + + self.__elements = elements + self.__key_modified['elements'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/transition.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/transition.py new file mode 100644 index 0000000..597c3d2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/transition.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Transition(object): + def __init__(self): + """Creates an instance of Transition""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/wizard.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/wizard.py new file mode 100644 index 0000000..e2b6eaf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/wizard.py @@ -0,0 +1,423 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wizard(object): + def __init__(self): + """Creates an instance of Wizard""" + + self.__created_time = None + self.__modified_time = None + self.__module = None + self.__name = None + self.__modified_by = None + self.__profiles = None + self.__active = None + self.__containers = None + self.__id = None + self.__created_by = None + self.__portal_user_types = None + self.__exempted_portal_user_types = None + self.__parent_wizard = None + self.__draft = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_module(self): + """ + The method to get the module + + Returns: + Modules: An instance of Modules + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import Modules + except Exception: + from ..modules import Modules + + if module is not None and not isinstance(module, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Modules', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_containers(self): + """ + The method to get the containers + + Returns: + list: An instance of list + """ + + return self.__containers + + def set_containers(self, containers): + """ + The method to set the value to containers + + Parameters: + containers (list) : An instance of list + """ + + if containers is not None and not isinstance(containers, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: containers EXPECTED TYPE: list', None, None) + + self.__containers = containers + self.__key_modified['containers'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_portal_user_types(self): + """ + The method to get the portal_user_types + + Returns: + list: An instance of list + """ + + return self.__portal_user_types + + def set_portal_user_types(self, portal_user_types): + """ + The method to set the value to portal_user_types + + Parameters: + portal_user_types (list) : An instance of list + """ + + if portal_user_types is not None and not isinstance(portal_user_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_user_types EXPECTED TYPE: list', None, None) + + self.__portal_user_types = portal_user_types + self.__key_modified['portal_user_types'] = 1 + + def get_exempted_portal_user_types(self): + """ + The method to get the exempted_portal_user_types + + Returns: + list: An instance of list + """ + + return self.__exempted_portal_user_types + + def set_exempted_portal_user_types(self, exempted_portal_user_types): + """ + The method to set the value to exempted_portal_user_types + + Parameters: + exempted_portal_user_types (list) : An instance of list + """ + + if exempted_portal_user_types is not None and not isinstance(exempted_portal_user_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exempted_portal_user_types EXPECTED TYPE: list', None, None) + + self.__exempted_portal_user_types = exempted_portal_user_types + self.__key_modified['exempted_portal_user_types'] = 1 + + def get_parent_wizard(self): + """ + The method to get the parent_wizard + + Returns: + Wizard: An instance of Wizard + """ + + return self.__parent_wizard + + def set_parent_wizard(self, parent_wizard): + """ + The method to set the value to parent_wizard + + Parameters: + parent_wizard (Wizard) : An instance of Wizard + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.wizard import Wizard + except Exception: + from .wizard import Wizard + + if parent_wizard is not None and not isinstance(parent_wizard, Wizard): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_wizard EXPECTED TYPE: Wizard', None, None) + + self.__parent_wizard = parent_wizard + self.__key_modified['parent_wizard'] = 1 + + def get_draft(self): + """ + The method to get the draft + + Returns: + bool: A bool representing the draft + """ + + return self.__draft + + def set_draft(self, draft): + """ + The method to set the value to draft + + Parameters: + draft (bool) : A bool representing the draft + """ + + if draft is not None and not isinstance(draft, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: draft EXPECTED TYPE: bool', None, None) + + self.__draft = draft + self.__key_modified['draft'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/wizards_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/wizards_operations.py new file mode 100644 index 0000000..556c89c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/wizards/wizards_operations.py @@ -0,0 +1,81 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class WizardsOperations(object): + def __init__(self): + """Creates an instance of WizardsOperations""" + pass + + def get_wizards(self): + """ + The method to get wizards + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/wizards' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_wizard_by_id(self, wizard_id, param_instance=None): + """ + The method to get wizard by id + + Parameters: + wizard_id (string) : A string representing the wizard_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(wizard_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wizard_id EXPECTED TYPE: str', None, None) + + 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/v7/settings/wizards/' + api_path = api_path + str(wizard_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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetWizardByIDParam(object): + layout_id = Param('layout_id', 'com.zoho.crm.api.Wizards.GetWizardByIDParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/__init__.py new file mode 100644 index 0000000..9025a3c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .allowed_output_data import AllowedOutputData +from .allowed_field_map import AllowedFieldMap +from .crm_field import CrmField +from .enrich_field import EnrichField +from .response_wrapper import ResponseWrapper diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_field_map.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_field_map.py new file mode 100644 index 0000000..19167ba --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_field_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AllowedFieldMap(object): + def __init__(self): + """Creates an instance of AllowedFieldMap""" + + self.__output_data_field_mapping = None + self.__input_data_field_mapping = None + self.__key_modified = dict() + + def get_output_data_field_mapping(self): + """ + The method to get the output_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__output_data_field_mapping + + def set_output_data_field_mapping(self, output_data_field_mapping): + """ + The method to set the value to output_data_field_mapping + + Parameters: + output_data_field_mapping (list) : An instance of list + """ + + if output_data_field_mapping is not None and not isinstance(output_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: output_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__output_data_field_mapping = output_data_field_mapping + self.__key_modified['output_data_field_mapping'] = 1 + + def get_input_data_field_mapping(self): + """ + The method to get the input_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__input_data_field_mapping + + def set_input_data_field_mapping(self, input_data_field_mapping): + """ + The method to set the value to input_data_field_mapping + + Parameters: + input_data_field_mapping (list) : An instance of list + """ + + if input_data_field_mapping is not None and not isinstance(input_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: input_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__input_data_field_mapping = input_data_field_mapping + self.__key_modified['input_data_field_mapping'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_output_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_output_data.py new file mode 100644 index 0000000..3dcafa5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_output_data.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AllowedOutputData(object): + def __init__(self): + """Creates an instance of AllowedOutputData""" + + self.__enrich_field = None + self.__crm_fields = None + self.__key_modified = dict() + + def get_enrich_field(self): + """ + The method to get the enrich_field + + Returns: + EnrichField: An instance of EnrichField + """ + + return self.__enrich_field + + def set_enrich_field(self, enrich_field): + """ + The method to set the value to enrich_field + + Parameters: + enrich_field (EnrichField) : An instance of EnrichField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.enrich_field import EnrichField + except Exception: + from .enrich_field import EnrichField + + if enrich_field is not None and not isinstance(enrich_field, EnrichField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_field EXPECTED TYPE: EnrichField', None, None) + + self.__enrich_field = enrich_field + self.__key_modified['enrich_field'] = 1 + + def get_crm_fields(self): + """ + The method to get the crm_fields + + Returns: + list: An instance of list + """ + + return self.__crm_fields + + def set_crm_fields(self, crm_fields): + """ + The method to set the value to crm_fields + + Parameters: + crm_fields (list) : An instance of list + """ + + if crm_fields is not None and not isinstance(crm_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crm_fields EXPECTED TYPE: list', None, None) + + self.__crm_fields = crm_fields + self.__key_modified['crm_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/api_exception.py new file mode 100644 index 0000000..5161635 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/crm_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/crm_field.py new file mode 100644 index 0000000..bfd23f2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/crm_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CrmField(object): + def __init__(self): + """Creates an instance of CrmField""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/enrich_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/enrich_field.py new file mode 100644 index 0000000..e4acacf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/enrich_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichField(object): + def __init__(self): + """Creates an instance of EnrichField""" + + self.__name = None + self.__display_label = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/response_wrapper.py new file mode 100644 index 0000000..9769d10 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/response_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__allowed_field_mappings = None + self.__key_modified = dict() + + def get_allowed_field_mappings(self): + """ + The method to get the allowed_field_mappings + + Returns: + AllowedFieldMap: An instance of AllowedFieldMap + """ + + return self.__allowed_field_mappings + + def set_allowed_field_mappings(self, allowed_field_mappings): + """ + The method to set the value to allowed_field_mappings + + Parameters: + allowed_field_mappings (AllowedFieldMap) : An instance of AllowedFieldMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.allowed_field_map import AllowedFieldMap + except Exception: + from .allowed_field_map import AllowedFieldMap + + if allowed_field_mappings is not None and not isinstance(allowed_field_mappings, AllowedFieldMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_field_mappings EXPECTED TYPE: AllowedFieldMap', None, None) + + self.__allowed_field_mappings = allowed_field_mappings + self.__key_modified['allowed_field_mappings'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/__init__.py new file mode 100644 index 0000000..949482e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/__init__.py @@ -0,0 +1,18 @@ +from .input_data import InputData +from .action_wrapper import ActionWrapper +from .scrapy_body_wrapper import ScrapyBodyWrapper +from .scrapy_feedback import ScrapyFeedback +from .scrapy_success import ScrapySuccess +from .scrapy_action_response import ScrapyActionResponse +from .data_enrichment import DataEnrichment +from .module import Module +from .enrich_field import EnrichField +from .scrapy_action_wrapper import ScrapyActionWrapper +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .crm_field import CrmField +from .response_wrapper import ResponseWrapper +from .user import User +from .output_data import OutputData diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_wrapper.py new file mode 100644 index 0000000..f2ee6c6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__data_enrichment = None + self.__key_modified = dict() + + def get_data_enrichment(self): + """ + The method to get the data_enrichment + + Returns: + list: An instance of list + """ + + return self.__data_enrichment + + def set_data_enrichment(self, data_enrichment): + """ + The method to set the value to data_enrichment + + Parameters: + data_enrichment (list) : An instance of list + """ + + if data_enrichment is not None and not isinstance(data_enrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_enrichment EXPECTED TYPE: list', None, None) + + self.__data_enrichment = data_enrichment + self.__key_modified['data_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/api_exception.py new file mode 100644 index 0000000..8072139 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_action_response import ScrapyActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .scrapy_action_response import ScrapyActionResponse + + +class APIException(ActionResponse, ScrapyActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/body_wrapper.py new file mode 100644 index 0000000..290c05a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data_enrichment = None + self.__key_modified = dict() + + def get_data_enrichment(self): + """ + The method to get the data_enrichment + + Returns: + list: An instance of list + """ + + return self.__data_enrichment + + def set_data_enrichment(self, data_enrichment): + """ + The method to set the value to data_enrichment + + Parameters: + data_enrichment (list) : An instance of list + """ + + if data_enrichment is not None and not isinstance(data_enrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_enrichment EXPECTED TYPE: list', None, None) + + self.__data_enrichment = data_enrichment + self.__key_modified['data_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/crm_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/crm_field.py new file mode 100644 index 0000000..038f994 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/crm_field.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CrmField(object): + def __init__(self): + """Creates an instance of CrmField""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/data_enrichment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/data_enrichment.py new file mode 100644 index 0000000..adee73d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/data_enrichment.py @@ -0,0 +1,318 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataEnrichment(object): + def __init__(self): + """Creates an instance of DataEnrichment""" + + self.__module = None + self.__type = None + self.__output_data_field_mapping = None + self.__input_data_field_mapping = None + self.__id = None + self.__status = None + self.__created_time = None + self.__created_by = None + self.__modified_time = None + self.__modified_by = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_output_data_field_mapping(self): + """ + The method to get the output_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__output_data_field_mapping + + def set_output_data_field_mapping(self, output_data_field_mapping): + """ + The method to set the value to output_data_field_mapping + + Parameters: + output_data_field_mapping (list) : An instance of list + """ + + if output_data_field_mapping is not None and not isinstance(output_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: output_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__output_data_field_mapping = output_data_field_mapping + self.__key_modified['output_data_field_mapping'] = 1 + + def get_input_data_field_mapping(self): + """ + The method to get the input_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__input_data_field_mapping + + def set_input_data_field_mapping(self, input_data_field_mapping): + """ + The method to set the value to input_data_field_mapping + + Parameters: + input_data_field_mapping (list) : An instance of list + """ + + if input_data_field_mapping is not None and not isinstance(input_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: input_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__input_data_field_mapping = input_data_field_mapping + self.__key_modified['input_data_field_mapping'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + bool: A bool representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (bool) : A bool representing the status + """ + + if status is not None and not isinstance(status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: bool', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/enrich_field.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/enrich_field.py new file mode 100644 index 0000000..e4acacf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/enrich_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichField(object): + def __init__(self): + """Creates an instance of EnrichField""" + + self.__name = None + self.__display_label = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/input_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/input_data.py new file mode 100644 index 0000000..e465734 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/input_data.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InputData(object): + def __init__(self): + """Creates an instance of InputData""" + + self.__enrich_field = None + self.__crm_field = None + self.__key_modified = dict() + + def get_enrich_field(self): + """ + The method to get the enrich_field + + Returns: + EnrichField: An instance of EnrichField + """ + + return self.__enrich_field + + def set_enrich_field(self, enrich_field): + """ + The method to set the value to enrich_field + + Parameters: + enrich_field (EnrichField) : An instance of EnrichField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.enrich_field import EnrichField + except Exception: + from .enrich_field import EnrichField + + if enrich_field is not None and not isinstance(enrich_field, EnrichField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_field EXPECTED TYPE: EnrichField', None, None) + + self.__enrich_field = enrich_field + self.__key_modified['enrich_field'] = 1 + + def get_crm_field(self): + """ + The method to get the crm_field + + Returns: + CrmField: An instance of CrmField + """ + + return self.__crm_field + + def set_crm_field(self, crm_field): + """ + The method to set the value to crm_field + + Parameters: + crm_field (CrmField) : An instance of CrmField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.crm_field import CrmField + except Exception: + from .crm_field import CrmField + + if crm_field is not None and not isinstance(crm_field, CrmField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crm_field EXPECTED TYPE: CrmField', None, None) + + self.__crm_field = crm_field + self.__key_modified['crm_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/module.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/module.py new file mode 100644 index 0000000..af2dcdf --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/output_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/output_data.py new file mode 100644 index 0000000..b100835 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/output_data.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OutputData(object): + def __init__(self): + """Creates an instance of OutputData""" + + self.__enrich_field = None + self.__crm_field = None + self.__key_modified = dict() + + def get_enrich_field(self): + """ + The method to get the enrich_field + + Returns: + EnrichField: An instance of EnrichField + """ + + return self.__enrich_field + + def set_enrich_field(self, enrich_field): + """ + The method to set the value to enrich_field + + Parameters: + enrich_field (EnrichField) : An instance of EnrichField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.enrich_field import EnrichField + except Exception: + from .enrich_field import EnrichField + + if enrich_field is not None and not isinstance(enrich_field, EnrichField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_field EXPECTED TYPE: EnrichField', None, None) + + self.__enrich_field = enrich_field + self.__key_modified['enrich_field'] = 1 + + def get_crm_field(self): + """ + The method to get the crm_field + + Returns: + CrmField: An instance of CrmField + """ + + return self.__crm_field + + def set_crm_field(self, crm_field): + """ + The method to set the value to crm_field + + Parameters: + crm_field (CrmField) : An instance of CrmField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.crm_field import CrmField + except Exception: + from .crm_field import CrmField + + if crm_field is not None and not isinstance(crm_field, CrmField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crm_field EXPECTED TYPE: CrmField', None, None) + + self.__crm_field = crm_field + self.__key_modified['crm_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/response_wrapper.py new file mode 100644 index 0000000..62f797d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__data_enrichment = None + self.__key_modified = dict() + + def get_data_enrichment(self): + """ + The method to get the data_enrichment + + Returns: + list: An instance of list + """ + + return self.__data_enrichment + + def set_data_enrichment(self, data_enrichment): + """ + The method to set the value to data_enrichment + + Parameters: + data_enrichment (list) : An instance of list + """ + + if data_enrichment is not None and not isinstance(data_enrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_enrichment EXPECTED TYPE: list', None, None) + + self.__data_enrichment = data_enrichment + self.__key_modified['data_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_response.py new file mode 100644 index 0000000..fb271d3 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ScrapyActionResponse(ABC): + def __init__(self): + """Creates an instance of ScrapyActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_wrapper.py new file mode 100644 index 0000000..4630b6e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScrapyActionWrapper(object): + def __init__(self): + """Creates an instance of ScrapyActionWrapper""" + + self.__scrapy_feedback = None + self.__key_modified = dict() + + def get_scrapy_feedback(self): + """ + The method to get the scrapy_feedback + + Returns: + ScrapyActionResponse: An instance of ScrapyActionResponse + """ + + return self.__scrapy_feedback + + def set_scrapy_feedback(self, scrapy_feedback): + """ + The method to set the value to scrapy_feedback + + Parameters: + scrapy_feedback (ScrapyActionResponse) : An instance of ScrapyActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_action_response import ScrapyActionResponse + except Exception: + from .scrapy_action_response import ScrapyActionResponse + + if scrapy_feedback is not None and not isinstance(scrapy_feedback, ScrapyActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scrapy_feedback EXPECTED TYPE: ScrapyActionResponse', None, None) + + self.__scrapy_feedback = scrapy_feedback + self.__key_modified['scrapy_feedback'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_body_wrapper.py new file mode 100644 index 0000000..97bb4a2 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScrapyBodyWrapper(object): + def __init__(self): + """Creates an instance of ScrapyBodyWrapper""" + + self.__scrapy_feedback = None + self.__key_modified = dict() + + def get_scrapy_feedback(self): + """ + The method to get the scrapy_feedback + + Returns: + ScrapyFeedback: An instance of ScrapyFeedback + """ + + return self.__scrapy_feedback + + def set_scrapy_feedback(self, scrapy_feedback): + """ + The method to set the value to scrapy_feedback + + Parameters: + scrapy_feedback (ScrapyFeedback) : An instance of ScrapyFeedback + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_feedback import ScrapyFeedback + except Exception: + from .scrapy_feedback import ScrapyFeedback + + if scrapy_feedback is not None and not isinstance(scrapy_feedback, ScrapyFeedback): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scrapy_feedback EXPECTED TYPE: ScrapyFeedback', None, None) + + self.__scrapy_feedback = scrapy_feedback + self.__key_modified['scrapy_feedback'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_feedback.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_feedback.py new file mode 100644 index 0000000..4d9d8c9 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_feedback.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ScrapyFeedback(object): + def __init__(self): + """Creates an instance of ScrapyFeedback""" + + self.__enrich_id = None + self.__type = None + self.__feedback = None + self.__comment = None + self.__key_modified = dict() + + def get_enrich_id(self): + """ + The method to get the enrich_id + + Returns: + Choice: An instance of Choice + """ + + return self.__enrich_id + + def set_enrich_id(self, enrich_id): + """ + The method to set the value to enrich_id + + Parameters: + enrich_id (Choice) : An instance of Choice + """ + + if enrich_id is not None and not isinstance(enrich_id, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_id EXPECTED TYPE: Choice', None, None) + + self.__enrich_id = enrich_id + self.__key_modified['enrich_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_feedback(self): + """ + The method to get the feedback + + Returns: + Choice: An instance of Choice + """ + + return self.__feedback + + def set_feedback(self, feedback): + """ + The method to set the value to feedback + + Parameters: + feedback (Choice) : An instance of Choice + """ + + if feedback is not None and not isinstance(feedback, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feedback EXPECTED TYPE: Choice', None, None) + + self.__feedback = feedback + self.__key_modified['feedback'] = 1 + + def get_comment(self): + """ + The method to get the comment + + Returns: + string: A string representing the comment + """ + + return self.__comment + + def set_comment(self, comment): + """ + The method to set the value to comment + + Parameters: + comment (string) : A string representing the comment + """ + + if comment is not None and not isinstance(comment, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comment EXPECTED TYPE: str', None, None) + + self.__comment = comment + self.__key_modified['comment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_success.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_success.py new file mode 100644 index 0000000..e182b36 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_success.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_action_response import ScrapyActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .scrapy_action_response import ScrapyActionResponse + + +class ScrapySuccess(ScrapyActionResponse): + def __init__(self): + """Creates an instance of ScrapySuccess""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/success_response.py new file mode 100644 index 0000000..79ed422 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/success_response.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SuccessResponse(object): + def __init__(self): + """Creates an instance of SuccessResponse""" + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/user.py new file mode 100644 index 0000000..65fd721 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/__init__.py new file mode 100644 index 0000000..22ce24d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .address import Address +from .zia_org_enrichment_operations import ZiaOrgEnrichmentOperations, GetZiaOrgEnrichmentsParam, CreateZiaOrgEnrichmentParam +from .description import Description +from .body_wrapper import BodyWrapper +from .industry import Industry +from .enrich_based_on import EnrichBasedOn +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .enriched_data import EnrichedData +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .zia_org_enrichment import ZiaOrgEnrichment +from .user import User +from .social_media import SocialMedia +from .info import Info diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_wrapper.py new file mode 100644 index 0000000..a873ed7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__ziaorgenrichment = None + self.__key_modified = dict() + + def get_ziaorgenrichment(self): + """ + The method to get the ziaorgenrichment + + Returns: + list: An instance of list + """ + + return self.__ziaorgenrichment + + def set_ziaorgenrichment(self, ziaorgenrichment): + """ + The method to set the value to ziaorgenrichment + + Parameters: + ziaorgenrichment (list) : An instance of list + """ + + if ziaorgenrichment is not None and not isinstance(ziaorgenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziaorgenrichment EXPECTED TYPE: list', None, None) + + self.__ziaorgenrichment = ziaorgenrichment + self.__key_modified['__zia_org_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/address.py new file mode 100644 index 0000000..708c4b7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__country = None + self.__city = None + self.__pin_code = None + self.__state = None + self.__fill_address = None + self.__key_modified = dict() + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.__country + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.__country = country + self.__key_modified['country'] = 1 + + def get_city(self): + """ + The method to get the city + + Returns: + string: A string representing the city + """ + + return self.__city + + def set_city(self, city): + """ + The method to set the value to city + + Parameters: + city (string) : A string representing the city + """ + + if city is not None and not isinstance(city, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: city EXPECTED TYPE: str', None, None) + + self.__city = city + self.__key_modified['city'] = 1 + + def get_pin_code(self): + """ + The method to get the pin_code + + Returns: + string: A string representing the pin_code + """ + + return self.__pin_code + + def set_pin_code(self, pin_code): + """ + The method to set the value to pin_code + + Parameters: + pin_code (string) : A string representing the pin_code + """ + + if pin_code is not None and not isinstance(pin_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pin_code EXPECTED TYPE: str', None, None) + + self.__pin_code = pin_code + self.__key_modified['pin_code'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_fill_address(self): + """ + The method to get the fill_address + + Returns: + string: A string representing the fill_address + """ + + return self.__fill_address + + def set_fill_address(self, fill_address): + """ + The method to set the value to fill_address + + Parameters: + fill_address (string) : A string representing the fill_address + """ + + if fill_address is not None and not isinstance(fill_address, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fill_address EXPECTED TYPE: str', None, None) + + self.__fill_address = fill_address + self.__key_modified['fill_address'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/api_exception.py new file mode 100644 index 0000000..4966e48 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/body_wrapper.py new file mode 100644 index 0000000..1647bca --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__ziaorgenrichment = None + self.__key_modified = dict() + + def get_ziaorgenrichment(self): + """ + The method to get the ziaorgenrichment + + Returns: + list: An instance of list + """ + + return self.__ziaorgenrichment + + def set_ziaorgenrichment(self, ziaorgenrichment): + """ + The method to set the value to ziaorgenrichment + + Parameters: + ziaorgenrichment (list) : An instance of list + """ + + if ziaorgenrichment is not None and not isinstance(ziaorgenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziaorgenrichment EXPECTED TYPE: list', None, None) + + self.__ziaorgenrichment = ziaorgenrichment + self.__key_modified['__zia_org_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/description.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/description.py new file mode 100644 index 0000000..552b37b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/description.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Description(object): + def __init__(self): + """Creates an instance of Description""" + + self.__title = None + self.__description = None + self.__key_modified = dict() + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enrich_based_on.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enrich_based_on.py new file mode 100644 index 0000000..fc3824d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enrich_based_on.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichBasedOn(object): + def __init__(self): + """Creates an instance of EnrichBasedOn""" + + self.__name = None + self.__email = None + self.__website = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enriched_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enriched_data.py new file mode 100644 index 0000000..1e5a4b7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enriched_data.py @@ -0,0 +1,724 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichedData(object): + def __init__(self): + """Creates an instance of EnrichedData""" + + self.__org_status = None + self.__description = None + self.__ceo = None + self.__secondary_email = None + self.__revenue = None + self.__years_in_industry = None + self.__other_contacts = None + self.__techno_graphic_data = None + self.__logo = None + self.__secondary_contact = None + self.__id = None + self.__other_emails = None + self.__sign_in = None + self.__website = None + self.__address = None + self.__sign_up = None + self.__org_type = None + self.__head_quarters = None + self.__no_of_employees = None + self.__territory_list = None + self.__founding_year = None + self.__industries = None + self.__name = None + self.__primary_email = None + self.__business_model = None + self.__primary_contact = None + self.__social_media = None + self.__key_modified = dict() + + def get_org_status(self): + """ + The method to get the org_status + + Returns: + string: A string representing the org_status + """ + + return self.__org_status + + def set_org_status(self, org_status): + """ + The method to set the value to org_status + + Parameters: + org_status (string) : A string representing the org_status + """ + + if org_status is not None and not isinstance(org_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_status EXPECTED TYPE: str', None, None) + + self.__org_status = org_status + self.__key_modified['org_status'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + list: An instance of list + """ + + return self.__description + + def set_description(self, description): + """ + The method to set the value to description + + Parameters: + description (list) : An instance of list + """ + + if description is not None and not isinstance(description, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: list', None, None) + + self.__description = description + self.__key_modified['description'] = 1 + + def get_ceo(self): + """ + The method to get the ceo + + Returns: + string: A string representing the ceo + """ + + return self.__ceo + + def set_ceo(self, ceo): + """ + The method to set the value to ceo + + Parameters: + ceo (string) : A string representing the ceo + """ + + if ceo is not None and not isinstance(ceo, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ceo EXPECTED TYPE: str', None, None) + + self.__ceo = ceo + self.__key_modified['ceo'] = 1 + + def get_secondary_email(self): + """ + The method to get the secondary_email + + Returns: + string: A string representing the secondary_email + """ + + return self.__secondary_email + + def set_secondary_email(self, secondary_email): + """ + The method to set the value to secondary_email + + Parameters: + secondary_email (string) : A string representing the secondary_email + """ + + if secondary_email is not None and not isinstance(secondary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secondary_email EXPECTED TYPE: str', None, None) + + self.__secondary_email = secondary_email + self.__key_modified['secondary_email'] = 1 + + def get_revenue(self): + """ + The method to get the revenue + + Returns: + string: A string representing the revenue + """ + + return self.__revenue + + def set_revenue(self, revenue): + """ + The method to set the value to revenue + + Parameters: + revenue (string) : A string representing the revenue + """ + + if revenue is not None and not isinstance(revenue, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: revenue EXPECTED TYPE: str', None, None) + + self.__revenue = revenue + self.__key_modified['revenue'] = 1 + + def get_years_in_industry(self): + """ + The method to get the years_in_industry + + Returns: + string: A string representing the years_in_industry + """ + + return self.__years_in_industry + + def set_years_in_industry(self, years_in_industry): + """ + The method to set the value to years_in_industry + + Parameters: + years_in_industry (string) : A string representing the years_in_industry + """ + + if years_in_industry is not None and not isinstance(years_in_industry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: years_in_industry EXPECTED TYPE: str', None, None) + + self.__years_in_industry = years_in_industry + self.__key_modified['years_in_industry'] = 1 + + def get_other_contacts(self): + """ + The method to get the other_contacts + + Returns: + list: An instance of list + """ + + return self.__other_contacts + + def set_other_contacts(self, other_contacts): + """ + The method to set the value to other_contacts + + Parameters: + other_contacts (list) : An instance of list + """ + + if other_contacts is not None and not isinstance(other_contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_contacts EXPECTED TYPE: list', None, None) + + self.__other_contacts = other_contacts + self.__key_modified['other_contacts'] = 1 + + def get_techno_graphic_data(self): + """ + The method to get the techno_graphic_data + + Returns: + string: A string representing the techno_graphic_data + """ + + return self.__techno_graphic_data + + def set_techno_graphic_data(self, techno_graphic_data): + """ + The method to set the value to techno_graphic_data + + Parameters: + techno_graphic_data (string) : A string representing the techno_graphic_data + """ + + if techno_graphic_data is not None and not isinstance(techno_graphic_data, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: techno_graphic_data EXPECTED TYPE: str', None, None) + + self.__techno_graphic_data = techno_graphic_data + self.__key_modified['techno_graphic_data'] = 1 + + def get_logo(self): + """ + The method to get the logo + + Returns: + string: A string representing the logo + """ + + return self.__logo + + def set_logo(self, logo): + """ + The method to set the value to logo + + Parameters: + logo (string) : A string representing the logo + """ + + if logo is not None and not isinstance(logo, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: logo EXPECTED TYPE: str', None, None) + + self.__logo = logo + self.__key_modified['logo'] = 1 + + def get_secondary_contact(self): + """ + The method to get the secondary_contact + + Returns: + string: A string representing the secondary_contact + """ + + return self.__secondary_contact + + def set_secondary_contact(self, secondary_contact): + """ + The method to set the value to secondary_contact + + Parameters: + secondary_contact (string) : A string representing the secondary_contact + """ + + if secondary_contact is not None and not isinstance(secondary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secondary_contact EXPECTED TYPE: str', None, None) + + self.__secondary_contact = secondary_contact + self.__key_modified['secondary_contact'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_other_emails(self): + """ + The method to get the other_emails + + Returns: + list: An instance of list + """ + + return self.__other_emails + + def set_other_emails(self, other_emails): + """ + The method to set the value to other_emails + + Parameters: + other_emails (list) : An instance of list + """ + + if other_emails is not None and not isinstance(other_emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_emails EXPECTED TYPE: list', None, None) + + self.__other_emails = other_emails + self.__key_modified['other_emails'] = 1 + + def get_sign_in(self): + """ + The method to get the sign_in + + Returns: + string: A string representing the sign_in + """ + + return self.__sign_in + + def set_sign_in(self, sign_in): + """ + The method to set the value to sign_in + + Parameters: + sign_in (string) : A string representing the sign_in + """ + + if sign_in is not None and not isinstance(sign_in, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_in EXPECTED TYPE: str', None, None) + + self.__sign_in = sign_in + self.__key_modified['sign_in'] = 1 + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_address(self): + """ + The method to get the address + + Returns: + list: An instance of list + """ + + return self.__address + + def set_address(self, address): + """ + The method to set the value to address + + Parameters: + address (list) : An instance of list + """ + + if address is not None and not isinstance(address, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: address EXPECTED TYPE: list', None, None) + + self.__address = address + self.__key_modified['address'] = 1 + + def get_sign_up(self): + """ + The method to get the sign_up + + Returns: + string: A string representing the sign_up + """ + + return self.__sign_up + + def set_sign_up(self, sign_up): + """ + The method to set the value to sign_up + + Parameters: + sign_up (string) : A string representing the sign_up + """ + + if sign_up is not None and not isinstance(sign_up, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_up EXPECTED TYPE: str', None, None) + + self.__sign_up = sign_up + self.__key_modified['sign_up'] = 1 + + def get_org_type(self): + """ + The method to get the org_type + + Returns: + string: A string representing the org_type + """ + + return self.__org_type + + def set_org_type(self, org_type): + """ + The method to set the value to org_type + + Parameters: + org_type (string) : A string representing the org_type + """ + + if org_type is not None and not isinstance(org_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_type EXPECTED TYPE: str', None, None) + + self.__org_type = org_type + self.__key_modified['org_type'] = 1 + + def get_head_quarters(self): + """ + The method to get the head_quarters + + Returns: + list: An instance of list + """ + + return self.__head_quarters + + def set_head_quarters(self, head_quarters): + """ + The method to set the value to head_quarters + + Parameters: + head_quarters (list) : An instance of list + """ + + if head_quarters is not None and not isinstance(head_quarters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: head_quarters EXPECTED TYPE: list', None, None) + + self.__head_quarters = head_quarters + self.__key_modified['head_quarters'] = 1 + + def get_no_of_employees(self): + """ + The method to get the no_of_employees + + Returns: + string: A string representing the no_of_employees + """ + + return self.__no_of_employees + + def set_no_of_employees(self, no_of_employees): + """ + The method to set the value to no_of_employees + + Parameters: + no_of_employees (string) : A string representing the no_of_employees + """ + + if no_of_employees is not None and not isinstance(no_of_employees, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: no_of_employees EXPECTED TYPE: str', None, None) + + self.__no_of_employees = no_of_employees + self.__key_modified['no_of_employees'] = 1 + + def get_territory_list(self): + """ + The method to get the territory_list + + Returns: + list: An instance of list + """ + + return self.__territory_list + + def set_territory_list(self, territory_list): + """ + The method to set the value to territory_list + + Parameters: + territory_list (list) : An instance of list + """ + + if territory_list is not None and not isinstance(territory_list, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory_list EXPECTED TYPE: list', None, None) + + self.__territory_list = territory_list + self.__key_modified['territory_list'] = 1 + + def get_founding_year(self): + """ + The method to get the founding_year + + Returns: + string: A string representing the founding_year + """ + + return self.__founding_year + + def set_founding_year(self, founding_year): + """ + The method to set the value to founding_year + + Parameters: + founding_year (string) : A string representing the founding_year + """ + + if founding_year is not None and not isinstance(founding_year, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: founding_year EXPECTED TYPE: str', None, None) + + self.__founding_year = founding_year + self.__key_modified['founding_year'] = 1 + + def get_industries(self): + """ + The method to get the industries + + Returns: + list: An instance of list + """ + + return self.__industries + + def set_industries(self, industries): + """ + The method to set the value to industries + + Parameters: + industries (list) : An instance of list + """ + + if industries is not None and not isinstance(industries, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: industries EXPECTED TYPE: list', None, None) + + self.__industries = industries + self.__key_modified['industries'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_primary_email(self): + """ + The method to get the primary_email + + Returns: + string: A string representing the primary_email + """ + + return self.__primary_email + + def set_primary_email(self, primary_email): + """ + The method to set the value to primary_email + + Parameters: + primary_email (string) : A string representing the primary_email + """ + + if primary_email is not None and not isinstance(primary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_email EXPECTED TYPE: str', None, None) + + self.__primary_email = primary_email + self.__key_modified['primary_email'] = 1 + + def get_business_model(self): + """ + The method to get the business_model + + Returns: + list: An instance of list + """ + + return self.__business_model + + def set_business_model(self, business_model): + """ + The method to set the value to business_model + + Parameters: + business_model (list) : An instance of list + """ + + if business_model is not None and not isinstance(business_model, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_model EXPECTED TYPE: list', None, None) + + self.__business_model = business_model + self.__key_modified['business_model'] = 1 + + def get_primary_contact(self): + """ + The method to get the primary_contact + + Returns: + string: A string representing the primary_contact + """ + + return self.__primary_contact + + def set_primary_contact(self, primary_contact): + """ + The method to set the value to primary_contact + + Parameters: + primary_contact (string) : A string representing the primary_contact + """ + + if primary_contact is not None and not isinstance(primary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_contact EXPECTED TYPE: str', None, None) + + self.__primary_contact = primary_contact + self.__key_modified['primary_contact'] = 1 + + def get_social_media(self): + """ + The method to get the social_media + + Returns: + list: An instance of list + """ + + return self.__social_media + + def set_social_media(self, social_media): + """ + The method to set the value to social_media + + Parameters: + social_media (list) : An instance of list + """ + + if social_media is not None and not isinstance(social_media, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: social_media EXPECTED TYPE: list', None, None) + + self.__social_media = social_media + self.__key_modified['social_media'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/industry.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/industry.py new file mode 100644 index 0000000..b3c742a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/industry.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Industry(object): + def __init__(self): + """Creates an instance of Industry""" + + self.__name = None + self.__description = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_wrapper.py new file mode 100644 index 0000000..d5d89ed --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__ziaorgenrichment = None + self.__info = None + self.__key_modified = dict() + + def get_ziaorgenrichment(self): + """ + The method to get the ziaorgenrichment + + Returns: + list: An instance of list + """ + + return self.__ziaorgenrichment + + def set_ziaorgenrichment(self, ziaorgenrichment): + """ + The method to set the value to ziaorgenrichment + + Parameters: + ziaorgenrichment (list) : An instance of list + """ + + if ziaorgenrichment is not None and not isinstance(ziaorgenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziaorgenrichment EXPECTED TYPE: list', None, None) + + self.__ziaorgenrichment = ziaorgenrichment + self.__key_modified['__zia_org_enrichment'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/social_media.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/social_media.py new file mode 100644 index 0000000..75f5791 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/social_media.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SocialMedia(object): + def __init__(self): + """Creates an instance of SocialMedia""" + + self.__media_type = None + self.__media_url = None + self.__key_modified = dict() + + def get_media_type(self): + """ + The method to get the media_type + + Returns: + string: A string representing the media_type + """ + + return self.__media_type + + def set_media_type(self, media_type): + """ + The method to set the value to media_type + + Parameters: + media_type (string) : A string representing the media_type + """ + + if media_type is not None and not isinstance(media_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_type EXPECTED TYPE: str', None, None) + + self.__media_type = media_type + self.__key_modified['media_type'] = 1 + + def get_media_url(self): + """ + The method to get the media_url + + Returns: + list: An instance of list + """ + + return self.__media_url + + def set_media_url(self, media_url): + """ + The method to set the value to media_url + + Parameters: + media_url (list) : An instance of list + """ + + if media_url is not None and not isinstance(media_url, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_url EXPECTED TYPE: list', None, None) + + self.__media_url = media_url + self.__key_modified['media_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/success_response.py new file mode 100644 index 0000000..619ff25 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment.py new file mode 100644 index 0000000..dd737c8 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment.py @@ -0,0 +1,214 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ZiaOrgEnrichment(object): + def __init__(self): + """Creates an instance of ZiaOrgEnrichment""" + + self.__enriched_data = None + self.__created_time = None + self.__id = None + self.__created_by = None + self.__status = None + self.__enrich_based_on = None + self.__key_modified = dict() + + def get_enriched_data(self): + """ + The method to get the enriched_data + + Returns: + EnrichedData: An instance of EnrichedData + """ + + return self.__enriched_data + + def set_enriched_data(self, enriched_data): + """ + The method to set the value to enriched_data + + Parameters: + enriched_data (EnrichedData) : An instance of EnrichedData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.enriched_data import EnrichedData + except Exception: + from .enriched_data import EnrichedData + + if enriched_data is not None and not isinstance(enriched_data, EnrichedData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enriched_data EXPECTED TYPE: EnrichedData', None, None) + + self.__enriched_data = enriched_data + self.__key_modified['enriched_data'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_enrich_based_on(self): + """ + The method to get the enrich_based_on + + Returns: + EnrichBasedOn: An instance of EnrichBasedOn + """ + + return self.__enrich_based_on + + def set_enrich_based_on(self, enrich_based_on): + """ + The method to set the value to enrich_based_on + + Parameters: + enrich_based_on (EnrichBasedOn) : An instance of EnrichBasedOn + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.enrich_based_on import EnrichBasedOn + except Exception: + from .enrich_based_on import EnrichBasedOn + + if enrich_based_on is not None and not isinstance(enrich_based_on, EnrichBasedOn): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_based_on EXPECTED TYPE: EnrichBasedOn', None, None) + + self.__enrich_based_on = enrich_based_on + self.__key_modified['enrich_based_on'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment_operations.py new file mode 100644 index 0000000..63e5d2c --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment_operations.py @@ -0,0 +1,139 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class ZiaOrgEnrichmentOperations(object): + def __init__(self): + """Creates an instance of ZiaOrgEnrichmentOperations""" + pass + + def get_zia_org_enrichments(self, param_instance=None): + """ + The method to get zia org enrichments + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/__zia_org_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_zia_org_enrichment(self, zia_org_enrichment_id): + """ + The method to get zia org enrichment + + Parameters: + zia_org_enrichment_id (int) : An int representing the zia_org_enrichment_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(zia_org_enrichment_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_org_enrichment_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__zia_org_enrichment/' + api_path = api_path + str(zia_org_enrichment_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_zia_org_enrichment(self, request, param_instance=None): + """ + The method to create zia org enrichment + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/__zia_org_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetZiaOrgEnrichmentsParam(object): + status = Param('status', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + page = Param('page', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + per_page = Param('per_page', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + + +class CreateZiaOrgEnrichmentParam(object): + module = Param('module', 'com.zoho.crm.api.ZiaOrgEnrichment.CreateZiaOrgEnrichmentParam') + record_id = Param('record_id', 'com.zoho.crm.api.ZiaOrgEnrichment.CreateZiaOrgEnrichmentParam') diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/__init__.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/__init__.py new file mode 100644 index 0000000..74825da --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/__init__.py @@ -0,0 +1,22 @@ +from .action_wrapper import ActionWrapper +from .address import Address +from .social import Social +from .email_info import EmailInfo +from .company_info import CompanyInfo +from .zia_people_enrichment import ZiaPeopleEnrichment +from .body_wrapper import BodyWrapper +from .industry import Industry +from .experience import Experience +from .enrich_based_on import EnrichBasedOn +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .zia_people_enrichment_operations import ZiaPeopleEnrichmentOperations, GetZiaPeopleEnrichmentsParam, CreateZiaPeopleEnrichmentParam +from .enriched_data import EnrichedData +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .company import Company +from .user import User +from .info import Info +from .social_media import SocialMedia diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_wrapper.py new file mode 100644 index 0000000..a32e96e --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__ziapeopleenrichment = None + self.__key_modified = dict() + + def get_ziapeopleenrichment(self): + """ + The method to get the ziapeopleenrichment + + Returns: + list: An instance of list + """ + + return self.__ziapeopleenrichment + + def set_ziapeopleenrichment(self, ziapeopleenrichment): + """ + The method to set the value to ziapeopleenrichment + + Parameters: + ziapeopleenrichment (list) : An instance of list + """ + + if ziapeopleenrichment is not None and not isinstance(ziapeopleenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziapeopleenrichment EXPECTED TYPE: list', None, None) + + self.__ziapeopleenrichment = ziapeopleenrichment + self.__key_modified['__zia_people_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/address.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/address.py new file mode 100644 index 0000000..8f6fa4a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__continent = None + self.__country = None + self.__name = None + self.__region = None + self.__primary = None + self.__key_modified = dict() + + def get_continent(self): + """ + The method to get the continent + + Returns: + string: A string representing the continent + """ + + return self.__continent + + def set_continent(self, continent): + """ + The method to set the value to continent + + Parameters: + continent (string) : A string representing the continent + """ + + if continent is not None and not isinstance(continent, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: continent EXPECTED TYPE: str', None, None) + + self.__continent = continent + self.__key_modified['continent'] = 1 + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.__country + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.__country = country + self.__key_modified['country'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_region(self): + """ + The method to get the region + + Returns: + string: A string representing the region + """ + + return self.__region + + def set_region(self, region): + """ + The method to set the value to region + + Parameters: + region (string) : A string representing the region + """ + + if region is not None and not isinstance(region, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: region EXPECTED TYPE: str', None, None) + + self.__region = region + self.__key_modified['region'] = 1 + + def get_primary(self): + """ + The method to get the primary + + Returns: + bool: A bool representing the primary + """ + + return self.__primary + + def set_primary(self, primary): + """ + The method to set the value to primary + + Parameters: + primary (bool) : A bool representing the primary + """ + + if primary is not None and not isinstance(primary, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary EXPECTED TYPE: bool', None, None) + + self.__primary = primary + self.__key_modified['primary'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/api_exception.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/api_exception.py new file mode 100644 index 0000000..a936be4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/body_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/body_wrapper.py new file mode 100644 index 0000000..01e2137 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__ziapeopleenrichment = None + self.__key_modified = dict() + + def get_ziapeopleenrichment(self): + """ + The method to get the ziapeopleenrichment + + Returns: + list: An instance of list + """ + + return self.__ziapeopleenrichment + + def set_ziapeopleenrichment(self, ziapeopleenrichment): + """ + The method to set the value to ziapeopleenrichment + + Parameters: + ziapeopleenrichment (list) : An instance of list + """ + + if ziapeopleenrichment is not None and not isinstance(ziapeopleenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziapeopleenrichment EXPECTED TYPE: list', None, None) + + self.__ziapeopleenrichment = ziapeopleenrichment + self.__key_modified['__zia_people_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company.py new file mode 100644 index 0000000..a8986a5 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Company(object): + def __init__(self): + """Creates an instance of Company""" + + self.__website = None + self.__name = None + self.__key_modified = dict() + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company_info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company_info.py new file mode 100644 index 0000000..602e9a4 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company_info.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CompanyInfo(object): + def __init__(self): + """Creates an instance of CompanyInfo""" + + self.__name = None + self.__industries = None + self.__experiences = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_industries(self): + """ + The method to get the industries + + Returns: + list: An instance of list + """ + + return self.__industries + + def set_industries(self, industries): + """ + The method to set the value to industries + + Parameters: + industries (list) : An instance of list + """ + + if industries is not None and not isinstance(industries, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: industries EXPECTED TYPE: list', None, None) + + self.__industries = industries + self.__key_modified['industries'] = 1 + + def get_experiences(self): + """ + The method to get the experiences + + Returns: + list: An instance of list + """ + + return self.__experiences + + def set_experiences(self, experiences): + """ + The method to set the value to experiences + + Parameters: + experiences (list) : An instance of list + """ + + if experiences is not None and not isinstance(experiences, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: experiences EXPECTED TYPE: list', None, None) + + self.__experiences = experiences + self.__key_modified['experiences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/email_info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/email_info.py new file mode 100644 index 0000000..55367c1 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/email_info.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailInfo(object): + def __init__(self): + """Creates an instance of EmailInfo""" + + self.__type = None + self.__email = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enrich_based_on.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enrich_based_on.py new file mode 100644 index 0000000..a2c8ca7 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enrich_based_on.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichBasedOn(object): + def __init__(self): + """Creates an instance of EnrichBasedOn""" + + self.__social = None + self.__name = None + self.__company = None + self.__email = None + self.__key_modified = dict() + + def get_social(self): + """ + The method to get the social + + Returns: + Social: An instance of Social + """ + + return self.__social + + def set_social(self, social): + """ + The method to set the value to social + + Parameters: + social (Social) : An instance of Social + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.social import Social + except Exception: + from .social import Social + + if social is not None and not isinstance(social, Social): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: social EXPECTED TYPE: Social', None, None) + + self.__social = social + self.__key_modified['social'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_company(self): + """ + The method to get the company + + Returns: + Company: An instance of Company + """ + + return self.__company + + def set_company(self, company): + """ + The method to set the value to company + + Parameters: + company (Company) : An instance of Company + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.company import Company + except Exception: + from .company import Company + + if company is not None and not isinstance(company, Company): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company EXPECTED TYPE: Company', None, None) + + self.__company = company + self.__key_modified['company'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enriched_data.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enriched_data.py new file mode 100644 index 0000000..3792c52 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enriched_data.py @@ -0,0 +1,559 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichedData(object): + def __init__(self): + """Creates an instance of EnrichedData""" + + self.__website = None + self.__email_infos = None + self.__gender = None + self.__company_info = None + self.__last_name = None + self.__educations = None + self.__middle_name = None + self.__skills = None + self.__other_contacts = None + self.__address_list_info = None + self.__primary_address_info = None + self.__name = None + self.__secondary_contact = None + self.__primary_email = None + self.__designation = None + self.__id = None + self.__interests = None + self.__first_name = None + self.__primary_contact = None + self.__social_media = None + self.__key_modified = dict() + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_email_infos(self): + """ + The method to get the email_infos + + Returns: + list: An instance of list + """ + + return self.__email_infos + + def set_email_infos(self, email_infos): + """ + The method to set the value to email_infos + + Parameters: + email_infos (list) : An instance of list + """ + + if email_infos is not None and not isinstance(email_infos, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_infos EXPECTED TYPE: list', None, None) + + self.__email_infos = email_infos + self.__key_modified['email_infos'] = 1 + + def get_gender(self): + """ + The method to get the gender + + Returns: + string: A string representing the gender + """ + + return self.__gender + + def set_gender(self, gender): + """ + The method to set the value to gender + + Parameters: + gender (string) : A string representing the gender + """ + + if gender is not None and not isinstance(gender, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: gender EXPECTED TYPE: str', None, None) + + self.__gender = gender + self.__key_modified['gender'] = 1 + + def get_company_info(self): + """ + The method to get the company_info + + Returns: + CompanyInfo: An instance of CompanyInfo + """ + + return self.__company_info + + def set_company_info(self, company_info): + """ + The method to set the value to company_info + + Parameters: + company_info (CompanyInfo) : An instance of CompanyInfo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.company_info import CompanyInfo + except Exception: + from .company_info import CompanyInfo + + if company_info is not None and not isinstance(company_info, CompanyInfo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company_info EXPECTED TYPE: CompanyInfo', None, None) + + self.__company_info = company_info + self.__key_modified['company_info'] = 1 + + def get_last_name(self): + """ + The method to get the last_name + + Returns: + string: A string representing the last_name + """ + + return self.__last_name + + def set_last_name(self, last_name): + """ + The method to set the value to last_name + + Parameters: + last_name (string) : A string representing the last_name + """ + + if last_name is not None and not isinstance(last_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_name EXPECTED TYPE: str', None, None) + + self.__last_name = last_name + self.__key_modified['last_name'] = 1 + + def get_educations(self): + """ + The method to get the educations + + Returns: + list: An instance of list + """ + + return self.__educations + + def set_educations(self, educations): + """ + The method to set the value to educations + + Parameters: + educations (list) : An instance of list + """ + + if educations is not None and not isinstance(educations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: educations EXPECTED TYPE: list', None, None) + + self.__educations = educations + self.__key_modified['educations'] = 1 + + def get_middle_name(self): + """ + The method to get the middle_name + + Returns: + string: A string representing the middle_name + """ + + return self.__middle_name + + def set_middle_name(self, middle_name): + """ + The method to set the value to middle_name + + Parameters: + middle_name (string) : A string representing the middle_name + """ + + if middle_name is not None and not isinstance(middle_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: middle_name EXPECTED TYPE: str', None, None) + + self.__middle_name = middle_name + self.__key_modified['middle_name'] = 1 + + def get_skills(self): + """ + The method to get the skills + + Returns: + list: An instance of list + """ + + return self.__skills + + def set_skills(self, skills): + """ + The method to set the value to skills + + Parameters: + skills (list) : An instance of list + """ + + if skills is not None and not isinstance(skills, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: skills EXPECTED TYPE: list', None, None) + + self.__skills = skills + self.__key_modified['skills'] = 1 + + def get_other_contacts(self): + """ + The method to get the other_contacts + + Returns: + list: An instance of list + """ + + return self.__other_contacts + + def set_other_contacts(self, other_contacts): + """ + The method to set the value to other_contacts + + Parameters: + other_contacts (list) : An instance of list + """ + + if other_contacts is not None and not isinstance(other_contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_contacts EXPECTED TYPE: list', None, None) + + self.__other_contacts = other_contacts + self.__key_modified['other_contacts'] = 1 + + def get_address_list_info(self): + """ + The method to get the address_list_info + + Returns: + list: An instance of list + """ + + return self.__address_list_info + + def set_address_list_info(self, address_list_info): + """ + The method to set the value to address_list_info + + Parameters: + address_list_info (list) : An instance of list + """ + + if address_list_info is not None and not isinstance(address_list_info, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: address_list_info EXPECTED TYPE: list', None, None) + + self.__address_list_info = address_list_info + self.__key_modified['address_list_info'] = 1 + + def get_primary_address_info(self): + """ + The method to get the primary_address_info + + Returns: + Address: An instance of Address + """ + + return self.__primary_address_info + + def set_primary_address_info(self, primary_address_info): + """ + The method to set the value to primary_address_info + + Parameters: + primary_address_info (Address) : An instance of Address + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.address import Address + except Exception: + from .address import Address + + if primary_address_info is not None and not isinstance(primary_address_info, Address): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_address_info EXPECTED TYPE: Address', None, None) + + self.__primary_address_info = primary_address_info + self.__key_modified['primary_address_info'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_secondary_contact(self): + """ + The method to get the secondary_contact + + Returns: + string: A string representing the secondary_contact + """ + + return self.__secondary_contact + + def set_secondary_contact(self, secondary_contact): + """ + The method to set the value to secondary_contact + + Parameters: + secondary_contact (string) : A string representing the secondary_contact + """ + + if secondary_contact is not None and not isinstance(secondary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secondary_contact EXPECTED TYPE: str', None, None) + + self.__secondary_contact = secondary_contact + self.__key_modified['secondary_contact'] = 1 + + def get_primary_email(self): + """ + The method to get the primary_email + + Returns: + string: A string representing the primary_email + """ + + return self.__primary_email + + def set_primary_email(self, primary_email): + """ + The method to set the value to primary_email + + Parameters: + primary_email (string) : A string representing the primary_email + """ + + if primary_email is not None and not isinstance(primary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_email EXPECTED TYPE: str', None, None) + + self.__primary_email = primary_email + self.__key_modified['primary_email'] = 1 + + def get_designation(self): + """ + The method to get the designation + + Returns: + string: A string representing the designation + """ + + return self.__designation + + def set_designation(self, designation): + """ + The method to set the value to designation + + Parameters: + designation (string) : A string representing the designation + """ + + if designation is not None and not isinstance(designation, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: designation EXPECTED TYPE: str', None, None) + + self.__designation = designation + self.__key_modified['designation'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_interests(self): + """ + The method to get the interests + + Returns: + list: An instance of list + """ + + return self.__interests + + def set_interests(self, interests): + """ + The method to set the value to interests + + Parameters: + interests (list) : An instance of list + """ + + if interests is not None and not isinstance(interests, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: interests EXPECTED TYPE: list', None, None) + + self.__interests = interests + self.__key_modified['interests'] = 1 + + def get_first_name(self): + """ + The method to get the first_name + + Returns: + string: A string representing the first_name + """ + + return self.__first_name + + def set_first_name(self, first_name): + """ + The method to set the value to first_name + + Parameters: + first_name (string) : A string representing the first_name + """ + + if first_name is not None and not isinstance(first_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_name EXPECTED TYPE: str', None, None) + + self.__first_name = first_name + self.__key_modified['first_name'] = 1 + + def get_primary_contact(self): + """ + The method to get the primary_contact + + Returns: + string: A string representing the primary_contact + """ + + return self.__primary_contact + + def set_primary_contact(self, primary_contact): + """ + The method to set the value to primary_contact + + Parameters: + primary_contact (string) : A string representing the primary_contact + """ + + if primary_contact is not None and not isinstance(primary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_contact EXPECTED TYPE: str', None, None) + + self.__primary_contact = primary_contact + self.__key_modified['primary_contact'] = 1 + + def get_social_media(self): + """ + The method to get the social_media + + Returns: + list: An instance of list + """ + + return self.__social_media + + def set_social_media(self, social_media): + """ + The method to set the value to social_media + + Parameters: + social_media (list) : An instance of list + """ + + if social_media is not None and not isinstance(social_media, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: social_media EXPECTED TYPE: list', None, None) + + self.__social_media = social_media + self.__key_modified['social_media'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/experience.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/experience.py new file mode 100644 index 0000000..7d41c13 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/experience.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Experience(object): + def __init__(self): + """Creates an instance of Experience""" + + self.__end_date = None + self.__company_name = None + self.__title = None + self.__start_date = None + self.__primary = None + self.__key_modified = dict() + + def get_end_date(self): + """ + The method to get the end_date + + Returns: + string: A string representing the end_date + """ + + return self.__end_date + + def set_end_date(self, end_date): + """ + The method to set the value to end_date + + Parameters: + end_date (string) : A string representing the end_date + """ + + if end_date is not None and not isinstance(end_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: end_date EXPECTED TYPE: str', None, None) + + self.__end_date = end_date + self.__key_modified['end_date'] = 1 + + def get_company_name(self): + """ + The method to get the company_name + + Returns: + string: A string representing the company_name + """ + + return self.__company_name + + def set_company_name(self, company_name): + """ + The method to set the value to company_name + + Parameters: + company_name (string) : A string representing the company_name + """ + + if company_name is not None and not isinstance(company_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company_name EXPECTED TYPE: str', None, None) + + self.__company_name = company_name + self.__key_modified['company_name'] = 1 + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_start_date(self): + """ + The method to get the start_date + + Returns: + string: A string representing the start_date + """ + + return self.__start_date + + def set_start_date(self, start_date): + """ + The method to set the value to start_date + + Parameters: + start_date (string) : A string representing the start_date + """ + + if start_date is not None and not isinstance(start_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_date EXPECTED TYPE: str', None, None) + + self.__start_date = start_date + self.__key_modified['start_date'] = 1 + + def get_primary(self): + """ + The method to get the primary + + Returns: + bool: A bool representing the primary + """ + + return self.__primary + + def set_primary(self, primary): + """ + The method to set the value to primary + + Parameters: + primary (bool) : A bool representing the primary + """ + + if primary is not None and not isinstance(primary, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary EXPECTED TYPE: bool', None, None) + + self.__primary = primary + self.__key_modified['primary'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/industry.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/industry.py new file mode 100644 index 0000000..b3c742a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/industry.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Industry(object): + def __init__(self): + """Creates an instance of Industry""" + + self.__name = None + self.__description = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/info.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_handler.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_wrapper.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_wrapper.py new file mode 100644 index 0000000..8302985 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__ziapeopleenrichment = None + self.__info = None + self.__key_modified = dict() + + def get_ziapeopleenrichment(self): + """ + The method to get the ziapeopleenrichment + + Returns: + list: An instance of list + """ + + return self.__ziapeopleenrichment + + def set_ziapeopleenrichment(self, ziapeopleenrichment): + """ + The method to set the value to ziapeopleenrichment + + Parameters: + ziapeopleenrichment (list) : An instance of list + """ + + if ziapeopleenrichment is not None and not isinstance(ziapeopleenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziapeopleenrichment EXPECTED TYPE: list', None, None) + + self.__ziapeopleenrichment = ziapeopleenrichment + self.__key_modified['__zia_people_enrichment'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social.py new file mode 100644 index 0000000..1b02f22 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Social(object): + def __init__(self): + """Creates an instance of Social""" + + self.__twitter = None + self.__facebook = None + self.__linkedin = None + self.__key_modified = dict() + + def get_twitter(self): + """ + The method to get the twitter + + Returns: + string: A string representing the twitter + """ + + return self.__twitter + + def set_twitter(self, twitter): + """ + The method to set the value to twitter + + Parameters: + twitter (string) : A string representing the twitter + """ + + if twitter is not None and not isinstance(twitter, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: twitter EXPECTED TYPE: str', None, None) + + self.__twitter = twitter + self.__key_modified['twitter'] = 1 + + def get_facebook(self): + """ + The method to get the facebook + + Returns: + string: A string representing the facebook + """ + + return self.__facebook + + def set_facebook(self, facebook): + """ + The method to set the value to facebook + + Parameters: + facebook (string) : A string representing the facebook + """ + + if facebook is not None and not isinstance(facebook, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: facebook EXPECTED TYPE: str', None, None) + + self.__facebook = facebook + self.__key_modified['facebook'] = 1 + + def get_linkedin(self): + """ + The method to get the linkedin + + Returns: + string: A string representing the linkedin + """ + + return self.__linkedin + + def set_linkedin(self, linkedin): + """ + The method to set the value to linkedin + + Parameters: + linkedin (string) : A string representing the linkedin + """ + + if linkedin is not None and not isinstance(linkedin, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linkedin EXPECTED TYPE: str', None, None) + + self.__linkedin = linkedin + self.__key_modified['linkedin'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social_media.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social_media.py new file mode 100644 index 0000000..75f5791 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social_media.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SocialMedia(object): + def __init__(self): + """Creates an instance of SocialMedia""" + + self.__media_type = None + self.__media_url = None + self.__key_modified = dict() + + def get_media_type(self): + """ + The method to get the media_type + + Returns: + string: A string representing the media_type + """ + + return self.__media_type + + def set_media_type(self, media_type): + """ + The method to set the value to media_type + + Parameters: + media_type (string) : A string representing the media_type + """ + + if media_type is not None and not isinstance(media_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_type EXPECTED TYPE: str', None, None) + + self.__media_type = media_type + self.__key_modified['media_type'] = 1 + + def get_media_url(self): + """ + The method to get the media_url + + Returns: + list: An instance of list + """ + + return self.__media_url + + def set_media_url(self, media_url): + """ + The method to set the value to media_url + + Parameters: + media_url (list) : An instance of list + """ + + if media_url is not None and not isinstance(media_url, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_url EXPECTED TYPE: list', None, None) + + self.__media_url = media_url + self.__key_modified['media_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/success_response.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/success_response.py new file mode 100644 index 0000000..011001a --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/user.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment.py new file mode 100644 index 0000000..c3e2ccc --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment.py @@ -0,0 +1,214 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ZiaPeopleEnrichment(object): + def __init__(self): + """Creates an instance of ZiaPeopleEnrichment""" + + self.__created_time = None + self.__id = None + self.__created_by = None + self.__status = None + self.__enriched_data = None + self.__enrich_based_on = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_enriched_data(self): + """ + The method to get the enriched_data + + Returns: + EnrichedData: An instance of EnrichedData + """ + + return self.__enriched_data + + def set_enriched_data(self, enriched_data): + """ + The method to set the value to enriched_data + + Parameters: + enriched_data (EnrichedData) : An instance of EnrichedData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.enriched_data import EnrichedData + except Exception: + from .enriched_data import EnrichedData + + if enriched_data is not None and not isinstance(enriched_data, EnrichedData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enriched_data EXPECTED TYPE: EnrichedData', None, None) + + self.__enriched_data = enriched_data + self.__key_modified['enriched_data'] = 1 + + def get_enrich_based_on(self): + """ + The method to get the enrich_based_on + + Returns: + EnrichBasedOn: An instance of EnrichBasedOn + """ + + return self.__enrich_based_on + + def set_enrich_based_on(self, enrich_based_on): + """ + The method to set the value to enrich_based_on + + Parameters: + enrich_based_on (EnrichBasedOn) : An instance of EnrichBasedOn + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.enrich_based_on import EnrichBasedOn + except Exception: + from .enrich_based_on import EnrichBasedOn + + if enrich_based_on is not None and not isinstance(enrich_based_on, EnrichBasedOn): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_based_on EXPECTED TYPE: EnrichBasedOn', None, None) + + self.__enrich_based_on = enrich_based_on + self.__key_modified['enrich_based_on'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment_operations.py b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment_operations.py new file mode 100644 index 0000000..f24a50d --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment_operations.py @@ -0,0 +1,140 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class ZiaPeopleEnrichmentOperations(object): + def __init__(self): + """Creates an instance of ZiaPeopleEnrichmentOperations""" + pass + + def get_zia_people_enrichments(self, param_instance=None): + """ + The method to get zia people enrichments + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/__zia_people_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_zia_people_enrichment(self, zia_people_enrichment_id): + """ + The method to get zia people enrichment + + Parameters: + zia_people_enrichment_id (int) : An int representing the zia_people_enrichment_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(zia_people_enrichment_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_people_enrichment_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__zia_people_enrichment/' + api_path = api_path + str(zia_people_enrichment_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_zia_people_enrichment(self, request, param_instance=None): + """ + The method to create zia people enrichment + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/__zia_people_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetZiaPeopleEnrichmentsParam(object): + status = Param('status', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + page = Param('page', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + per_page = Param('per_page', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + count = Param('count', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + + +class CreateZiaPeopleEnrichmentParam(object): + module = Param('module', 'com.zoho.crm.api.ZiaPeopleEnrichment.CreateZiaPeopleEnrichmentParam') + record_id = Param('record_id', 'com.zoho.crm.api.ZiaPeopleEnrichment.CreateZiaPeopleEnrichmentParam') diff --git a/versions/1.0.0/zohocrmsdk/src/json_details.json b/versions/1.0.0/zohocrmsdk/src/json_details.json new file mode 100644 index 0000000..1170db6 --- /dev/null +++ b/versions/1.0.0/zohocrmsdk/src/json_details.json @@ -0,0 +1 @@ +{"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Data":{"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Template","request_supported":["action","create","delete","read","update"],"name":"template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Template","unique_for":"none","structure":true},"data_subject_request":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest","request_supported":["action","create","delete","read","update"],"name":"data_subject_request","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest","unique_for":"none","structure":true},"bcc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc"},"request_supported":["action","create","delete","read","update"],"name":"bcc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mail_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["html","text"],"name":"mail_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"scheduled_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduled_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"in_reply_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo","request_supported":["action","create","delete","read","update"],"name":"in_reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo","unique_for":"none","structure":true},"consent_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord","unique_for":"none","structure":true},"org_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"org_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"from_1":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.From","request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.From","unique_for":"none","structure":true},"reply_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To","request_supported":["action","create","delete","read","update"],"name":"reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To","unique_for":"none","structure":true},"inventory_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails","request_supported":["action","create","delete","read","update"],"name":"inventory_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails","unique_for":"none","structure":true},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail":{"result":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result","request_supported":["action","create","delete","read","update"],"name":"result","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["csv"],"name":"file_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"query":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","request_supported":["action","create","delete","read","update"],"name":"query","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","IN PROGRESS","ADDED","FAILURE"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"operation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["cvid","id","Owner"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found","the cvid given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseWrapper":{"associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.GetDeletedRecordsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseWrapper":{"currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency"},"request_supported":["action","create","delete","read","update"],"name":"currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.coql.ClauseDetails":{"clause":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clause","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.GetAppointmentRescheduledHistoryParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException","zohocrmsdk.src.com.zoho.crm.api.custom_views.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.roles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseWrapper":{"shift_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount","request_supported":["action","create","delete","read","update"],"name":"shift_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount","unique_for":"none","structure":true},"shift_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours"},"request_supported":["action","create","delete","read","update"],"name":"shift_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineWrapper":{"transfer_pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline"},"request_supported":["action","create","delete","read","update"],"name":"transfer_pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portals.ResponseWrapper":{"portals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals"},"request_supported":["action","create","delete","read","update"],"name":"portals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Tax":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask":{"open_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"open_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"failed_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"completed_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"completed_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"created_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status":{"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"not_converted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Not_Converted_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"converted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Converted_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseWrapper":{"transfer_and_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionWrapper":{"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseWrapper":{"emails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email"},"request_supported":["action","create","delete","read","update"],"name":"Emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.GetAssociatedContactRolesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields"},"request_supported":["action","create","delete","read","update"],"name":"show_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"revalidate_filter_during_edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"revalidate_filter_during_edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"query_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","request_supported":["action","create","delete","read","update"],"name":"query_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CreateDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.BodyWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"defaultview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","request_supported":["action","create","delete","read","update"],"name":"_default_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.territory_users.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.RecordCountParam":{"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"word":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"word","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionWrapper":{"emaildrafts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__email_drafts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.ActionWrapper":{"backup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"backup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.backup.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordsUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.BodyWrapper":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.Record":{"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","RECORD_NOT_IN_PROCESS","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"info_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","invalid transition","invalid data","record not in process"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionWrapper":{"get_unassigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionResponse","request_supported":["action","create","delete","read","update"],"name":"get_unassigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Shift":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result":{"download_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"download_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionWrapper":{"appointment_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"appointment_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["active","inactive","deleted"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Fields":{"associated_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"associated_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"operation_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","request_supported":["action","create","delete","read","update"],"name":"operation_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","unique_for":"none","structure":true},"updateexistingrecords":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_update_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"colour_code_enabled_by_system":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code_enabled_by_system","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","unique_for":"none","structure":true},"textarea":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","request_supported":["action","create","delete","read","update"],"name":"textarea","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customizable_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"customizable_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","unique_for":"none","structure":true},"businesscard_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"businesscard_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"sharing_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","request_supported":["action","create","delete","read","update"],"name":"sharing_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"refer_from_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","request_supported":["action","create","delete","read","update"],"name":"refer_from_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","unique_for":"none","structure":true},"subform":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","request_supported":["action","create","delete","read","update"],"name":"subform","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","unique_for":"none","structure":true},"separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"searchable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"searchable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"virtual_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"virtual_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"auto_number_61":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"allowed_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"allowed_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_upolad_optionlist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption"},"request_supported":["action","create","delete","read","update"],"name":"file_upolad_optionlist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email_parser":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","request_supported":["action","create","delete","read","update"],"name":"email_parser","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","unique_for":"none","structure":true},"multiuserlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiuserlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","unique_for":"none","structure":true},"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","unique_for":"none","structure":true},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","unique_for":"none","structure":true},"rollup_summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","request_supported":["action","create","delete","read","update"],"name":"rollup_summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","unique_for":"none","structure":true},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"global_picklist":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"autonumber":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"autonumber","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","unique_for":"none","structure":true},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","unique_for":"none","structure":true},"additional_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"additional_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"static_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"static_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"mass_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mass_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"blueprint_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"blueprint_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.RemindAt":{"alarm":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ALARM","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_DATA","INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["tags created successfully","tags updated successfully","tags deleted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.UpdatePipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.RecordSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details":{"template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template","request_supported":["action","create","delete","read","update"],"name":"template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroupsWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.Backup":{"requester":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","request_supported":["action","create","delete","read","update"],"name":"requester","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","unique_for":"none","structure":true},"rrule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rrule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"scheduled_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduled_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"start_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["equal","not_equal","in","not_in","less_than","less_equal","greater_than","greater_equal","contains","not_contains","starts_with","ends_with","between","not_between"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["and","or"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territory_users.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.associate_email.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.GetAssignmentRulesParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DeleteRelatedRecordsUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INTERNAL_SERVER_ERROR","UNABLE_TO_PARSE_DATA_TYPE","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","either the request body or parameters is in wrong format","One of the expected parameter is missing"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social":{"twitter":{"regex":"https[:][/][/]twitter[.]com[/][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"twitter","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"facebook":{"regex":"https[:][/][/]facebook[.]com[/][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"facebook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linkedin":{"regex":"https[:][/][/]linkedin[.]com[/][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"linkedin","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.DeleteNotificationParam":{"channel_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_hour":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","request_supported":["action","create","delete","read","update"],"name":"shift_hour","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.BodyWrapper":{"body":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"body","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.ResponseWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress":{"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NOT_APPROVED","LIMIT_EXCEEDED","REQUIRED_PARAM_MISSING","ID_ALREADY_CONVERTED","EXPECTED_FIELD_MISSING","NOT_REVIEWED","AMBIGUITY_DURING_PROCESSING","MANDATORY_NOT_FOUND","NO_PERMISSION"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[50],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","id already converted","required field not found","Specify atleast one field"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DeleteDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"report_link","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.Dependee":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","NO_PERMISSION","INVALID_URL_PATTERN","REQUIRED_PARAM_MISSING","INVALID_TOKEN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the user doesn't have permission for that module.","Please check if the URL trying to access is a correct one.","One of the expected parameter is missing.","the module name given seems to be invalid."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionWrapper":{"service_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"service_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.GetMapDependenciesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"module":{"name":"module","type":"String","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","unique_for":"none","structure":true},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties":{"scheduler_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduler_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"share_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["full-access","read-write","read-only"],"name":"share_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"share_preference_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_preference_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseWrapper":{"share":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord"},"request_supported":["action","create","delete","read","update"],"name":"share","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"shareable_user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"shareable_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["FILE_UPLOAD_SUCCESS","SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["file uploaded.","success"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status":{"updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"not_updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Not_Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","RUNNING","FAILED"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.backup.HISTORYParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ALREADY_ENABLED","INTERNAL_SERVER_ERROR","INVALID_DATA","OAUTH_SCOPE_MISMATCH","FEATURE_NOT_ENABLED","NOT_ALLOWED","ACTIVE_STATE_LIMIT_EXCEEDED","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","DUPLICATE_DATA","LIMIT_EXCEEDED","MANDATORY_NOT_FOUND","CURRENCIES_NOT_ENABLED","FEATURE_NOT_SUPPORTED","No Content","BAD_REQUEST","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"related_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one.","The http request method type is not a valid one","The module name given seems to be invalid","The multi-currency is already enabled","Currency name is invalid.","ISO code is invalid.","Currency symbol is invalid.","The multi-currency feature is not available except the Enterprise and higher editions.","required field not found","unable to process your request. please verify whether you have entered proper method name"," parameter and parameter values.","Currency symbol is invalid.","Multi currency is not enabled","No Content","Currency id is invalid."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.BodyWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.GetShiftHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.UpdateRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.contact_roles.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNoteParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.backup.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.UrlsWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.HistoryWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.modules.Modules":{"global_search_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_search_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"activity_badge":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Enabled","Disabled"],"name":"activity_badge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"zia_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zia_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layouts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"recycle_bin_on_delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"recycle_bin_on_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"email_parser_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_parser_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"business_card_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"business_card_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"inventory_template_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"inventory_template_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"track_current_data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"track_current_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"presence_sub_menu":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"presence_sub_menu","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"chart_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"chart_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"triggers_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"triggers_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sub_menu_available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sub_menu_available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"visibility":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visibility","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"static_subform_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties","request_supported":["action","create","delete","read","update"],"name":"static_subform_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"filter_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filter_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"kanban_view_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"kanban_view_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"web_link":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"web_link","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"lookup_field_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties","request_supported":["action","create","delete","read","update"],"name":"lookup_field_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties","unique_for":"none","structure":true},"viewable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"viewable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"emailtemplate_support":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"emailTemplate_support","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"chart_view_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"chart_view_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"parent_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"parent_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"custom_view":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","request_supported":["action","create","delete","read","update"],"name":"custom_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"has_more_profiles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_more_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"kanban_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"kanban_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_states":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$field_states","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"related_lists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList"},"request_supported":["action","create","delete","read","update"],"name":"related_lists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"deletable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deletable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":255},"creatable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"creatable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"filter_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filter_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"related_list_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties","request_supported":["action","create","delete","read","update"],"name":"related_list_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties","unique_for":"none","structure":true},"isblueprintsupported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isBlueprintSupported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"default_mapping_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField"},"request_supported":["action","create","delete","read","update"],"name":"default_mapping_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"convertable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"convertable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_as_tab":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_as_tab","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"search_layout_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"search_layout_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"singular_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"singular_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"quick_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"on_demand_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$on_demand_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"generated_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["default","web","custom","linking"],"name":"generated_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"feeds_required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feeds_required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"scoring_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scoring_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"webform_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webform_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"arguments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Argument","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Argument"},"request_supported":["action","create","delete","read","update"],"name":"arguments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"profile_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"profile_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"business_card_field_limit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"business_card_field_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reference_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reference_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.MassWrapper":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notes.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Section":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"categories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Category","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Category"},"request_supported":["action","create","delete","read","update"],"name":"categories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming":{"break_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"LocalTime"},"request_supported":["action","create","delete","read","update"],"name":"break_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.DeassociateTerritoryUsersParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Formula":{"return_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expression":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expression","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionWrapper":{"custom_views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"custom_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.GetEmailsRelatedRecordsParam":{"filter":{"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria","name":"filter","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria","structure":true},"owner_id":{"name":"owner_id","type":"Long","structure":false},"index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"name":"type","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData":{"crm_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","request_supported":["action","create","delete","read","update"],"name":"crm_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","unique_for":"none","structure":true},"enrich_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","request_supported":["action","create","delete","read","update"],"name":"enrich_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionWrapper":{"send_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"send_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException","zohocrmsdk.src.com.zoho.crm.api.global_picklists.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.FileHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.profiles.DeleteProfileParam":{"transfer_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_to","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS","SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink":{"transfer_to_user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser","request_supported":["action","create","delete","read","update"],"name":"transfer_to_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionWrapper":{"share":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"share","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeleteTerritoryParam":{"delete_previous_forecasts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_previous_forecasts","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.DeleteFieldParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"deleted_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"deleted_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"deleted_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionWrapper":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ResponseWrapper":{"record_locking_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock"},"request_supported":["action","create","delete","read","update"],"name":"record_locking_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference":{"allow_booking_outside_businesshours":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allow_booking_outside_businesshours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"deal_record_configuration":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration","request_supported":["action","create","delete","read","update"],"name":"deal_record_configuration","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration","unique_for":"none","structure":true},"show_job_sheet":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_job_sheet","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"when_duration_exceeds":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"when_duration_exceeds","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"when_appointment_completed":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["do_not_create_deal","create_deal"],"name":"when_appointment_completed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"allow_booking_outside_service_availability":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allow_booking_outside_service_availability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.GetEntityScoresParam":{"cvid":{"name":"cvid","type":"String","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"name":"fields","type":"String","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeleteTerritoriesParam":{"delete_previous_forecasts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_previous_forecasts","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseWrapper":{"variable_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup"},"request_supported":["action","create","delete","read","update"],"name":"variable_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.Territory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.CreateRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseWrapper":{"service_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","request_supported":["action","create","delete","read","update"],"name":"service_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.Summary":{"task_follow_up_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"task_follow_up_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"call_follow_up_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call_follow_up_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"email_follow_up_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_follow_up_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser":{"user_group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup","request_supported":["action","create","delete","read","update"],"name":"user_group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup","unique_for":"none","structure":true},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue","request_supported":["action","create","delete","read","update"],"name":"_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData":{"iframe_url_tracking_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iframe_url_tracking_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"url_analytics_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"url_analytics_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"analytics_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"analytics_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"analytics_enabled_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"analytics_enabled_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"tracking_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tracking_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseWrapper":{"blueprint":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","request_supported":["action","create","delete","read","update"],"name":"blueprint","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.templates.Folder":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Template":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["profile created successfully","profile updated successfully","Profile deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Users":{"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name_format__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Salutation,First Name,Last Name","Saluation,Last Name,First Name","First Name,Last Name,Saluation"],"name":"name_format__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"language":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"language","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Reporting_To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_time_9":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"microsoft":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"microsoft","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sandboxdeveloper":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sandboxDeveloper","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"isonline":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Isonline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"fax":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fax","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"country_locale":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country_locale","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"imap_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"imap_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"zip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"decimal_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Comma","Period"],"name":"decimal_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"created_by_17":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"current_shift":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","request_supported":["action","create","delete","read","update"],"name":"$current_shift","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","unique_for":"none","structure":true},"time_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["HH:mm","hh:mm a"],"name":"time_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"image_link":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"image_link","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"offset":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"offset","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_shift":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","request_supported":["action","create","delete","read","update"],"name":"$next_shift","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","unique_for":"none","structure":true},"profile":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Profile","request_supported":["action","create","delete","read","update"],"name":"profile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Profile","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ezuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ezuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"full_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"full_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"dob":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"dob","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order_preference__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order_preference__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"role":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Role","request_supported":["action","create","delete","read","update"],"name":"role","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Role","unique_for":"none","structure":true},"customize_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo","request_supported":["action","create","delete","read","update"],"name":"customize_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo","unique_for":"none","structure":true},"city":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"city","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"signature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order_preference":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_effective_from":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$shift_effective_from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"locale":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locale","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"personal_account":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personal_account","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"ntc_notification_type":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ntc_notification_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"default_tab_group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_tab_group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"street":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"street","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"alias":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"alias","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"currency":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"theme":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Theme","request_supported":["action","create","delete","read","update"],"name":"theme","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Theme","unique_for":"none","structure":true},"first_name":{"regex":"[A-Za-z0-9]","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":50},"email":{"regex":"[a-z0-9]{9}[@][a-z0-9]{5}[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"telephony_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"telephony_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"status_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status_reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"website":{"regex":"[a-z0-9]{5}[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mobile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mobile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_name":{"regex":"[A-Za-z0-9]","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":50},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Space"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"time_zone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time_zone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TTimeZone","nullable_for":"none","type":"TimeZone","unique_for":"none","structure":false},"confirm":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"confirm","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"rtl_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rtl_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"date_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MMM d, yyyy"],"name":"date_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ntc_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ntc_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.features.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.features.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"presence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"presence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"actual_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails":{"query_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"query_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"quick_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ChangeSortOrderOfCustomViewParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.business_hours.UpdateBusinessHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_REQUEST","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ResponseWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","NOT_ALLOWED","DUPLICATE_DATA","LIMIT_EXCEEDED","DEPENDENT_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency":{"symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"is_active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"exchange_rate":{"regex":"[1-9][0-9]{1,8}[.][0-9]{9}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exchange_rate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"format":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","request_supported":["action","create","delete","read","update"],"name":"format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"prefix_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"is_base":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_base","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData"},"request_supported":["action","create","delete","read","update"],"name":"_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails":{"related_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"related_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"lookup_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"lookup_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules":{"query_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"query_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","unique_for":"none","structure":true},"actions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Actions","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Actions"},"request_supported":["action","create","delete","read","update"],"name":"actions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"execute_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["create","edit","create_edit"],"name":"execute_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"contact_role":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole","request_supported":["action","create","delete","read","update"],"name":"Contact_Role","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_write.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify":{"send_cancelling_mail":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"send_cancelling_mail","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCountWrapper":{"grouped_counts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount"},"request_supported":["action","create","delete","read","update"],"name":"grouped_counts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetDeletedParentRecordsRelatedRecordParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.webforms.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.BodyWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.CreateTagsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.GetHolidayHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"permissions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions","request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters"},"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","request_supported":["action","create","delete","read","update"],"name":"views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.GetFieldAttachmentsParam":{"fields_attachment_id":{"name":"fields_attachment_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cadences_execution.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field","unique_for":"none","structure":true},"matched_lead_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"matched_lead_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails":{"paid_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paid_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"users_license_purchased":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"users_license_purchased","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"trial_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trial_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"trial_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trial_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"paid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"paid_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paid_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"trial_action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trial_action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.UpdateRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordUsingExternalIDHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseWrapper":{"timeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline"},"request_supported":["action","create","delete","read","update"],"name":"__timeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.BodyWrapper":{"blueprint":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint"},"request_supported":["action","create","delete","read","update"],"name":"blueprint","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unblock_email.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer":{"records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assignment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"assignment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock":{"locked_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked_reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"record_locking_rule_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_locking_rule_id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"lock_source__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Manual","Automatic"],"name":"lock_source__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"locked_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Locked_time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"record_locking_configuration_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_locking_configuration_id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"locked_for_s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS","request_supported":["action","create","delete","read","update"],"name":"locked_for_s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"locked_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"locked_by__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.GetMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.GetHolidaysHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.DeleteVariablesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_URL_PATTERN","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","LIMIT_EXCEEDED","EXPECTED_FIELD_MISSING","DUPLICATE_DATA","ALREADY_SCHEDULED","INVALID_MODULE","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","the module name given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.CountResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.service_preference.BodyWrapper":{"service_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","request_supported":["action","create","delete","read","update"],"name":"service_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData":{"enrich_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField","request_supported":["action","create","delete","read","update"],"name":"enrich_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField","unique_for":"none","structure":true},"crm_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField"},"request_supported":["action","create","delete","read","update"],"name":"crm_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMergeWrapper":{"download_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge"},"request_supported":["action","create","delete","read","update"],"name":"download_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.PriceBook":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.definition.ResponseWrapper":{"definition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.Definition","request_supported":["action","create","delete","read","update"],"name":"definition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.definition.Definition","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.APIException","zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge":{"bcc_email":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address"},"request_supported":["action","create","delete","read","update"],"name":"bcc_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_merge_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","request_supported":["action","create","delete","read","update"],"name":"mail_merge_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","unique_for":"none","structure":true},"cc_email":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address"},"request_supported":["action","create","delete","read","update"],"name":"cc_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"attachment_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"attachment_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address"},"request_supported":["action","create","delete","read","update"],"name":"to_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"from_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","request_supported":["action","create","delete","read","update"],"name":"from_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionWrapper":{"contact_roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"contact_roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource","request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource","unique_for":"none","structure":true},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.ParseErrorDetails":{"line":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"line","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"near":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"near","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseWrapper":{"users_unavailability":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability"},"request_supported":["action","create","delete","read","update"],"name":"users_unavailability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.Currency":{"rounding_option":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["normal","round_off","round_up","round_down"],"name":"rounding_option","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"precision":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"precision","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula":{"return_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expression":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expression","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.GetPipelinesParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"master_record_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields"},"request_supported":["action","create","delete","read","update"],"name":"master_record_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.To":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Field":{"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt","unique_for":"none","structure":true},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout","request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout","unique_for":"none","structure":true},"mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[-1,2],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"validation_rule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"validation_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Module","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Module","unique_for":"none","structure":true},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType","unique_for":"none","structure":true},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"personality_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"transition_sequence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transition_sequence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula","unique_for":"none","structure":true},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"auto_number":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete":{"permanent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permanent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.GetTagsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"my_tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"my_tags","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseWrapper":{"custom_views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews"},"request_supported":["action","create","delete","read","update"],"name":"custom_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.GetRelatedListsParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.DeletePipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.BodyWrapper":{"transfer_and_delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete"},"name":"transfer_and_delete","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.profiles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["LICENSE_LIMIT_EXCEEDED","INVALID_DATA","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INTERNAL_ERROR","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[25],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["name","Description","permissions_details","profiles"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["jsonobject","text","jsonarray"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[50,250,1],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["permissions_details"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Request exceeds your license limit.","The action given is invalid","invalid data","required field not found","the id given seems to be invalid or already deleted","duplicate data","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","Internal server error occurred."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard":{"exempted_portal_user_types":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType"},"request_supported":["action","create","delete","read","update"],"name":"exempted_portal_user_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"portal_user_types":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType"},"request_supported":["action","create","delete","read","update"],"name":"portal_user_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"parent_wizard":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","request_supported":["action","create","delete","read","update"],"name":"parent_wizard","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"draft":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"draft","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"containers":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Container","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Container"},"request_supported":["action","create","delete","read","update"],"name":"containers","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.files.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.modules.Argument":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory":{"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["DUPLICATE_DATA","NOT_ALLOWED","REQUIRED_PARAM_MISSING","INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_DATA","EXPECTED_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces"},"request_supported":["action","create","delete","read","update"],"name":"associated_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NOT_ALLOWED","RESOURCE_NOT_FOUND","NO_PERMISSION","FEATURE_NOT_ENABLED","LIMIT_EXCEEDED","API_NOT_SUPPORTED","REQUIRED_PARAM_MISSING","INVALID_MODULE","EXPECTED_FIELD_MISSING","DEPENDENT_FIELD_MISSING","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permissions_needed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"supported_version","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The requested resource doesn`t exist."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.Widget":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.BodyWrapper":{"backup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","request_supported":["action","create","delete","read","update"],"name":"backup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"minimum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.Info":{"call":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia":{"media_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"media_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"media_url":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"media_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Private":{"restricted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ResponseWrapper":{"emaildrafts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts"},"request_supported":["action","create","delete","read","update"],"name":"__email_drafts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationWrapper":{"validate_before_transfer":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationGroup","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationGroup"},"request_supported":["action","create","delete","read","update"],"name":"validate_before_transfer","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"owner_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.BodyWrapper":{"unsubscribe_links":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks"},"request_supported":["action","create","delete","read","update"],"name":"unsubscribe_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notes.DeleteNotesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseWrapper":{"audit_log_export":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport"},"request_supported":["action","create","delete","read","update"],"name":"audit_log_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipelineWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_API_NAME","NOT_SUPPORTED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory":{"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.apis.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.share_records.BodyWrapper":{"notify_on_completion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_on_completion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"share":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord"},"name":"share","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":10},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionWrapper":{"transfer_pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordsParam":{"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings":{"mapped_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField","request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField","unique_for":"none","structure":true},"current_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField","request_supported":["action","create","delete","read","update"],"name":"current_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Connection":{"source_button":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button","request_supported":["action","create","delete","read","update"],"name":"source_button","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button","unique_for":"none","structure":true},"target_screen":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","request_supported":["action","create","delete","read","update"],"name":"target_screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.BodyWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount":{"total_shift_with_user":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_shift_with_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_shift":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_shift","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.GetAssignmentRuleParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount":{"territories":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"roles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"groups":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Users","request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Users","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.Note","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notes.Note"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_MODULE","LIMIT_EXCEEDED","RECORD_LOCKED","REQUIRED_PARAM_MISSING","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found","Invalid data"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.UpsertRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.GetPipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.BulkValidation":{"alert":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"alert","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assignment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"assignment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionWrapper":{"org_taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"org_taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.CreateMapDependencyHeader":{},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","ID_ALREADY_CONVERTED","MAPPING_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","required field not found","id already converted","Pipeline doesn`t contain the Stage"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SERVICE_NOT_FOUND","CONNECTION_TIMEOUT","AUTHORIZATION_FAILED","NO_PERMISSION","INVALID_DATA","MANDATORY_NOT_FOUND","NO_PERMISSION","FEATURE_NOT_AVAILABLE","UNCONFIRMED_EMAIL","PATTERN_NOT_MATCHED","INVALID_DATA","FUNCTION_NOT_CREATED","FUNCTION_NOT_UPDATED","FUNCTION_NOT_DELETED","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["service unavailable. please try after sometime","unable to connect. please try after sometime","unable to authorize your request.","no permission to perform an action on this record","your edition doesn't support this feature","please confirm your email","failed to update function","unable to delete a configured function.","permission denied","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseWrapper":{"ziaorgenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"__zia_org_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PATTERN_NOT_MATCHED","MANDATORY_NOT_FOUND","INVALID_DATA","UNABLE_TO_PARSE_DATA_TYPE","INVALID_MODULE","INVALID_URL_PATTERN","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["include_inner_details"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Please check whether the input values are correct","required field not found","either the request body or parameters is in wrong format","Ids should be Long value with comma separated","Please check if the URL trying to access is a correct one"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetSourcesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"user_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap":{"input_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData"},"request_supported":["action","create","delete","read","update"],"name":"input_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"output_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData"},"request_supported":["action","create","delete","read","update"],"name":"output_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.LookupField":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo":{"notes_desc":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notes_desc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"show_right_panel":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_right_panel","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"bc_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bc_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"show_home":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_home","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_detail_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_detail_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unpin_recent_item":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unpin_recent_item","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NOT_SUPPORTED","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.from_addresses.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo":{"field_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"escalation":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation","request_supported":["action","create","delete","read","update"],"name":"escalation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation","unique_for":"none","structure":true},"is_continuous":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_continuous","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"continuous":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"continuous","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"current_picklist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist","request_supported":["action","create","delete","read","update"],"name":"current_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail":{"pathfinder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder","request_supported":["action","create","delete","read","update"],"name":"pathfinder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder","unique_for":"none","structure":true},"rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","request_supported":["action","create","delete","read","update"],"name":"rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.ResponseWrapper":{"allowed_field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap","request_supported":["action","create","delete","read","update"],"name":"allowed_field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutsHeader":{},"zohocrmsdk.src.com.zoho.crm.api.definition.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_DATA"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["resource"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["resource"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["One of the expected parameter is missing","invalid param"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CreateZiaPeopleEnrichmentParam":{"record_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.BodyWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors":{"template_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"template_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"template_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"template_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"from_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress","request_supported":["action","create","delete","read","update"],"name":"from_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.RemoveTagsFromMultipleRecordsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Tab":{"font_color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#FFFFFF"],"name":"font_color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"background":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#222222"],"name":"background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","record not deleted","the module name given seems to be invalid","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseWrapper":{"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours":{"business_days":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice"},"request_supported":["action","create","delete","read","update"],"name":"business_days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"custom_timing":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming"},"request_supported":["action","create","delete","read","update"],"name":"custom_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"daily_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"daily_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":2},"week_starts_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"name":"week_starts_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"same_as_everyday":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"same_as_everyday","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["24_by_7","24_by_5","custom"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationGroup":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.Validation","zohocrmsdk.src.com.zoho.crm.api.users_territories.BulkValidation"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinUnpinFields":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.GetOrganizationHeader":{},"zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["FILTER_CRITERIA_NOT_SATISFIED","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_MODULE","LIMIT_EXCEEDED","DEPENDENT_FIELD_MISSING","INVALID_DATA","NOT_ALLOWED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MandatoryDetails","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MandatoryDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"minimum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_URL_PATTERN","INVALID_MODULE","NOT_SUPPORTED","INVALID_DATA","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.BulkWriteResponse":{"result":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result","request_supported":["action","create","delete","read","update"],"name":"result","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"character_encoding":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"character_encoding","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"callback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","request_supported":["action","create","delete","read","update"],"name":"callback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"operation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs":{"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages":{"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionWrapper":{"ziapeopleenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__zia_people_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["contact role added","contact role updated","contact role deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.definition.Definition":{"root_element_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"root_element_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"extradetails":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"extraDetails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.Property","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.definition.Property"},"request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionWrapper":{"base_currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionResponse","request_supported":["action","create","delete","read","update"],"name":"base_currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseWrapper":{"available_currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency"},"request_supported":["action","create","delete","read","update"],"name":"available_currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.GetNotificationsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"channel_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.GetWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNotesHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.GetFeatureDetailsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_names":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_names","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linking_module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"linking_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"lookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedlookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedlookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue":{"new":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"new","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"old":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"old","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.Sections":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"issubformsection":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isSubformSection","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tab_traversal":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tab_traversal","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"generated_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"generated_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Properties","request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Properties","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapySuccess","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.roles.Role":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"forecast_manager":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","request_supported":["action","create","delete","read","update"],"name":"forecast_manager","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","unique_for":"none","structure":true},"share_with_peers":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_with_peers","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","request_supported":["action","create","delete","read","update"],"name":"reporting_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"admin_user":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"admin_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.Available":{"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","unique_for":"none","structure":true},"record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Record","request_supported":["action","create","delete","read","update"],"name":"record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Record","unique_for":"none","structure":true},"available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification":{"notify_on_related_action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_on_related_action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"deleteevents":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"_delete_events","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"resource_uri":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_uri","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notify_url":{"regex":"www[.][a-z]{5}zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notification_condition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition"},"request_supported":["action","create","delete","read","update"],"name":"notification_condition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"return_affected_field_values":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_affected_field_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"channel_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"resource_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"resource_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"channel_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"events":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"events","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields":{"hidden":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hidden","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"site_key":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"site_key","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"advanced":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"advanced","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","unique_for":"none","structure":true},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","unique_for":"none","structure":true},"help":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"help","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secret_key":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secret_key","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"recaptcha_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"recaptcha_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"theme":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"theme","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"date_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.GetCustomViewParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.Subform":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.DeleteScoringRulesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portals.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.CreateHolidaysHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.BodyWrapper":{"variables":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable"},"request_supported":["action","create","delete","read","update"],"name":"variables","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionWrapper":{"audit_log_export":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"audit_log_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","InvalidModule","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","NOT_ALLOWED","NO_PERMISSION","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"info_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","api_name cannot be changed","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","invalid transition","invalid data","record not in process"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.wizards.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectPicklist":{"fieldname":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fieldName","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["BACKUP_ALREADY_SCHEDULED","REQUEST_BODY_NOT_READABLE","INVALID_DATA","ALREADY_CANCELLED","RESOURCE_NOT_FOUND","INPROGRESS","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address":{"continent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"continent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"region":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"region","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Component":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","unique_for":"none","structure":true},"feature_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation":{"resources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordsHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","EXPECTED_FIELD_MISSING","INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","AMBIGUITY_DURING_PROCESSING","LIMIT_EXCEEDED","NOT_SUPPORTED","INVALID_MODULE","RECORD_LOCKED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Invalid data","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"submission_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"submission_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["custom","standard"],"name":"page_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"location_url_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"location_url_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"custom_location_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_location_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action_on_unsubscribe":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action_on_unsubscribe","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","unique_for":"none","structure":true},"landing_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"landing_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"submission_redirect_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"submission_redirect_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"standard_page_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"standard_page_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"submission_action_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["display_message","redirect"],"name":"submission_action_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionWrapper":{"ziaorgenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__zia_org_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition":{"field_selection":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","request_supported":["action","create","delete","read","update"],"name":"field_selection","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Module","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.isc_signature.Signature":{"isc_signature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isc_signature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign":{"related_entity_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"related_entity_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"feature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["user_groups"],"name":"feature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"userMessage","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"output_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"output","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["function executed successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionWrapper":{"get_assigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionResponse","request_supported":["action","create","delete","read","update"],"name":"get_assigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ActionWrapper":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NOT_SUBSCRIBED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetMassUpdateStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.GetUserTypesParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyWrapper":{"base_currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency","request_supported":["action","create","delete","read","update"],"name":"base_currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.BodyWrapper":{"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"allowed_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Please give a valid month","Please give a valid value","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.BodyWrapper":{"portals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals"},"request_supported":["action","create","delete","read","update"],"name":"portals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["converted_records","mapped_module_records"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration"},"request_supported":["action","create","delete","read","update"],"name":"type_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.features.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.BodyWrapper":{"select_query":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"select_query","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties":{"sort_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionWrapper":{"share":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionResponse","request_supported":["action","create","delete","read","update"],"name":"share","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_FORM_ID","EXPECTED_FIELD_MISSING","REQUIRED_PARAM_MISSING","INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Details","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Details"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics":{"tracked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tracked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"delivered":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delivered","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"opened":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"opened","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"bounced":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"clicked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clicked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration":{"field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings"},"request_supported":["action","create","delete","read","update"],"name":"field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mapped_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule","request_supported":["action","create","delete","read","update"],"name":"mapped_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["layout updated","layout deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Event","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Event"},"request_supported":["action","create","delete","read","update"],"name":"events","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_uri","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Successfully subscribed for actions-watch of the given module","Successfully un-subscribed from actions-watch","Successfully updated the subscribe details","Successfully removed the subscribe details"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.GetWizardByIDParam":{"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrappe","zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"se_module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$se_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sharing_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$sharing_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"attachment_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$attachment_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"parent_id":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId","request_supported":["action","create","delete","read","update"],"name":"Parent_Id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId","unique_for":"none","structure":true},"file_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"link_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$link_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrapper":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseWrapper":{"related_lists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList"},"request_supported":["action","create","delete","read","update"],"name":"related_lists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.Feature":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_lists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetDeletedRecordsHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.blueprint.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reference_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reference_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"conditional_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules"},"request_supported":["action","create","delete","read","update"],"name":"conditional_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"segments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment"},"request_supported":["action","create","delete","read","update"],"name":"segments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.BodyWrapper":{"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile":{"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"defaultview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView","request_supported":["action","create","delete","read","update"],"name":"_default_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView","unique_for":"none","structure":true},"custom":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["normal_profile","lite_profile"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"sections":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Section","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Section"},"request_supported":["action","create","delete","read","update"],"name":"sections","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"permissions_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail"},"request_supported":["action","create","delete","read","update"],"name":"permissions_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseWrapper":{"org_taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","request_supported":["action","create","delete","read","update"],"name":"org_taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status":{"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"deleted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Deleted_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","RUNNING","FAILED"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseWrapper":{"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.digest.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"digest_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Digest has been successfully generated"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData"},"request_supported":["action","create","delete","read","update"],"name":"_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles":{"defaultassignmentview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView","request_supported":["action","create","delete","read","update"],"name":"_default_assignment_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView","unique_for":"none","structure":true},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"defaultview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView","request_supported":["action","create","delete","read","update"],"name":"_default_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordUsingExternalIDParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.modules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The fiscal year configuration has been updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.GetRecordLockingInformationsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action":{"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.DeleteMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming":{"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"business_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"business_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.Cadences":{"summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.Summary","request_supported":["action","create","delete","read","update"],"name":"summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.Summary","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.Module","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"execution_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail","request_supported":["action","create","delete","read","update"],"name":"execution_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail","unique_for":"none","structure":true},"published":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"published","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"custom_view":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView","request_supported":["action","create","delete","read","update"],"name":"custom_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge":{"password":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"password","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mail_merge_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","request_supported":["action","create","delete","read","update"],"name":"mail_merge_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","unique_for":"none","structure":true},"output_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["pdf","docx","html"],"name":"output_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":255}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.BodyWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.send_mail.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PAGE_RANGE_EXCEEDED","VALUE_TYPE_NOT_SUPPORTED","MODULE_NOT_SUPPORTED","REQUEST_BODY_NOT_SUPPORTED","FIELD_IN_CRITERIA_NOT_SUPPORTED","FIELD_COMPARATOR_IN_CRITERIA_NOT_SUPPORTED","RESOURCE_NOT_FOUND","INVALID_CALLBACK_METHOD","INVALID_CALLBACK_URL","GROUP_OPERATOR_NOT_SUPPORTED","AMBIGUOUS_CRITERIA","AMBIGUOUS_GROUP_IN_CRITERIA","INVALID_CRITERIA","CVID_NOT_SUPPORTED","INVALID_REQUEST","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_SERVICE_NAME","INVALID_BULK_OPERATION","MEDIA_TYPE_NOT_SUPPORTED","REQUEST_BODY_NOT_READABLE","REQUEST_BODY_IS_EMPTY","MODULE_NOT_AVAILABLE","NOT_SUPPORTED_FEATURE","NO_PERMISSION","JOB_NOT_SUPPORTED","QUERY_NOT_SUPPORTED","JOIN_LIMIT_EXCEEDED","CRITERIA_NOT_SUPPORTED","CRITERIA_LIMIT_EXCEEDED","FIELD_AND_COMPARATOR_IN_CRITERIA_NOT_COMPATIBLE","FIELD_IN_CRITERIA_NOT_AVAILABLE","VALUE_IN_CRITERIA_NOT_SUPPORTED","FIELD_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE","COMPARATOR_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE","COMPARATOR_AND_ENCRYPTED_VALUE_IN_CRITERIA_NOT_COMPATIBLE","FIELD_NOT_AVAILABLE","FIELD_NOT_SUPPORTED","VALUE_LIMIT_EXCEEDED_IN_CRITERIA","PAGE_NOT_SUPPORTED","TOO_MANY_REQUESTS","CALLBACK_FAILURE","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"max_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.TransferBodyWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.GetUsersOfUserTypeParam":{"filter":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filter","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year":{"display_based_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["end_month","start_month"],"name":"display_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"start_month":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["January","February","March","April","May","June","July","August","September","October","November","December"],"name":"start_month","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NO_PERMISSION","AMBIGUITY_DURING_PROCESSING","INVALID_DATA","NOT_ALLOWED","NOT_REVIEWED","MANDATORY_NOT_FOUND","ID_ALREADY_CONVERTED","NOT_APPROVED","EXPECTED_FIELD_MISSING"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["id already converted","invalid data","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.org.ResponseWrapper":{"org":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Org","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Org"},"request_supported":["action","create","delete","read","update"],"name":"org","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Reminder":{"period":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"period","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"unit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryModule":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"permissions_details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.Tag":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":25},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#F17574","#F48435","#E7A826","#A8C026","#63C57E","#1DB9B4","#57B1FD","#879BFC","#D297EE","#FD87BD","#969696","#658BA8","#B88562"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.related_records.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.business_hours.Features":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.GetJobStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.files.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_lists.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionWrapper":{"map_dependency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"map_dependency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config":{"tpt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt"},"request_supported":["action","create","delete","read","update"],"name":"tpt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"section":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section"},"request_supported":["action","create","delete","read","update"],"name":"section","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"zoho_integ":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt"},"request_supported":["action","create","delete","read","update"],"name":"zoho_integ","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"wf_scheduler":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_scheduler","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"success_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"success_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"locked_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData":{"canvas_width":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"canvas_width","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"nodes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Node","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Node"},"request_supported":["action","create","delete","read","update"],"name":"nodes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"canvas_height":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"canvas_height","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"connections":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Connection","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Connection"},"request_supported":["action","create","delete","read","update"],"name":"connections","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"color_palette":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground","request_supported":["action","create","delete","read","update"],"name":"color_palette","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters"},"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views"},"request_supported":["action","create","delete","read","update"],"name":"views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.GetAttachmentsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionWrapper":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.UsersCountParam":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ActiveUsers","DeactiveUsers","NotConfirmedUsers","ConfirmedUsers","CurrentUser","ActiveConfirmedUsers"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.RecordIdBodyWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":10},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseWrapper":{"map_dependency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency"},"request_supported":["action","create","delete","read","update"],"name":"map_dependency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours":{"custom_timing":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming"},"request_supported":["action","create","delete","read","update"],"name":"custom_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"daily_timing":{"response_supported":["action","create","delete","read","update"],"min_length":2,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":false,"sub_type":{"type":"LocalTime"},"name":"daily_timing","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":2},"same_as_everyday":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"same_as_everyday","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"break_days":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"break_days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.BodyWrapper":{"users_unavailability":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability"},"request_supported":["action","create","delete","read","update"],"name":"users_unavailability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.download_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.download_attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record is deleted","mass delete scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryOthers":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"permissions_details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.GetUsersHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.SearchRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordParam":{"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"mail_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mail_content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"last_version_statistics":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics","request_supported":["action","create","delete","read","update"],"name":"last_version_statistics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"folder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","request_supported":["action","create","delete","read","update"],"name":"folder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","unique_for":"none","structure":true},"last_usage_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_usage_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"associated":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"associated","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"consent_linked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_linked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"editor_mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editor_mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"favorite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favorite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist":{"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.GetDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingRequestBodyHeader":{"custom_functions_header":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"custom_functions_header","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory"},"name":"data","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingRequestBodyParam":{"auth_type":{"name":"auth_type","type":"String","structure":false},"arguments":{"name":"arguments","type":"Map","structure":false},"custom_functions_param":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"custom_functions_param","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordUsingExternalIDHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.GetEmailTemplatesParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"locked_for":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked_for","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"excluded_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField"},"request_supported":["action","create","delete","read","update"],"name":"excluded_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"feature_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"locking_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules"},"request_supported":["action","create","delete","read","update"],"name":"locking_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"restricted_actions":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"restricted_actions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"lock_for_portal_users":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lock_for_portal_users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"restricted_communications":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"restricted_communications","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"system_defined":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_defined","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"lock_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["manual","automatic","both"],"name":"lock_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"restricted_custom_buttons":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton"},"request_supported":["action","create","delete","read","update"],"name":"restricted_custom_buttons","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"lock_excluded_profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile"},"request_supported":["action","create","delete","read","update"],"name":"lock_excluded_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn":{"social":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social","request_supported":["action","create","delete","read","update"],"name":"social","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social","unique_for":"none","structure":true},"name":{"regex":"[a-zA-Z]{5}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":150},"company":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company","request_supported":["action","create","delete","read","update"],"name":"company","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company","unique_for":"none","structure":true},"email":{"regex":"[a-z]{7}[@]google[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.UploadFilesHeader":{},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email":{"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"has_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sentiment_info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["positive","negative","neutral"],"name":"sentiment_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"thread_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"thread_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"from_1":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","unique_for":"none","structure":true},"reply_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","request_supported":["action","create","delete","read","update"],"name":"reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","unique_for":"none","structure":true},"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"summary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"has_thread_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_thread_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"read":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"activity_info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"activity_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mail_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mail_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"intent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["query","request","purchase","complaints","others","spam"],"name":"intent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord","unique_for":"none","structure":true},"sent_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"emotion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"emotion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status"},"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.BodyWrapper":{"cadences_ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"cadences_ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseWrapper":{"assignment_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules"},"request_supported":["action","create","delete","read","update"],"name":"assignment_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unblock_email.APIException","zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Features","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Features"},"request_supported":["action","create","delete","read","update"],"name":"features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule":{"score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signal":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal","request_supported":["action","create","delete","read","update"],"name":"signal","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources":{"sub_territories":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sub_territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Source","request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Source","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["users","territories","roles"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expected_data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"maps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Maps","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Maps"},"request_supported":["action","create","delete","read","update"],"name":"maps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"probability":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"probability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"forecast_category":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory","request_supported":["action","create","delete","read","update"],"name":"forecast_category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory","unique_for":"none","structure":true},"sys_ref_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sys_ref_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"forecast_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"forecast_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["used","unused"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DeleteRelatedRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.AddTagsToMultipleRecordsParam":{"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency":{"rounding_option":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rounding_option","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"precision":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"precision","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.digest.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelinesParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt":{"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"table":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"table","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseWrapper":{"inventory_templates":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates"},"request_supported":["action","create","delete","read","update"],"name":"inventory_templates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.GetScoringRuleParam":{"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true,false],"name":"active","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"customizable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customizable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"parent_permissions":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"parent_permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"translation":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation","request_supported":["action","create","delete","read","update"],"name":"translation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation","unique_for":"none","structure":true},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser":{"fields_update_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields_update_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"record_operations_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_operations_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.CreateZiaOrgEnrichmentParam":{"record_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["LIMIT_EXCEEDED","NOT_SUPPORTED","DEPENDENT_MISMATCH","INVALID_URL_PATTERN","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.CadencesAnalyticsGet":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"follow_ups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics"},"request_supported":["action","create","delete","read","update"],"name":"follow_ups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"default_assignee":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee","request_supported":["action","create","delete","read","update"],"name":"default_assignee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall":{"created_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"cancelled_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cancelled_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"failed_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"completed_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"completed_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"scheduled_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduled_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"overdue_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"overdue_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"missed_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"missed_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Info Icon"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation":{"public_views":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"public_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"other_users_views":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"other_users_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_with_me":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_with_me","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by_me":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_by_me","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"process_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo","request_supported":["action","create","delete","read","update"],"name":"process_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo","unique_for":"none","structure":true},"transition_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transition_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"transitions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition"},"request_supported":["action","create","delete","read","update"],"name":"transitions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.org.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.org.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.org.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.org.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionWrapper":{"change_status":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"change_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.Format":{"decimal_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Period","Comma"],"name":"decimal_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"thousand_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Period","Comma","Space"],"name":"thousand_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"decimal_places":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["0","2","3"],"name":"decimal_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionWrapper":{"currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record added","record updated","record deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Unique":{"casesensitive":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"casesensitive","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"name":"data","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateBodyWrapper":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.associate_email.BodyWrapper":{"emails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail"},"request_supported":["action","create","delete","read","update"],"name":"Emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.ActionWrapper":{"org":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"org","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","group_type":"one-of","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.ResponseWrapper":{"apis":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI"},"request_supported":["action","create","delete","read","update"],"name":"__apis","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail":{"unenroll_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty","request_supported":["action","create","delete","read","update"],"name":"unenroll_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty","unique_for":"none","structure":true},"end_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"end_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"automatic_unenroll":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"automatic_unenroll","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"execute_every":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery","request_supported":["action","create","delete","read","update"],"name":"execute_every","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule":{"score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseWrapper":{"webforms":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm"},"request_supported":["action","create","delete","read","update"],"name":"webforms","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DelinkRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"issupported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isSupported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"isenabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isEnabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyBodyWrapper":{"scrapy_feedback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback","request_supported":["action","create","delete","read","update"],"name":"scrapy_feedback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.features.ResponseWrapper":{"features":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Feature","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.features.Feature"},"request_supported":["action","create","delete","read","update"],"name":"__features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory":{"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.UpdateWebFormParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields"},"request_supported":["action","create","delete","read","update"],"name":"_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionWrapper":{"transfer_and_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed":{"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"rename":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rename","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"clone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"downgrade":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"downgrade","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"deactivate":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deactivate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"set_layout_permissions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"set_layout_permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["People Enrichment scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"buttons":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button"},"request_supported":["action","create","delete","read","update"],"name":"buttons","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"column_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"elements":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Element","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Element"},"request_supported":["action","create","delete","read","update"],"name":"elements","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.variables.GetVariableByIDParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.DeleteGlobalPicklistsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_write.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"decimal_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"thousand_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"thousand_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"decimal_places":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapySuccess":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enrich_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetPickListValueAssociationsParam":{"picklist_value_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"picklist_value_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.Org":{"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"hierarchy_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences","request_supported":["action","create","delete","read","update"],"name":"hierarchy_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences","unique_for":"none","structure":true},"max_per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"max_per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"photo_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"photo_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"city":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"city","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Production","Sandbox","Bigin","Developer"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"mc_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mc_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"gapps_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"gapps_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"lite_users_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lite_users_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"domain_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"domain_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"translation_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"translation_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"street":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"street","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"alias":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"alias","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"currency":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"deletable_org_account":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deletable_org_account","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"call_icon":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call_icon","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fax":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fax","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"employee_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"employee_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"website":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zia_zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zia_zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"currency_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"currency_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ezgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ezgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"oauth_presence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"oauth_presence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"mobile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mobile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"currency_locale":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"currency_locale","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zia_portal_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zia_portal_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"time_zone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time_zone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"checkin_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences","request_supported":["action","create","delete","read","update"],"name":"checkin_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences","unique_for":"none","structure":true},"zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"country_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"license_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails","request_supported":["action","create","delete","read","update"],"name":"license_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails","unique_for":"none","structure":true},"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"company_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"company_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"privacy_settings":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"privacy_settings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"primary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionWrapper":{"sign_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"sign_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"mail_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mail_content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"folder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","request_supported":["action","create","delete","read","update"],"name":"folder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","unique_for":"none","structure":true},"last_usage_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_usage_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"editor_mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editor_mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"favorite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favorite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.UpdateMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.BodyWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["static","merge_field"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.UploadFilesParam":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo":{"industries":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry"},"request_supported":["action","create","delete","read","update"],"name":"industries","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"experiences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience"},"request_supported":["action","create","delete","read","update"],"name":"experiences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.GetCustomViewsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","REQUIRED_PARAM_MISSING","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INTERNAL_ERROR","MANDATORY_NOT_FOUND","NOT_SUPPORTED","REQUIRED_PARAM_MISSING","INVALID_MODULE","INTERNAL_SERVER_ERROR","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","One of the expected parameter is missing","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the id given seems to be invalid","One of the expected parameter is missing","record not deleted","Internal server error occurred.","the module name given seems to be invalid","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrappe":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.FileDetails":{"owner__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"size__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Size__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"file_name__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Name__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.org.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.org.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"show_data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseWrapper":{"global_picklists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist"},"request_supported":["action","create","delete","read","update"],"name":"global_picklists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.UpdateShiftHourHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes":{"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"width":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"width","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"font_attributes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes","request_supported":["action","create","delete","read","update"],"name":"font_attributes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes","unique_for":"none","structure":true},"display_form_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_form_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"align":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"align","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.GetProfileHeader":{},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory":{"manager":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","request_supported":["action","create","delete","read","update"],"name":"Manager","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","request_supported":["action","create","delete","read","update"],"name":"Reporting_To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress":{"reason":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.GetBusinessHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_MODULE","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.UpdateRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.GetShiftHourHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline":{"extension":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"extension","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"done_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","request_supported":["action","create","delete","read","update"],"name":"done_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","unique_for":"none","structure":true},"related_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord","request_supported":["action","create","delete","read","update"],"name":"related_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord","unique_for":"none","structure":true},"automation_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail","request_supported":["action","create","delete","read","update"],"name":"automation_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail","unique_for":"none","structure":true},"record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Record","request_supported":["action","create","delete","read","update"],"name":"record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Record","unique_for":"none","structure":true},"audited_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"audited_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_history":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory"},"request_supported":["action","create","delete","read","update"],"name":"field_history","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approval_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record added","record deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.GetStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.ResponseWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_write.BulkWriteResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.BodyWrapper":{"emaildrafts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts"},"request_supported":["action","create","delete","read","update"],"name":"__email_drafts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionWrapper":{"users_unavailability":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users_unavailability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PATTERN_NOT_MATCHED","INVALID_DATA","JSON_PARSE_ERROR","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"minimum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseWrapper":{"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType"},"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NOT_ALLOWED","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","EXPECTED_FIELD_MISSING","AMBIGUITY_DURING_PROCESSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationWrapper":{"associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack":{"method":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["post"],"name":"method","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.GetVariableByAPINameParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetAssignBodyWrapper":{"get_assigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","request_supported":["action","create","delete","read","update"],"name":"get_assigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList":{"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap","unique_for":"none","structure":true},"sort_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedmodule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedmodule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linkingmodule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"linkingmodule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"customize_sort":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customize_sort","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customize_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customize_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"customize_display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customize_display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"href":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"href","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["visible","user_hidden","scheduled_for_deletion"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.GetEntityScoreParam":{"cvid":{"name":"cvid","type":"String","structure":false},"fields":{"name":"fields","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Category":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryModule","zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryOthers"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territories.GetTerritoriesParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.profiles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.notifications.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordUsingExternalIDParam":{"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["scoring rule created successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesWrapper":{"sources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources"},"request_supported":["action","create","delete","read","update"],"name":"sources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.FileBodyWrapper":{"inputfile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"inputFile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["owner is successfully updated"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.BodyWrapper":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","DUPLICATE_DATA","REQUIRED_PARAM_MISSING","JSON_PARSE_ERROR","PATTERN_NOT_MATCHED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Appointments preferences updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ResponseWrapper":{"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.HistoryWrapper":{"history":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.History","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.backup.History"},"request_supported":["action","create","delete","read","update"],"name":"history","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping":{"deals":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"accounts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"contacts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping":{"parent_column_index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_column_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"find_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"find_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue","request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionWrapper":{"duplicate_check_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"duplicate_check_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS","SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.GetChildTerritoryParam":{"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Actions":{"exempted_profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"exempted_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","unique_for":"none","structure":true},"segment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","request_supported":["action","create","delete","read","update"],"name":"segment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory":{"rescheduled_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Rescheduled_To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"review_process":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$review_process","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"orchestration":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$orchestration","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"in_merge":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$in_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"rescheduled_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Rescheduled_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approved","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sharing_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$sharing_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"review":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$review","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"rescheduled_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","request_supported":["action","create","delete","read","update"],"name":"Rescheduled_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"currency_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$currency_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approval":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval","request_supported":["action","create","delete","read","update"],"name":"$approval","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval","unique_for":"none","structure":true},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"appointment_name":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName","request_supported":["action","create","delete","read","update"],"name":"Appointment_Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","unique_for":"none","structure":true},"reschedule_reason":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Reschedule_Reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zia_visions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$zia_visions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"reschedule_note":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Reschedule_Note","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"process_flow":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$process_flow","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","unique_for":"none","structure":true},"canvas_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$canvas_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"rescheduled_from":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Rescheduled_From","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"approval_state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approval_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingParametersParam":{"auth_type":{"name":"auth_type","type":"String","structure":false},"get_custom_functions_param":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"get_custom_functions_param","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"arguments":{"name":"arguments","type":"Map","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionWrapper":{"watch":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"watch","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.APIException":{"features":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Feature","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Feature"},"request_supported":["action","create","delete","read","update"],"name":"features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","CANNOT_UPDATE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Feature","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Feature"},"request_supported":["action","create","delete","read","update"],"name":"features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Company not created"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline","request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline","unique_for":"none","structure":true},"stages":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages"},"request_supported":["action","create","delete","read","update"],"name":"stages","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["transition updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.BodyWrapper":{"portal_invite":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite"},"request_supported":["action","create","delete","read","update"],"name":"portal_invite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notes.APIException","zohocrmsdk.src.com.zoho.crm.api.notes.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.CreatePipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail":{"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","unique_for":"none","structure":true},"bcc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To"},"request_supported":["action","create","delete","read","update"],"name":"bcc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"from_1":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.From","request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.From","unique_for":"none","structure":true},"date_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"subject":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":250},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["html","text"],"name":"mail_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"original_message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"original_message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["equal","not_equal","in","not_in","less_than","less_equal","greater_than","greater_equal","contains","not_contains","starts_with","ends_with","between","not_between"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["and","or"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectLookup":{"fieldname":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fieldName","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"has_more":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$has_more","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldsHeader":{},"zohocrmsdk.src.com.zoho.crm.api.notes.ParentId":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData":{"org_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"org_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description"},"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ceo":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ceo","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secondary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secondary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"revenue":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"revenue","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"years_in_industry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"years_in_industry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"other_contacts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"other_contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"techno_graphic_data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"techno_graphic_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"logo":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"logo","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secondary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secondary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"other_emails":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"other_emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"sign_in":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign_in","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"website":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address"},"request_supported":["action","create","delete","read","update"],"name":"address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sign_up":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign_up","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"org_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"org_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"head_quarters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address"},"request_supported":["action","create","delete","read","update"],"name":"head_quarters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"no_of_employees":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"no_of_employees","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory_list":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"territory_list","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"founding_year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"founding_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"industries":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry"},"request_supported":["action","create","delete","read","update"],"name":"industries","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"business_model":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"business_model","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"primary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"social_media":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia"},"request_supported":["action","create","delete","read","update"],"name":"social_media","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.profiles.GetProfilesParam":{"include_lite_profile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_lite_profile","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper":{"conflict_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"conflict_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"access_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["public","only_to_me","shared"],"name":"access_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","unique_for":"none","structure":true},"system_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","unique_for":"none","structure":true},"sort_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy","request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","unique_for":"none","structure":true},"shared_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo"},"request_supported":["action","create","delete","read","update"],"name":"shared_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"offline":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"offline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","unique_for":"none","structure":true},"system_defined":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_defined","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_accessed_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_accessed_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"locked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"favorite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favorite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["asc","desc"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portals.APIException","zohocrmsdk.src.com.zoho.crm.api.portals.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails":{"related_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","request_supported":["action","create","delete","read","update"],"name":"related_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","unique_for":"none","structure":true},"lookup_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","request_supported":["action","create","delete","read","update"],"name":"lookup_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["RESOURCE_NOT_FOUND","INVALID_DATA","NOT_ALLOWED","EXPECTED_FIELD_MISSING","LIMIT_EXCEEDED","MANDATORY_NOT_FOUND","NO_PERMISSION","REQUIRED_PARAM_MISSING","INVALID_MODULE","API_NOT_SUPPORTED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permissions_needed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"supported_version","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["permission denied"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.JsonDetails":{"expected_data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitor":{"auto_response_rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule","request_supported":["action","create","delete","read","update"],"name":"auto_response_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule","unique_for":"none","structure":true},"template_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"template_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.UpdateTagsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetGlobalPicklistsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.holidays.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.timelines.State":{"trigger_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trigger_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"is_last_state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_last_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Tags":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","DUPLICATE_DATA","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the name given seems to be invalid","the id given seems to be invalid","the default_assignee given seems to be invalid","the module name given seems to be invalid","the given assignment rule name already exists","One of the expected parameter is missing"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["OR","AND"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"min_length":2,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria"},"name":"group","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":2}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.From":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes":{"method":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"method","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"oauth_scope":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"oauth_scope","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"max_credits":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"max_credits","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"min_credits":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"min_credits","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes":{"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"family":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"family","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.Info":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"allowed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allowed_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.UploadPhotoParam":{"restrict_triggers":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_triggers","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.GetModulesHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ChangeUsersStatusParam":{"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingFileHeader":{"upload_file_header":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"upload_file_header","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType":{"web_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"web_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"web_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"web_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseWrapper":{"duplicate_check_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","request_supported":["action","create","delete","read","update"],"name":"duplicate_check_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ResonseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseWrapper":{"replaced_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue"},"request_supported":["action","create","delete","read","update"],"name":"replaced_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"owner_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty":{"end_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"end_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_read.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Source":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","EXPECTED_FIELD_MISSING","INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_related_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.ActionWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BodyWrapper":{"shift_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours"},"request_supported":["action","create","delete","read","update"],"name":"shift_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info":{"call":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty"},"request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData":{"website":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email_infos":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo"},"request_supported":["action","create","delete","read","update"],"name":"email_infos","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"gender":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"gender","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"company_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo","request_supported":["action","create","delete","read","update"],"name":"company_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo","unique_for":"none","structure":true},"last_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"educations":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"educations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"middle_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"middle_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"skills":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"skills","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"other_contacts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"other_contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"address_list_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address"},"request_supported":["action","create","delete","read","update"],"name":"address_list_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"primary_address_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","request_supported":["action","create","delete","read","update"],"name":"primary_address_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secondary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secondary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"designation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"designation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"interests":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"interests","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"first_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"social_media":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia"},"request_supported":["action","create","delete","read","update"],"name":"social_media","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails":{"record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"inventory_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate","request_supported":["action","create","delete","read","update"],"name":"inventory_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate","unique_for":"none","structure":true},"paper_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paper_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.backup.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territories.Territories":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"manager":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Manager","request_supported":["action","create","delete","read","update"],"name":"manager","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Manager","unique_for":"none","structure":true},"account_rule_criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","request_supported":["action","create","delete","read","update"],"name":"account_rule_criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"lead_rule_criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","request_supported":["action","create","delete","read","update"],"name":"lead_rule_criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","unique_for":"none","structure":true},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo","request_supported":["action","create","delete","read","update"],"name":"reporting_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"deal_rule_criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","request_supported":["action","create","delete","read","update"],"name":"deal_rule_criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["read_write_delete","read_only"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.CreateWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notifications.Event":{"channel_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"resource_uri":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_uri","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resource_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"resource_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notification_condition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition"},"request_supported":["action","create","delete","read","update"],"name":"notification_condition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"channel_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionWrapper":{"shift_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"shift_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.BodyWrapper":{"webforms":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm"},"request_supported":["action","create","delete","read","update"],"name":"webforms","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.InviteUsersParam":{"user_type_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_type_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"language":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["en_US","en_GB","bg_BG","zh_CN","zh_TW","hr_HR","ar_EG","in_ID","cs_CZ","da_DK","nl_NL","fr_FR","de_DE","hu_HU","","hi_IN","it_IT","ja_JP","pl_PL","pt_BR","pt_PT","ru_RU","es_ES","sv_SE","th_TH","tr_TR","vi_VN","ko_KR","iw_IL"],"name":"language","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invite","reinvite"],"name":"type","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.TimeRange":{"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"From","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.GetTimelinesParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["extension","type"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["field_history.data_type","field_history.enable_colour_code","field_history.pick_list_values","field_history.field_label"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"include_timeline_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_timeline_type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["desc","asc"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.ResponseWrapper":{"roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.Role","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.roles.Role"},"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":80},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["shift_holiday"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"shift_hour":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","request_supported":["action","create","delete","read","update"],"name":"shift_hour","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.JobsWrapper":{"deletion_jobs":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs"},"request_supported":["action","create","delete","read","update"],"name":"deletion_jobs","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores":{"scoring_rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule","request_supported":["action","create","delete","read","update"],"name":"Scoring_Rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule","unique_for":"none","structure":true},"score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"zia_visions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$zia_visions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"touch_point_negative_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Touch_Point_Negative_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"touch_point_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Touch_Point_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"positive_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Positive_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"field_states":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$field_states","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"touch_point_positive_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Touch_Point_Positive_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"entity":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity","request_supported":["action","create","delete","read","update"],"name":"Entity","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity","unique_for":"none","structure":true},"negative_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Negative_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.BodyWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":5},"unblock_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"unblock_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NO_CONTENT","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","TERRITORY_NOT_ENABLED","DEPENDENT_FIELD_MISSING","EXPECTED_FIELD_MISSING","FEATURE_NOT_SUPPORTED","CONVERTED_RECORD","NOT_FOUND","NO_RECORDS_FOUND","NOT_APPROVED","LIMIT_EXCEEDED","ALREADY_SCHEDULED","CANNOT_PERFORM_ACTION","CANNOT_PROCESS","INTERNAL_ERROR","INVALID_TOKEN","INVALID_DATA","STORAGE_SPACE_EXCEEDED","MANDATORY_NOT_FOUND","NO_PERMISSION","INVALID_MODULE","NOT_SUPPORTED","PATTERN_NOT_MATCHED","OAUTH_SCOPE_MISMATCH","DUPLICATE_DATA","INVALID_QUERY","MAPPING_MISMATCH","ID_ALREADY_CONVERTED","FILE_SIZE_MORE_THAN_ALLOWED_SIZE","RECORD_IN_BLUEPRINT","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","CANNOT_DELETE","REQUIRED_PARAM_MISSING","DATA_MISMATCH","RECORD_LOCKED","BAD_REQUEST","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord","request_supported":["action","create","delete","read","update"],"name":"duplicate_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allowed_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"External","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record under merge is locked","the given id seems to be invalid","The record is not approved","The external ID of the lookup field or the Price Book is incorrect","The value of the external field is invalid.","There is no data for the ID specified or there is no matching record in the given module.","The external field contains duplicate data.","the territory feature is not enabled","Given Probability is not valid","duplicate territory id found","Given Territory id already exists for that record","User has no permission to assign this territory","Maximum limit of territories for that record exceeds","Invalid Sequence Number","Record insertion limit for Image upload field has been exceeded.","Record insertion limit has been exceeded.","The image format is invalid.","Dependent Fields missing","Specify Atleast one field","the id given seems to be invalid.","Already an Mass Action scheduler is runing for the given cvid","Scheduled Mass Operation feature is not available in your edition","can't update the converted record","Field cannot be updated in Scheduled Mass Update","Field is not visible","Field cannot be updated as it is associated with a validation rule.","Field cannot be updated as it is associated with a layout rule.This field cannot be updated in the Mass Update","Max field limit exceeded","Maximum lookup field limit in criteria exceeded","No field found","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","Territory is not supported for the given module","Please check whether the input values are correct","invalid data","permission denied","Internal server error occurred.","duplicate data","required field not found","Layout doesn't contain the Pipeline","Pipeline doesn't contain the Stage","the id given seems to be invalid","record not deleted","record not deletable","Authentication failed","One of the expected parameter is missing","mandatory param missing","invalid query formed","id already converted","body","given id is invalid","Already a Mass Action scheduler is running for the given cvid","The record is in stop processing","The record is in blue print","no permission to perform an action on this record","Record count exceeded","record not approved","no record found to update","Field Edit Permission not given","Customview not accessible","Empty response","give contact id is mismatched with the data","give account id is mismatched with the data","Territory id which you are trying to remove was system assigned"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal":{"namespace":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"namespace","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DealField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.BodyWrapper":{"org_taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","request_supported":["action","create","delete","read","update"],"name":"org_taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","unique_for":"none","structure":true,"max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingParametersHeader":{"get_custom_functions_header":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"get_custom_functions_header","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCountWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","unique_for":"none","structure":true},"file_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ics"],"name":"file_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"regex":"[1-9]|[1-4][1-9]|50","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.UpdatePipelinesParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.CountHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.CountWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.GetDownloadAttachmentsDetailsParam":{"user_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DelinkRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Feature":{"components":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Component","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.features.Component"},"request_supported":["action","create","delete","read","update"],"name":"components","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"parent_feature":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Feature","request_supported":["action","create","delete","read","update"],"name":"parent_feature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Feature","unique_for":"none","structure":true},"module_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","unique_for":"none","structure":true},"feature_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","PATTERN_NOT_MATCHED","INTERNAL_ERROR","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","REQUIRED_PARAM_MISSING","BAD_REQUEST","NO_PERMISSION","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Invalid Wizard ID","the module name given seems to be invalid","feature not available in this edition","permission denied","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","Internal server error occurred."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.UpdateFieldParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","DUPLICATE_DATA","INVALID_MODULE","INTERNAL_SERVER_ERROR","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation":{"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["BAD_REQUEST","INVALID_MODULE","SHARE_LIMIT_EXCEEDED","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","DUPLICATE_DATA","LIMIT_EXCEEDED","MANDATORY_NOT_FOUND","INVALID_DATA","ENTITY_ID_INVALID","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Scheduler is running","cannot share to the user","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","record not deleted","the related id given seems to be invalid","The relation name given seems to be invalid.","invalid oauth scope to access this URL","Please check if the URL trying to access is a correct one.","Permission is invalid","record is already visible to the user.","Cannot share a record to more than 10 users.","No sharing through this record is available to revoke.","ENTITY_ID_INVALID"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionWrapper":{"webforms":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"webforms","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DownloadHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.Participants":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"invited":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"invited","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"participant":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"participant","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module","unique_for":"none","structure":true},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout","unique_for":"none","structure":true},"field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings"},"request_supported":["action","create","delete","read","update"],"name":"field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["VERSION_NOT_SUPPORTED","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.Resources":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.BodyWrapper":{"record_locking_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock"},"request_supported":["action","create","delete","read","update"],"name":"record_locking_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.Manager":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.Preference":{"auto_populate_tax":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"auto_populate_tax","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modify_tax_rates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modify_tax_rates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.Variable":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["text","integer","percent","double","currency","date","datetime","email","phone","website","textarea","checkbox","long"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"variable_group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup","request_supported":["action","create","delete","read","update"],"name":"variable_group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.CountResponseWrapper":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DelinkRecordsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"jobId","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["User added","User updated","User deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.DeleteUserFromThePortalParam":{"personality_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false,"max_length":10},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"forecast_category":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory","request_supported":["action","create","delete","read","update"],"name":"forecast_category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory","unique_for":"none","structure":true},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"forecast_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"forecast_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm":{"google_site":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"google_site","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"encrypted_form_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"encrypted_form_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"acknowledge_visitor":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors","request_supported":["action","create","delete","read","update"],"name":"acknowledge_visitor","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors","unique_for":"none","structure":true},"button_attributes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes"},"request_supported":["action","create","delete","read","update"],"name":"button_attributes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action_on_submit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action_on_submit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"iframe_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iframe_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"form_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields"},"request_supported":["action","create","delete","read","update"],"name":"form_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","unique_for":"none","structure":true},"encrypted_zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"encrypted_zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"abtesting":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting"},"request_supported":["action","create","delete","read","update"],"name":"abtesting","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"action_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","unique_for":"none","structure":true},"embed_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"embed_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"analytics_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData","request_supported":["action","create","delete","read","update"],"name":"analytics_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","unique_for":"none","structure":true},"suggestion":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion","request_supported":["action","create","delete","read","update"],"name":"suggestion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion","unique_for":"none","structure":true},"encrypted_module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"encrypted_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"adword_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"adword_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"notify_owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","request_supported":["action","create","delete","read","update"],"name":"notify_owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","unique_for":"none","structure":true},"form_attributes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes","request_supported":["action","create","delete","read","update"],"name":"form_attributes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes","unique_for":"none","structure":true},"location_url":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"location_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"landing_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"landing_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"double_optin_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"double_optin_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Tags","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Tags"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"last_submitted_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_submitted_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","unique_for":"none","structure":true},"code_formats":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"code_formats","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"approval_request":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approval_request","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assignment_rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule","request_supported":["action","create","delete","read","update"],"name":"assignment_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"source_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"spam_control":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll","request_supported":["action","create","delete","read","update"],"name":"spam_control","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll","unique_for":"none","structure":true},"visitor_tracking":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visitor_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.BodyWrapper":{"ziaorgenrichment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment"},"name":"__zia_org_enrichment","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.related_records.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NO_PERMISSION","CANNOT_BE_UPDATED","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","INTERNAL_ERROR","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","record not deleted","the related id given seems to be invalid","Internal server error occurred.","The relation name given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["used","unused"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments":{"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.UpdateHolidayHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDeleteByID":{"move_subordinate":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","request_supported":["action","create","delete","read","update"],"name":"move_subordinate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","unique_for":"none","structure":true},"transfer":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","request_supported":["action","create","delete","read","update"],"name":"transfer","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.digest.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.digest.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"prev_index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prev_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException":{"error_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Bad Request"],"name":"ERROR_MESSAGE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","FILE_TOO_LARGE","INVALID_FILE_FORMAT","MANDATORY_FIELDS_NOT_MAPPED","MANDATORY_NOT_FOUND","INVALID_FIELD","INVALID_FORMAT","INVALID_FILE_ID","HEADER_LIMIT_EXCEEDED","COLUMN_INDEX_NOT_FOUND","MODULE_NOT_AVAILABLE","INVALID_DATA","DUPLICATE_DATA","NOT_APPROVED","BLOCKED_RECORD","CANNOT_PROCESS","LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","MISSING_REQUIRED_KEY","INVALID_FIELD_NAME","FILE_NOT_SUPPORTED","COEXISTENCE_NOT_ALLOWED","INVALID_CALLBACK_METHOD","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"x_info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Link not valid"],"name":"x-info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_callback_methods","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"error_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ERROR_CODE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"http_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"http_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","invalid file format. only zip format is supported","File size too large to process","The requested resource doesn't exist.","required key operation is not found in request body.","improper file id","required key index for field Company is not found in request body.","All mandatory fields are not mapped for the layout","Requested module 'asdf' is not available.","invalid mapping. invalid api_name ast_Name.","File not supported for bulk write"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"x_error":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["check if headers [feature, X-CRM-ORG] are present and valid"],"name":"x-error","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Forbidden"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","EXPECTED_FIELD_MISSING","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":80},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.RequestWrapper":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ignore_empty":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ignore_empty","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"character_encoding":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"character_encoding","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"callback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","request_supported":["action","create","delete","read","update"],"name":"callback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","unique_for":"none","structure":true},"operation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["insert","update","upsert"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings":{"share_from_users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser"},"request_supported":["action","create","delete","read","update"],"name":"share_from_users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"available_types":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"available_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.BodyWrapper":{"digest":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.digest.Digest","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.digest.Digest"},"request_supported":["action","create","delete","read","update"],"name":"__digest","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"first_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.From":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.DeleteAttachmentsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.BodyWrapper":{"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience":{"end_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"end_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"company_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"company_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"start_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences":{"restricted_event_types":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted_event_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.CreateShiftHoliday":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn":{"website":{"regex":"www[.][a-z0-9]+[.][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"regex":"[a-zA-Z]{5}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":150},"email":{"regex":"[a-z]{7}[@]google[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.ResponseWrapper":{"backup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","request_supported":["action","create","delete","read","update"],"name":"backup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Wizard":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MAPPING_MISMATCH","DUPLICATE_DATA","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","INTERNAL_SERVER_ERROR","PATTERN_NOT_MATCHED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails","request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section":{"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"options":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option"},"request_supported":["action","create","delete","read","update"],"name":"options","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Theme":{"normal_tab":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","request_supported":["action","create","delete","read","update"],"name":"normal_tab","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","unique_for":"none","structure":true},"selected_tab":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","request_supported":["action","create","delete","read","update"],"name":"selected_tab","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","unique_for":"none","structure":true},"new_background":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"new_background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"background":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#F3F0EB"],"name":"background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"screen":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["fixed"],"name":"screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.util.Model":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.CreateBusinessHoliday","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules","zohocrmsdk.src.com.zoho.crm.api.shift_hours.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child","zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info","zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline","zohocrmsdk.src.com.zoho.crm.api.apis.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Expression","zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Wrapper","zohocrmsdk.src.com.zoho.crm.api.tags.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.backup.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency","zohocrmsdk.src.com.zoho.crm.api.notes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.isc_signature.Signature","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration","zohocrmsdk.src.com.zoho.crm.api.territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.features.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","zohocrmsdk.src.com.zoho.crm.api.tags.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee","zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField","zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","zohocrmsdk.src.com.zoho.crm.api.fields.Formula","zohocrmsdk.src.com.zoho.crm.api.user_groups.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","zohocrmsdk.src.com.zoho.crm.api.taxes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.definition.APIException","zohocrmsdk.src.com.zoho.crm.api.record.FileDetails","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","zohocrmsdk.src.com.zoho.crm.api.service_preference.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground","zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc","zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser","zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineWrapper","zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectLookup","zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo","zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue","zohocrmsdk.src.com.zoho.crm.api.associate_email.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable","zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter","zohocrmsdk.src.com.zoho.crm.api.fields.Subform","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Wrapper","zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.files.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment","zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroupsWrapper","zohocrmsdk.src.com.zoho.crm.api.record.PriceBook","zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipelineWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail","zohocrmsdk.src.com.zoho.crm.api.webforms.User","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail","zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","zohocrmsdk.src.com.zoho.crm.api.change_owner.MassWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info","zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity","zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed","zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes","zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource","zohocrmsdk.src.com.zoho.crm.api.portals.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social","zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser","zohocrmsdk.src.com.zoho.crm.api.territories.TransferBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Tax","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord","zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails","zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCountWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.UrlsWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks","zohocrmsdk.src.com.zoho.crm.api.download_inline_images.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule","zohocrmsdk.src.com.zoho.crm.api.layouts.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo","zohocrmsdk.src.com.zoho.crm.api.notes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.business_hours.Features","zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","zohocrmsdk.src.com.zoho.crm.api.record.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result","zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company","zohocrmsdk.src.com.zoho.crm.api.templates.Templates","zohocrmsdk.src.com.zoho.crm.api.notes.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","zohocrmsdk.src.com.zoho.crm.api.portals.Portals","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields","zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView","zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours","zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.record.RecurringActivity","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","zohocrmsdk.src.com.zoho.crm.api.profiles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.RecordIdBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap","zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.profiles.Section","zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts","zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.InventoryConverter","zohocrmsdk.src.com.zoho.crm.api.backup.Backup","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","zohocrmsdk.src.com.zoho.crm.api.org.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryModule","zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapySuccess","zohocrmsdk.src.com.zoho.crm.api.convert_lead.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences","zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","zohocrmsdk.src.com.zoho.crm.api.email_drafts.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Data","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule","zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout","zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap","zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores","zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation","zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder","zohocrmsdk.src.com.zoho.crm.api.fields.Fields","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup","zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions","zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","zohocrmsdk.src.com.zoho.crm.api.webforms.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories","zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.definition.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.APIException","zohocrmsdk.src.com.zoho.crm.api.templates.Wrapper","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.APIException","zohocrmsdk.src.com.zoho.crm.api.blueprint.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.APIException","zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues","zohocrmsdk.src.com.zoho.crm.api.cadences.Summary","zohocrmsdk.src.com.zoho.crm.api.user_groups.Source","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.APIException","zohocrmsdk.src.com.zoho.crm.api.users.APIException","zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status","zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment","zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.Node","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module","zohocrmsdk.src.com.zoho.crm.api.portals.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.CadencesAnalyticsGet","zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.HistoryWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.wizards.Container","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unblock_email.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.Info","zohocrmsdk.src.com.zoho.crm.api.wizards.Message","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole","zohocrmsdk.src.com.zoho.crm.api.cadences.User","zohocrmsdk.src.com.zoho.crm.api.files.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField","zohocrmsdk.src.com.zoho.crm.api.fields.Unique","zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.templates.Folder","zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail","zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","zohocrmsdk.src.com.zoho.crm.api.business_hours.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDeleteByID","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.conversion_option.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval","zohocrmsdk.src.com.zoho.crm.api.functions.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules","zohocrmsdk.src.com.zoho.crm.api.record.Consent","zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData","zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse","zohocrmsdk.src.com.zoho.crm.api.users_territories.Info","zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton","zohocrmsdk.src.com.zoho.crm.api.taxes.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport","zohocrmsdk.src.com.zoho.crm.api.users.Role","zohocrmsdk.src.com.zoho.crm.api.backup.Urls","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.unblock_email.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address","zohocrmsdk.src.com.zoho.crm.api.layouts.DealField","zohocrmsdk.src.com.zoho.crm.api.users.Profile","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap","zohocrmsdk.src.com.zoho.crm.api.backup.Requester","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association","zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","zohocrmsdk.src.com.zoho.crm.api.send_mail.From","zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.taxes.Tax","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData","zohocrmsdk.src.com.zoho.crm.api.users_territories.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Widget","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia","zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.download_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount","zohocrmsdk.src.com.zoho.crm.api.email_drafts.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","zohocrmsdk.src.com.zoho.crm.api.layouts.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.variables.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData","zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.associate_email.Available","zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","zohocrmsdk.src.com.zoho.crm.api.notifications.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.templates.APIException","zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources","zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt","zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper","zohocrmsdk.src.com.zoho.crm.api.variables.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration","zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails","zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","zohocrmsdk.src.com.zoho.crm.api.field_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Profile","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers","zohocrmsdk.src.com.zoho.crm.api.fields.Maps","zohocrmsdk.src.com.zoho.crm.api.users.Theme","zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo","zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy","zohocrmsdk.src.com.zoho.crm.api.change_owner.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Actions","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules","zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.files.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.RecordSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException","zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","zohocrmsdk.src.com.zoho.crm.api.backup.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.profiles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territory_users.Info","zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role","zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays","zohocrmsdk.src.com.zoho.crm.api.download_inline_images.APIException","zohocrmsdk.src.com.zoho.crm.api.record.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate","zohocrmsdk.src.com.zoho.crm.api.roles.Role","zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","zohocrmsdk.src.com.zoho.crm.api.portals.Owner","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule","zohocrmsdk.src.com.zoho.crm.api.portals.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.APIException","zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll","zohocrmsdk.src.com.zoho.crm.api.timelines.Record","zohocrmsdk.src.com.zoho.crm.api.record.Reminder","zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline","zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps","zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition","zohocrmsdk.src.com.zoho.crm.api.variable_groups.MinifiedVariableGroup","zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup","zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.CountWrapper","zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate","zohocrmsdk.src.com.zoho.crm.api.holidays.CreateShiftHoliday","zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation","zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn","zohocrmsdk.src.com.zoho.crm.api.timelines.Info","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments","zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info","zohocrmsdk.src.com.zoho.crm.api.fields.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource","zohocrmsdk.src.com.zoho.crm.api.users.Tab","zohocrmsdk.src.com.zoho.crm.api.territory_users.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser","zohocrmsdk.src.com.zoho.crm.api.timelines.State","zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.notifications.Module","zohocrmsdk.src.com.zoho.crm.api.tags.NewTagRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.download_attachments.APIException","zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions","zohocrmsdk.src.com.zoho.crm.api.custom_views.Info","zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping","zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria","zohocrmsdk.src.com.zoho.crm.api.variable_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.convert_lead.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences.Module","zohocrmsdk.src.com.zoho.crm.api.users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.digest.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty1","zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation","zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.record.LineTax","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field","zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Resource","zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.Info","zohocrmsdk.src.com.zoho.crm.api.roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules","zohocrmsdk.src.com.zoho.crm.api.tags.Info","zohocrmsdk.src.com.zoho.crm.api.attachments.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User","zohocrmsdk.src.com.zoho.crm.api.record.Territory","zohocrmsdk.src.com.zoho.crm.api.custom_views.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","zohocrmsdk.src.com.zoho.crm.api.pipeline.JsonDetails","zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUserCount","zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTagRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.features.APIException","zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User","zohocrmsdk.src.com.zoho.crm.api.send_mail.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field","zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours","zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo","zohocrmsdk.src.com.zoho.crm.api.tags.CountResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config","zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule","zohocrmsdk.src.com.zoho.crm.api.definition.Property","zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMergeWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationWrapper","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_lists.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.profiles.Info","zohocrmsdk.src.com.zoho.crm.api.modules.Argument","zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","zohocrmsdk.src.com.zoho.crm.api.record.Criteria","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.digest.Dependee","zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI","zohocrmsdk.src.com.zoho.crm.api.notes.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portals.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry","zohocrmsdk.src.com.zoho.crm.api.users_territories.Validation","zohocrmsdk.src.com.zoho.crm.api.timelines.Module","zohocrmsdk.src.com.zoho.crm.api.org.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo","zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces","zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile","zohocrmsdk.src.com.zoho.crm.api.wizards.Button","zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","zohocrmsdk.src.com.zoho.crm.api.tags.Tag","zohocrmsdk.src.com.zoho.crm.api.users.Owner","zohocrmsdk.src.com.zoho.crm.api.record_locking.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesWrapper","zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty","zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery","zohocrmsdk.src.com.zoho.crm.api.variables.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings","zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail","zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module","zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module","zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate","zohocrmsdk.src.com.zoho.crm.api.related_records.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.bulk_write.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User","zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord","zohocrmsdk.src.com.zoho.crm.api.users.Info","zohocrmsdk.src.com.zoho.crm.api.coql.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.Users","zohocrmsdk.src.com.zoho.crm.api.mass_convert.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.pipeline.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFieldLookup","zohocrmsdk.src.com.zoho.crm.api.blueprint.Field","zohocrmsdk.src.com.zoho.crm.api.backup.Info","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming","zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info","zohocrmsdk.src.com.zoho.crm.api.cadences.Info","zohocrmsdk.src.com.zoho.crm.api.functions.APIException","zohocrmsdk.src.com.zoho.crm.api.files.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup","zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.functions.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.wizards.Element","zohocrmsdk.src.com.zoho.crm.api.record.Participants","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment","zohocrmsdk.src.com.zoho.crm.api.coql.ClauseDetails","zohocrmsdk.src.com.zoho.crm.api.features.Feature","zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.Tags","zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrappe","zohocrmsdk.src.com.zoho.crm.api.notes.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.LayoutRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data","zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","zohocrmsdk.src.com.zoho.crm.api.email_templates.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","zohocrmsdk.src.com.zoho.crm.api.features.Component","zohocrmsdk.src.com.zoho.crm.api.blueprint.Module","zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.Digest","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp","zohocrmsdk.src.com.zoho.crm.api.contact_roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord","zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource","zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdate","zohocrmsdk.src.com.zoho.crm.api.roles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.notifications.Event","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType","zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info","zohocrmsdk.src.com.zoho.crm.api.email_templates.Info","zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory","zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException","zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","zohocrmsdk.src.com.zoho.crm.api.change_owner.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field","zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup","zohocrmsdk.src.com.zoho.crm.api.bulk_write.RequestWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData","zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord","zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment","zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","zohocrmsdk.src.com.zoho.crm.api.cadences.Cadences","zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","zohocrmsdk.src.com.zoho.crm.api.notifications.Notification","zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience","zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.coql.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount","zohocrmsdk.src.com.zoho.crm.api.service_preference.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules","zohocrmsdk.src.com.zoho.crm.api.fields.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Info","zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Record","zohocrmsdk.src.com.zoho.crm.api.record.RemindAt","zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException","zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord","zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.Note","zohocrmsdk.src.com.zoho.crm.api.entity_scores.APIException","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal","zohocrmsdk.src.com.zoho.crm.api.user_groups.GetUnassignBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm","zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType","zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","zohocrmsdk.src.com.zoho.crm.api.wizards.Connection","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps","zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField","zohocrmsdk.src.com.zoho.crm.api.holidays.Holidays","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline","zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.Preference","zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCountWrapper","zohocrmsdk.src.com.zoho.crm.api.org.Resource","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields","zohocrmsdk.src.com.zoho.crm.api.backup.History","zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge","zohocrmsdk.src.com.zoho.crm.api.cadences.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field","zohocrmsdk.src.com.zoho.crm.api.record.Comment","zohocrmsdk.src.com.zoho.crm.api.related_records.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.SharingProperties","zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","zohocrmsdk.src.com.zoho.crm.api.variables.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.backup.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.MergeWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.org.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field","zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo","zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip","zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo","zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal","zohocrmsdk.src.com.zoho.crm.api.record_locking.Info","zohocrmsdk.src.com.zoho.crm.api.layouts.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException","zohocrmsdk.src.com.zoho.crm.api.backup.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.contact_roles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryOthers","zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info","zohocrmsdk.src.com.zoho.crm.api.record.TimeRange","zohocrmsdk.src.com.zoho.crm.api.notifications.Field","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module","zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","zohocrmsdk.src.com.zoho.crm.api.backup.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature","zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo","zohocrmsdk.src.com.zoho.crm.api.portal_invite.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout","zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber","zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles","zohocrmsdk.src.com.zoho.crm.api.layouts.SectionSubformField","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData","zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","zohocrmsdk.src.com.zoho.crm.api.currencies.Format","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.RoleRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module","zohocrmsdk.src.com.zoho.crm.api.users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes","zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge","zohocrmsdk.src.com.zoho.crm.api.from_addresses.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","zohocrmsdk.src.com.zoho.crm.api.email_drafts.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField","zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify","zohocrmsdk.src.com.zoho.crm.api.coql.ParseErrorDetails","zohocrmsdk.src.com.zoho.crm.api.mail_merge.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics","zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info","zohocrmsdk.src.com.zoho.crm.api.bulk_write.BulkWriteResponse","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee","zohocrmsdk.src.com.zoho.crm.api.email_drafts.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.Currency","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule","zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip","zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails","zohocrmsdk.src.com.zoho.crm.api.roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description","zohocrmsdk.src.com.zoho.crm.api.users.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","zohocrmsdk.src.com.zoho.crm.api.modules.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","zohocrmsdk.src.com.zoho.crm.api.tags.Resources","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User","zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference","zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info","zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status","zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete","zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView","zohocrmsdk.src.com.zoho.crm.api.roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge","zohocrmsdk.src.com.zoho.crm.api.custom_views.Field","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability","zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.From","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn","zohocrmsdk.src.com.zoho.crm.api.features.Limit","zohocrmsdk.src.com.zoho.crm.api.timelines.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.Currency","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord","zohocrmsdk.src.com.zoho.crm.api.send_mail.Data","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType","zohocrmsdk.src.com.zoho.crm.api.layouts.Sections","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule","zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.Info","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","zohocrmsdk.src.com.zoho.crm.api.user_groups.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner","zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue","zohocrmsdk.src.com.zoho.crm.api.related_records.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist","zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory","zohocrmsdk.src.com.zoho.crm.api.org.Org","zohocrmsdk.src.com.zoho.crm.api.profiles.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty","zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMergeWrapper","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField","zohocrmsdk.src.com.zoho.crm.api.user_groups.Field","zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner","zohocrmsdk.src.com.zoho.crm.api.record.LineItemProduct","zohocrmsdk.src.com.zoho.crm.api.user_type_users.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","zohocrmsdk.src.com.zoho.crm.api.attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties","zohocrmsdk.src.com.zoho.crm.api.coql.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action","zohocrmsdk.src.com.zoho.crm.api.record_locking.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType","zohocrmsdk.src.com.zoho.crm.api.wizards.Transition","zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.org.Feature","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section","zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users.Users","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","zohocrmsdk.src.com.zoho.crm.api.modules.Territory","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.BulkValidation","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink","zohocrmsdk.src.com.zoho.crm.api.holidays.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.CvidBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field","zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCountWrapper","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module","zohocrmsdk.src.com.zoho.crm.api.bulk_write.File","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option","zohocrmsdk.src.com.zoho.crm.api.associate_email.To","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance","zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ModuleDetails","zohocrmsdk.src.com.zoho.crm.api.functions.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.digest.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException","zohocrmsdk.src.com.zoho.crm.api.modules.Modules","zohocrmsdk.src.com.zoho.crm.api.notes.ParentId","zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectPicklist","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules","zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.backup.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.org.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Wrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress","zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status","zohocrmsdk.src.com.zoho.crm.api.bulk_read.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.Manager","zohocrmsdk.src.com.zoho.crm.api.modules.LookupField","zohocrmsdk.src.com.zoho.crm.api.custom_views.PinUnpinFields","zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portals.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User","zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula","zohocrmsdk.src.com.zoho.crm.api.fields.External","zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences","zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException","zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module","zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount","zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory","zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS","zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.Properties","zohocrmsdk.src.com.zoho.crm.api.available_currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.share_records.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address","zohocrmsdk.src.com.zoho.crm.api.pipeline.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","zohocrmsdk.src.com.zoho.crm.api.territories.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","zohocrmsdk.src.com.zoho.crm.api.notifications.Info","zohocrmsdk.src.com.zoho.crm.api.notifications.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields","zohocrmsdk.src.com.zoho.crm.api.business_hours.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency","zohocrmsdk.src.com.zoho.crm.api.features.Detail","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.To","zohocrmsdk.src.com.zoho.crm.api.attachments.APIException","zohocrmsdk.src.com.zoho.crm.api.field_attachments.APIException","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.variables.Variable","zohocrmsdk.src.com.zoho.crm.api.org.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.Module","zohocrmsdk.src.com.zoho.crm.api.fields.Private","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details","zohocrmsdk.src.com.zoho.crm.api.webforms.Module","zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups","zohocrmsdk.src.com.zoho.crm.api.territory_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes","zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_write.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.APIException","zohocrmsdk.src.com.zoho.crm.api.layouts.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence","zohocrmsdk.src.com.zoho.crm.api.holidays.Info","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule","zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","zohocrmsdk.src.com.zoho.crm.api.features.Info","zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId","zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday","zohocrmsdk.src.com.zoho.crm.api.user_groups.JobsWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitor","zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties","zohocrmsdk.src.com.zoho.crm.api.associate_email.Record","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField","zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord","zohocrmsdk.src.com.zoho.crm.api.territories.Field","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields","zohocrmsdk.src.com.zoho.crm.api.users.CountWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap","zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails","zohocrmsdk.src.com.zoho.crm.api.user_groups.GetAssignBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings","zohocrmsdk.src.com.zoho.crm.api.files.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.unblock_email.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users.Shift","zohocrmsdk.src.com.zoho.crm.api.record.Wizard","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.Field","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule","zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","zohocrmsdk.src.com.zoho.crm.api.definition.Definition","zohocrmsdk.src.com.zoho.crm.api.digest.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.Territories","zohocrmsdk.src.com.zoho.crm.api.notifications.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags","zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources","zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDeleteDetails","zohocrmsdk.src.com.zoho.crm.api.record.PricingDetails","zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.ImageUpload"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Mass Convert scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.GetRecordCountForTagParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNotesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.DeleteHolidayHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.GetAppointmentPreferenceParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.CountHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.APIException","zohocrmsdk.src.com.zoho.crm.api.users.CountWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.RecurringActivity":{"rrule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"RRULE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exdate":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"EXDATE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ResponseWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.tags.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.roles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","REQUIRED_PARAM_MISSING","MANDATORY_NOT_FOUND","PATTERN_NOT_MATCHED","INVALID_DATA","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter":{"notify_lead_owner":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_lead_owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"add_to_existing_record":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"add_to_existing_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"assign_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"assign_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"module":"Deals","name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags","request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"overwrite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"overwrite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"notify_new_entity_owner":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_new_entity_owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"move_attachments_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo","request_supported":["action","create","delete","read","update"],"name":"move_attachments_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.BodyWrapper":{"fiscal_year":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","request_supported":["action","create","delete","read","update"],"name":"fiscal_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack":{"method":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["post"],"name":"method","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Validation":{"records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments":{"service_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"service_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_size":{"regex":"[0-9]","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingFileParam":{"auth_type":{"name":"auth_type","type":"String","structure":false},"arguments":{"name":"arguments","type":"Map","structure":false},"upload_file_param":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"upload_file_param","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_drafts.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.email_drafts.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTagRequestWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_DATA","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions":{"module_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","request_supported":["action","create","delete","read","update"],"name":"module_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"preference_field_matched_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue","request_supported":["action","create","delete","read","update"],"name":"preference_field_matched_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue","unique_for":"none","structure":true},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"modules_with_multiple_layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules_with_multiple_layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ID_ALREADY_DELETED","CANNOT_UPDATE_DELETED_USER","AUTHORIZATION_FAILED","PATTERN_NOT_MATCHED","INVALID_REQUEST","LICENSE_LIMIT_EXCEEDED","DUPLICATE_DATA","INVALID_DATA","UNAPPROVABLE","MANDATORY_NOT_FOUND","EMAIL_UPDATE_NOT_ALLOWED","ID_ALREADY_DEACTIVATED","ID_ALREADY_ACTIVE","FEATURE_PERMISSION","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","EMAIL_UPDATE_NOT_ALOWED","INVALID_MODULE","BAD_REQUEST","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"owner_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","required field not found","invalid data","The http request method type is not a valid one","Please check whether the input values are correct","the id given seems to be invalid","Cannot add user under CRM Plus account. Kindly use CRMPlus URL to add user","Request exceeds your license limit. Need to upgrade in order to add","Failed to add user since same email id is already present","Email Id should not contain @skydesk.jp. Please choose a different email id","Invalid Email Id. Please choose a different email id","Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus","Company Name is required","Error occurred in resending the invitation of CRMPLUS user in CRM account","Cannot update the time_zone of another User","Either trial has expired or user does not have sufficient privilege to perform this action","Error occurred while updating CRMPlus User in CRM Account","invalid_data","Deleted user cannot be updated","Re-invite is not allowed for a confirmed user","Cannot update email of a confirmed CRM User","User with same email id is already in CRM Plus","User is already deactivated","Primary Contact cannot be deactivated","User is already active","Share among Subordinates Feature is not available","Profile and Role cannot be Updated by the user.","the_id_given_seems_to_be_invalid","Primary contact cannot be deleted","User is already deleted","User does not have sufficient privilege to delete users","Cannot update email of a confirmed CRM User"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.layouts.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.roles.ActionWrapper":{"roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.roles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.files.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["failure_in_attachment_handling","FILE_SIZE_MORE_THAN_ALLOWED_SIZE","INVALID_DATA","VIRUS_DETECTED","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Unavailability Hours saved successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord":{"locked_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Locked_Reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues":{"old_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","request_supported":["action","create","delete","read","update"],"name":"old_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","unique_for":"none","structure":true},"new_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","request_supported":["action","create","delete","read","update"],"name":"new_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.GetStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping":{"salesorders":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"SalesOrders","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"invoices":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"Invoices","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers":{"action_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["sign","approve"],"name":"action_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"recipient":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","request_supported":["action","create","delete","read","update"],"name":"recipient","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","unique_for":"none","structure":true},"recipient_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"recipient_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferWrapper":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria_matched":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria_matched","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.UpdateVariableByIDParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","request_supported":["action","create","delete","read","update"],"name":"Sales_Orders","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","request_supported":["action","create","delete","read","update"],"name":"Invoices","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.Digest":{"record_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Module":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.CvidBodyWrapper":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.modules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.BodyWrapper":{"merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge"},"request_supported":["action","create","delete","read","update"],"name":"merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Wrapper":{"privacy_configurable_apps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps"},"request_supported":["action","create","delete","read","update"],"name":"privacy_configurable_apps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.profiles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territories.ActionWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence"},"request_supported":["action","create","delete","read","update"],"name":"cadences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseWrapper":{"contact_roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole"},"request_supported":["action","create","delete","read","update"],"name":"contact_roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Wrapper":{"related_lists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists"},"request_supported":["action","create","delete","read","update"],"name":"related_lists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.GetScoringRulesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true,false],"name":"active","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.GetProfilesHeader":{},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.variable_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery":{"unit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"period":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"period","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.CreateBusinessHoliday":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.GetWebFormParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.BodyWrapper":{"map_dependency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency"},"request_supported":["action","create","delete","read","update"],"name":"map_dependency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.NewTagRequestWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.GetAppointmentsRescheduledHistoryParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"parent":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","request_supported":["action","create","delete","read","update"],"name":"parent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","unique_for":"none","structure":true},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"maps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps"},"request_supported":["action","create","delete","read","update"],"name":"maps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"child_available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"child_available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.GetDownloadInlineImagesParam":{"user_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionSubformField":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal":{"user_type_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_type_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"language":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["en_US","en_GB","bg_BG","zh_CN","zh_TW","hr_HR","ar_EG","in_ID","cs_CZ","da_DK","nl_NL","fr_FR","de_DE","hu_HU","","hi_IN","it_IT","ja_JP","pl_PL","pt_BR","pt_PT","ru_RU","es_ES","sv_SE","th_TH","tr_TR","vi_VN","ko_KR","iw_IL"],"name":"language","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invite","reinvite"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress"},"request_supported":["action","create","delete","read","update"],"name":"blocked_email_addresses","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.GetZiaOrgEnrichmentsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","FAILED","DATA_NOT_FOUND"],"name":"status","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts":{"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template","request_supported":["action","create","delete","read","update"],"name":"template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template","unique_for":"none","structure":true},"schedule_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails","request_supported":["action","create","delete","read","update"],"name":"schedule_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails","unique_for":"none","structure":true},"summary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"bcc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To"},"request_supported":["action","create","delete","read","update"],"name":"bcc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"email_opt_out":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_opt_out","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reply_to":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"rich_text":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rich_text","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"inventory_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails","request_supported":["action","create","delete","read","update"],"name":"inventory_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseWrapper":{"emailssharingdetails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings"},"request_supported":["action","create","delete","read","update"],"name":"__emails_sharing_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.PricingDetails":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"to_range":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to_range","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"discount":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"discount","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"from_range":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from_range","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.File":{"skipped_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"skipped_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"updated_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"added_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"added_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ADDED","IN PROGRESS","COMPLETED","SKIPPED","FAILED"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS","SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Button":{"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shape":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shape","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"visibility":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visibility","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reference_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reference_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resource":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","unique_for":"none","structure":true},"target_screen":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","request_supported":["action","create","delete","read","update"],"name":"target_screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Message","request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Message","unique_for":"none","structure":true},"transition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Transition","request_supported":["action","create","delete","read","update"],"name":"transition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Transition","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"background_color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"background_color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetGroupedCountsParam":{"group_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_by","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.templates.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Appointments preferences updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionWrapper":{"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"personality_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule","request_supported":["action","create","delete","read","update"],"name":"personality_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","unique_for":"none","structure":true},"no_of_users":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"no_of_users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record will be shared successfully","Sharing Revoked"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Org Enrichment scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"External_Deal_ID","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["relation added","relation removed"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.webforms.UpdateWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","unique_for":"none","structure":true},"duration_configured_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"duration_configured_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI":{"path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"operation_types":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes"},"request_supported":["action","create","delete","read","update"],"name":"operation_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.inventory_templates.APIException","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address":{"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"city":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"city","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pin_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pin_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fill_address":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fill_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.LayoutRequestWrapper":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.variables.ActionWrapper":{"variables":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"variables","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionWrapper":{"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_DATA","NOT_ALLOWED","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval":{"delegate":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delegate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"approve":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approve","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"reject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"resubmit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resubmit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics":{"analytics":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false,"extend_property":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall","request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask","request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert","request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert","unique_for":"none","structure":true}]},"parent_follow_up":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp","request_supported":["action","create","delete","read","update"],"name":"parent_follow_up","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp","unique_for":"none","structure":true},"action":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action","request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status":{"first_open":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_open","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"bounced_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sub_category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sub_category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"bounced_reason":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced_reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_open":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_open","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.GetEntityScoresHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.GetZiaPeopleEnrichmentsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","FAILED","DATA_NOT_FOUND"],"name":"status","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_DATA","NOT_SUPPORTED","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Limit":{"edition_limit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edition_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdate":{"updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"not_updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Not_Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","RUNNING","FAILED"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules":{"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"lock_existing_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lock_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces":{"resources":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.BodyWrapper":{"roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.Role","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.roles.Role"},"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Comment":{"commented_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"commented_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"commented_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"commented_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"comment_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comment_content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.BodyWrapper":{"portal_user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType","request_supported":["action","create","delete","read","update"],"name":"portal_user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType","unique_for":"none","structure":true},"apply_assignment_threshold":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"apply_assignment_threshold","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assign_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo","request_supported":["action","create","delete","read","update"],"name":"assign_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo"},"request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"move_attachments_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","request_supported":["action","create","delete","read","update"],"name":"move_attachments_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The multi-currency feature is enabled and given currency is created as the base currency.","The currency created successfully.","The currency updated successfully."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.BodyWrapper":{"audit_log_export":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport"},"request_supported":["action","create","delete","read","update"],"name":"audit_log_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDeleteDetails"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.service_preference.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.digest.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","DEPENDENT_PARAM_MISSING","MANDATORY_NOT_FOUND","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.digest.Dependee","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.digest.Dependee","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found","Permission Denied."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DeleteRelatedRecordsUsingExternalIDParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.InventoryConverter":{"convert_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo"},"name":"convert_to","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.CheckStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","unique_for":"none","structure":true},"chart_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","request_supported":["action","create","delete","read","update"],"name":"chart_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","unique_for":"none","structure":true},"screens":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen"},"request_supported":["action","create","delete","read","update"],"name":"screens","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource","request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource","unique_for":"none","structure":true},"detail":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule","request_supported":["action","create","delete","read","update"],"name":"detail","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsUsingExternalIDParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetGroupsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","name":"filters","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ResponseWrapper":{"data_enrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"data_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionWrapper":{"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceBodyWrapper":{"replace_picklist_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues"},"request_supported":["action","create","delete","read","update"],"name":"replace_picklist_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.BodyWrapper":{"mass_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete"},"request_supported":["action","create","delete","read","update"],"name":"mass_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroupsWrapper","zohocrmsdk.src.com.zoho.crm.api.users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.coql.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["LIMIT_EXCEEDED","SYNTAX_ERROR","INVALID_QUERY","DUPLICATE_DATA","DUPLICATE_ALIAS","INVALID_ALIAS","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"near","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"line","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clause","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid query formed","value given seems to be invalid for the column","data type not supported","column given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.notifications.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming":{"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"LocalTime"},"request_supported":["action","create","delete","read","update"],"name":"shift_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance":{"restrict_data_access_through_api":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_data_access_through_api","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"enabled_for_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules"},"request_supported":["action","create","delete","read","update"],"name":"enabled_for_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"restrict_to_zoho_apps":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_to_zoho_apps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"restrict_data_in_export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_data_in_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"restrict_to_third_party_apps":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"restrict_to_third_party_apps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.BodyWrapper":{"data_enrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"data_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert":{"email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"cliked_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cliked_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"bounced_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"replied_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"replied_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"email_spam_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_spam_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sent_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"unsent_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unsent_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"opened_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"opened_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"unsubscribed_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unsubscribed_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseWrapper":{"unsubscribe_links":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks"},"request_supported":["action","create","delete","read","update"],"name":"unsubscribe_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline":{"delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete","request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portals.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portals.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portals.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ResponseWrapper":{"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.Note":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"note_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Note_Content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"$attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"note_title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Note_Title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"voice_note":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$voice_note","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sharing_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$sharing_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"parent_id":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.ParentId","request_supported":["action","create","delete","read","update"],"name":"Parent_Id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notes.ParentId","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"is_shared_to_client":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$is_shared_to_client","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS":{"module":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.GetFeatureDetailParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData":{"crm_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","request_supported":["action","create","delete","read","update"],"name":"crm_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","unique_for":"none","structure":true},"enrich_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","request_supported":["action","create","delete","read","update"],"name":"enrich_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNoteHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.UrlsWrapper":{"urls":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Urls","request_supported":["action","create","delete","read","update"],"name":"urls","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Urls","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.Record":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields":{"pin":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_pin","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.webforms.APIException","zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NOT_SUPPORTED","NO_PERMISSION","INVALID_DATA","AMBIGUITY_DURING_PROCESSING","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","UNABLE_TO_PARSE_DATA_TYPE","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the id given seems to be invalid","either the request body or parameters is in wrong format","the owner id given is invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetUnassignBodyWrapper":{"get_unassigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","request_supported":["action","create","delete","read","update"],"name":"get_unassigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.RoleRequestWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion":{"available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_templates.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.DeleteRoleParam":{"transfer_to_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_to_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User":{"zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"full_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"full_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signature":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature","request_supported":["action","create","delete","read","update"],"name":"signature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature","unique_for":"none","structure":true},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground":{"button_background":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"button_background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionWrapper":{"fiscal_year":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"fiscal_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder":{"process_entry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"process_entry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"process_exit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"process_exit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.State","request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.State","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionWrapper":{"data_enrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"duplicate_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"duplicate_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["insert","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully","record updated","record deleted","record added","photo uploaded successfully","Photo deleted","the territories data updated successfully","the territories are removed successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.BodyWrapper":{"appointment_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","request_supported":["action","create","delete","read","update"],"name":"appointment_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.BodyWrapper":{"process":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"process","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"name":"data","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100},"lar_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lar_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"trigger":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"trigger","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"duplicate_check_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"duplicate_check_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ResponseWrapper":{"variables":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable"},"request_supported":["action","create","delete","read","update"],"name":"variables","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseWrapper":{"business_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","request_supported":["action","create","delete","read","update"],"name":"business_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetAssociationsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCountWrapper":{"associated_users_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount"},"request_supported":["action","create","delete","read","update"],"name":"associated_users_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Data":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.GetVariablesParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseWrapper":{"merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge"},"request_supported":["action","create","delete","read","update"],"name":"merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.UpdateHolidaysHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseWrapper":{"appointment_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","request_supported":["action","create","delete","read","update"],"name":"appointment_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TSerial","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":50},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsUsingExternalIDHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ChangeSortOrderOfCustomViewsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.BodyWrapper":{"custom_views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews"},"request_supported":["action","create","delete","read","update"],"name":"custom_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.UpdateDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory":{"transfer_to_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_to_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete_previous_forecasts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_previous_forecasts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"quick_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.TransferUsersOfAUserTypeParam":{"personality_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"transfer_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_To","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap":{"mergefieldsdata":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mergeFieldsData","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"features_available":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable","request_supported":["action","create","delete","read","update"],"name":"features_available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable","unique_for":"none","structure":true},"relay_domains":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"relay_domains","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User","request_supported":["action","create","delete","read","update"],"name":"user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User","unique_for":"none","structure":true},"from_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress"},"request_supported":["action","create","delete","read","update"],"name":"from_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.apis.GetSupportedAPIParam":{"filters":{"name":"filters","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance":{"restricted_in_export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted_in_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"restricted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"duplicate_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"duplicate_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["insert","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"External_Contact_ID","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approval_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully","record updated","record deleted","record added","photo uploaded successfully","Photo deleted","the territories data updated successfully","the territories are removed successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status":{"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ADDED_SUCCESSFULLY"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","IN PROGRESS","ADDED","FAILURE"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Added successfully."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.files.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.files.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.BodyWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner","unique_for":"none","structure":true},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["owner is successfully updated"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseWrapper":{"conversionoptions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions","request_supported":["action","create","delete","read","update"],"name":"__conversion_options","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Message":{"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFieldLookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields"},"request_supported":["action","create","delete","read","update"],"name":"show_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"revalidate_filter_during_edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"revalidate_filter_during_edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"query_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","request_supported":["action","create","delete","read","update"],"name":"query_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.CreateMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseWrapper":{"mass_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"mass_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NO_PERMISSION","MANDATORY_NOT_FOUND","INVALID_MODULE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.ActionWrapper":{"portals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"portals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.DeleteContactRolesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.Portals":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"min_length":6,"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":30},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"zaid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zaid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Expression":{"function_parameters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter"},"request_supported":["action","create","delete","read","update"],"name":"function_parameters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria","unique_for":"none","structure":true},"function":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"function","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PATTERN_NOT_MATCHED","DEPENDENT_FIELD_MISSING","MANDATORY_NOT_FOUND","INVALID_DATA","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Please check whether the input values are correct","Shift id is required for shift holidays","required field not found","invalid data","duplicate data","Invalid ID"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.BodyWrapper":{"ziapeopleenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"__zia_people_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.LineTax":{"percentage":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"percentage","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"display_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.user_groups.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.BodyWrapper":{"contact_roles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole"},"name":"contact_roles","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference":{"consent_modules":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_tpt_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_tpt_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_zoho":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_zoho","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"awaiting_period":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"awaiting_period","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"consent_mail_send":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_mail_send","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_export_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_export_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"limit_actions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit_actions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_zoho_integ":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_zoho_integ","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_zoho_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_zoho_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"duration_timing":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"duration_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_processing_duration":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_processing_duration","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_tpt_services":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_tpt_services","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_tpt_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_tpt_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_zoho_integ_services":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_zoho_integ_services","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"privacy_setting_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"privacy_setting_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"double_opt_in":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"double_opt_in","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_zoho_integ_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_zoho_integ_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_tpt":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_tpt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"block_list":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"block_list","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_tpt":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_tpt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actions_while_awaiting":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actions_while_awaiting","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.DeleteShiftHourHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"associated_places":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces"},"request_supported":["action","create","delete","read","update"],"name":"associated_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionWrapper":{"record_locking_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"record_locking_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.GetAssociatedGroupsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMergeWrapper":{"sign_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge"},"request_supported":["action","create","delete","read","update"],"name":"sign_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours":{"custom_timing":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming"},"request_supported":["action","create","delete","read","update"],"name":"custom_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"users_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"users_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"daily_timing":{"response_supported":["action","create","delete","read","update"],"min_length":2,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":false,"sub_type":{"type":"LocalTime"},"name":"daily_timing","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":2},"timezone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"timezone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TTimeZone","nullable_for":"none","type":"TimeZone","unique_for":"none","structure":false},"break_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours"},"request_supported":["action","create","delete","read","update"],"name":"break_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_days":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"shift_days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"same_as_everyday":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"same_as_everyday","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.GetUserHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module","unique_for":"none","structure":true},"tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag"},"name":"tags","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":200}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails":{"inventory_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate","request_supported":["action","create","delete","read","update"],"name":"inventory_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource":{"field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping"},"request_supported":["action","create","delete","read","update"],"name":"field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.File","request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.File","unique_for":"none","structure":true},"file_names":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"file_names","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"ignore_empty":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ignore_empty","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"file_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"find_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"find_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["data"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ADDED","IN PROGRESS","COMPLETED","SKIPPED","FAILED"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.SharingProperties":{"scheduler_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduler_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"share_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["full-access","read-write","read-only"],"name":"share_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"share_preference_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_preference_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.History":{"done_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","request_supported":["action","create","delete","read","update"],"name":"done_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","unique_for":"none","structure":true},"repeat_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"repeat_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"log_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"log_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.ResponseWrapper":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseWrapper":{"from_addresses":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address"},"request_supported":["action","create","delete","read","update"],"name":"from_addresses","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.SearchRecordsParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"word":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"word","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.GetRelatedListParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false,"extend_property":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"DateTime"},"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User"},"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module"},"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}]},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge":{"sign_in_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign_in_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"signers":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers"},"request_supported":["action","create","delete","read","update"],"name":"signers","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_merge_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","request_supported":["action","create","delete","read","update"],"name":"mail_merge_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","unique_for":"none","structure":true},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":255}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionWrapper":{"unsubscribe_links":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"unsubscribe_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"uid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"uid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"startDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"startDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"on_demand_properties":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"on_demand_properties","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"endDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"endDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"territory_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the module name given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.related_records.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.CreateFieldParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Transition":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport":{"download_links":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"download_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","unique_for":"none","structure":true},"job_end_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_end_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"expiry_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expiry_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"job_start_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_start_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Wrapper":{"privacypreference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference"},"request_supported":["action","create","delete","read","update"],"name":"privacyPreference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeWrapper":{"send_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge"},"request_supported":["action","create","delete","read","update"],"name":"send_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.ActionWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.files.APIException","zohocrmsdk.src.com.zoho.crm.api.files.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.BodyWrapper":{"assign_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User","request_supported":["action","create","delete","read","update"],"name":"assign_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":50},"convert_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo"},"name":"convert_to","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty":{"pinned_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pinned_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the relation name given seems to be invalid","the module name given seems to be invalid","the related id given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.templates.Templates":{"folder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","request_supported":["action","create","delete","read","update"],"name":"folder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"consent_linked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_linked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"favourite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favourite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"attachment_present":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"attachment_present","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails":{"timezone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"timezone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TTimeZone","nullable_for":"none","type":"TimeZone","unique_for":"none","structure":false},"time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.modules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary":{"return_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expression":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Expression","request_supported":["action","create","delete","read","update"],"name":"expression","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Expression","unique_for":"none","structure":true},"based_on_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"based_on_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"related_list":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"related_list","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"rollup_based_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rollup_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.BodyWrapper":{"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType"},"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.ResponseWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.functions.APIException","zohocrmsdk.src.com.zoho.crm.api.functions.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.webforms.APIException","zohocrmsdk.src.com.zoho.crm.api.webforms.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users":{"personality_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"confirm":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"confirm","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"status_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status_reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"invited_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"invited_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature":{"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sign":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.ActionWrapper":{"digest":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.digest.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.digest.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__digest","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Holidays created successfully","Holidays updated successfully","Holidays deleted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Business Hours saved successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.BodyWrapper":{"global_picklists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist"},"request_supported":["action","create","delete","read","update"],"name":"global_picklists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.UpdateShiftHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users":{"role":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role","request_supported":["action","create","delete","read","update"],"name":"role","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"effective_from":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"effective_from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.GetUserUnavailabilityParam":{"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.files.APIException","zohocrmsdk.src.com.zoho.crm.api.files.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionWrapper":{"scrapy_feedback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionResponse","request_supported":["action","create","delete","read","update"],"name":"scrapy_feedback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_templates.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseWrapper":{"email_templates":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate"},"request_supported":["action","create","delete","read","update"],"name":"email_templates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.UploadFileHeader":{"feature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"X_crm_org":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-CRM-ORG","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty1":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.conversion_option.APIException","zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"structure_name":"String","request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"structure_name":"Long","request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Profile":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber":{"starting_number_length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"starting_number_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"prefix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"start_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"suffix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"suffix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Detail":{"available_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","request_supported":["action","create","delete","read","update"],"name":"available_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","unique_for":"none","structure":true},"used_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","request_supported":["action","create","delete","read","update"],"name":"used_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","unique_for":"none","structure":true},"limits":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","request_supported":["action","create","delete","read","update"],"name":"limits","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Role":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback":{"feedback":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["negative","positive"],"name":"feedback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"comment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["organization","personal"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"enrich_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["jRsJ7grCwzJfs4B384k4zY3OFsLIE+EGt9AwDDtb4j4="],"name":"enrich_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCountWrapper":{"sources_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount"},"request_supported":["action","create","delete","read","update"],"name":"sources_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll":{"exclude_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["QUEUED","SCHEDULED","COMPLETED","RUNNING","FAILED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.BodyWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.CreateBusinessHoliday","zohocrmsdk.src.com.zoho.crm.api.holidays.CreateShiftHoliday"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency":{"symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"is_active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"exchange_rate":{"regex":"[1-9][0-9]{1,8}[.][0-9]{9}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exchange_rate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"format":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","request_supported":["action","create","delete","read","update"],"name":"format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"prefix_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"is_base":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_base","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseWrapper":{"pick_list_values_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.External":{"allow_multiple_config":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allow_multiple_config","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_REQUEST","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid"],"name":"related_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment":{"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Info":{"license_limit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"license_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.entity_scores.APIException","zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.templates.Wrapper":{"templates":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.templates.Templates","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.templates.Templates"},"request_supported":["action","create","delete","read","update"],"name":"templates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.DeleteWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule"},"request_supported":["action","create","delete","read","update"],"name":"field_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":25},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":500},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signal_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule"},"request_supported":["action","create","delete","read","update"],"name":"signal_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.definition.Property":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"allowed_values":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"allowed_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"regex":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty"},"request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionWrapper":{"merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ResponseWrapper":{"portal_invite":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse"},"request_supported":["action","create","delete","read","update"],"name":"portal_invite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition":{"next_transitions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition"},"request_supported":["action","create","delete","read","update"],"name":"next_transitions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"execution_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"execution_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sequence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_field_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_field_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"text_color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"text_color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria_matched":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria_matched","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"parent_transition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","request_supported":["action","create","delete","read","update"],"name":"parent_transition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Field","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Field"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"percent_partial_save":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"percent_partial_save","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.BodyWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber":{"prefix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"start_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"suffix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"suffix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Info":{"call":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_DATA","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["cvid","id","Owner"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the module name given seems to be invalid","required field not found","the cvid given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"structure_name":"String","request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"structure_name":"Long","request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"structure_name":"String","request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notifications.BodyWrapper":{"watch":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification"},"request_supported":["action","create","delete","read","update"],"name":"watch","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException","zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"component":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"component","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"feature_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["used","unused","all"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts":{"has_more_profiles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_more_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping","unique_for":"none","structure":true},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_for":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_for","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"subform_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty","request_supported":["action","create","delete","read","update"],"name":"subform_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty","unique_for":"none","structure":true},"sections":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Sections","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Sections"},"request_supported":["action","create","delete","read","update"],"name":"sections","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_business_card":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_business_card","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"actions_allowed":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed","request_supported":["action","create","delete","read","update"],"name":"actions_allowed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"generated_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"generated_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.UploadUrlAttachmentsParam":{"attachmentUrl":{"regex":"[a-zA-Z]{10}[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"attachmentUrl","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.GetFileParam":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.CreateBusinessHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"maps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap"},"request_supported":["action","create","delete","read","update"],"name":"maps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseWrapper":{"watch":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification"},"request_supported":["action","create","delete","read","update"],"name":"watch","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"download_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"download_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionWrapper":{"business_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"business_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.UpdateTagParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.download_inline_images.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.download_inline_images.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.convert_lead.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.Holidays":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.CountWrapper":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.BodyWrapper":{"file_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ics","csv"],"name":"file_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"query":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","request_supported":["action","create","delete","read","update"],"name":"query","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","unique_for":"none","structure":true},"callback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack","request_supported":["action","create","delete","read","update"],"name":"callback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Node":{"pos_y":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pos_y","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"pos_x":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pos_x","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"start_node":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_node","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"screen":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","request_supported":["action","create","delete","read","update"],"name":"screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record updated","mass update scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.ImageUpload":{"owner__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"preview_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Preview_Id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"file_name__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Name__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Sequence_Number__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"State__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"size__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Size__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Description__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Territory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"assigned":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$assigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"assigned_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"$assigned_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"assigned_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$assigned_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency":{"parent":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent","request_supported":["action","create","delete","read","update"],"name":"parent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent","unique_for":"none","structure":true},"internal":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"internal","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"child":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child","request_supported":["action","create","delete","read","update"],"name":"child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException","zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference":{"preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference","request_supported":["action","create","delete","read","update"],"name":"preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference","unique_for":"none","structure":true},"config":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config","request_supported":["action","create","delete","read","update"],"name":"config","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company":{"website":{"regex":"www[.][a-z0-9]+[.][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.APIException","zohocrmsdk.src.com.zoho.crm.api.users.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.taxes.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutHeader":{},"zohocrmsdk.src.com.zoho.crm.api.webforms.GetWebformsPreviewParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.modules.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["module created"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldHeader":{},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax":{"preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.Preference","request_supported":["action","create","delete","read","update"],"name":"preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.taxes.Preference","unique_for":"none","structure":true},"taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.Tax","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.taxes.Tax"},"request_supported":["action","create","delete","read","update"],"name":"taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseWrapper":{"fiscal_year":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","request_supported":["action","create","delete","read","update"],"name":"fiscal_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields":{"pin":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_pin","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.GetMassDeleteStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module","unique_for":"none","structure":true},"input_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData"},"request_supported":["action","create","delete","read","update"],"name":"input_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true},"output_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData"},"request_supported":["action","create","delete","read","update"],"name":"output_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.Consent":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"contact_through_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"data_processing_basis":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Data_Processing_Basis","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"contact_through_social":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Social","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"contact_through_phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Phone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"consent_remarks":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Consent_Remarks","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"contact_through_survey":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Survey","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"consent_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Consent_Date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_sent_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Mail_Sent_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"consent_through":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Consent_Through","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.SuccessWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionWrapper":{"assignment_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"assignment_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.LineItemProduct":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"product_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Product_Code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes":{"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.ActionWrapper":{"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option":{"suboptions":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"suboptions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.BodyWrapper":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner","unique_for":"none","structure":true},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","unique_for":"none","structure":true},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.GetUsersParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ActiveUsers","DeactiveUsers","NotConfirmedUsers","ConfirmedUsers","CurrentUser","ActiveConfirmedUsers"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.UpdateVariableByAPINameParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Container":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","unique_for":"none","structure":true},"chart_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","request_supported":["action","create","delete","read","update"],"name":"chart_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","unique_for":"none","structure":true},"screens":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen"},"request_supported":["action","create","delete","read","update"],"name":"screens","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enriched_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData","request_supported":["action","create","delete","read","update"],"name":"enriched_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enrich_based_on":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn","request_supported":["action","create","delete","read","update"],"name":"enrich_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference":{"job_sheet_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_sheet_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sources_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","request_supported":["action","create","delete","read","update"],"name":"sources_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources"},"request_supported":["action","create","delete","read","update"],"name":"sources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField":{"associated_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"associated_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"operation_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","request_supported":["action","create","delete","read","update"],"name":"operation_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","unique_for":"none","structure":true},"updateexistingrecords":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_update_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"colour_code_enabled_by_system":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code_enabled_by_system","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","unique_for":"none","structure":true},"textarea":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","request_supported":["action","create","delete","read","update"],"name":"textarea","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customizable_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"customizable_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","unique_for":"none","structure":true},"businesscard_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"businesscard_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"sharing_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","request_supported":["action","create","delete","read","update"],"name":"sharing_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"refer_from_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","request_supported":["action","create","delete","read","update"],"name":"refer_from_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","unique_for":"none","structure":true},"subform":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","request_supported":["action","create","delete","read","update"],"name":"subform","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","unique_for":"none","structure":true},"separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"searchable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"searchable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"virtual_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"virtual_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"allowed_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"allowed_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"validation_rule":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"validation_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"auto_number_70":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"section_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"section_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"file_upolad_optionlist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption"},"request_supported":["action","create","delete","read","update"],"name":"file_upolad_optionlist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"static_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues"},"request_supported":["action","create","delete","read","update"],"name":"static_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"email_parser":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","request_supported":["action","create","delete","read","update"],"name":"email_parser","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","unique_for":"none","structure":true},"multiuserlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiuserlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","unique_for":"none","structure":true},"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","unique_for":"none","structure":true},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","unique_for":"none","structure":true},"rollup_summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","request_supported":["action","create","delete","read","update"],"name":"rollup_summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","unique_for":"none","structure":true},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"global_picklist":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"autonumber":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"autonumber","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","unique_for":"none","structure":true},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","unique_for":"none","structure":true},"static_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"static_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"additional_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"additional_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"mass_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mass_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"blueprint_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"blueprint_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord":{"shared_with":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","request_supported":["action","create","delete","read","update"],"name":"shared_with","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Users","unique_for":"none","structure":true},"share_related_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_related_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"shared_through":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough","request_supported":["action","create","delete","read","update"],"name":"shared_through","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough","unique_for":"none","structure":true},"shared_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","request_supported":["action","create","delete","read","update"],"name":"shared_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Users","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["public","private"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","request_supported":["action","create","delete","read","update"],"name":"user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Users","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ModuleDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.GetEmailsRelatedRecordParam":{"owner_id":{"name":"owner_id","type":"Long","structure":false},"type":{"name":"type","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Maps":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.GetInventoryTemplatesParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord":{"deleted_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"deleted_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"display_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"deleted_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","MANDATORY_NOT_FOUND","LIMIT_EXCEEDED","DEPENDENT_FIELD_MISSING","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"dummy","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionWrapper":{"emails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"Emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.BodyWrapper":{"business_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","request_supported":["action","create","delete","read","update"],"name":"business_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linking_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"linking_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"lookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connected_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"connected_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedfield_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedfield_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedlookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedlookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"record_access":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_access","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.GetPickListValuesParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Record":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability":{"comments":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":250},"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"service":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"service","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"all_day":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"all_day","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tp_event_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tp_event_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User","request_supported":["action","create","delete","read","update"],"name":"user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User","unique_for":"none","structure":true},"tp_calendar_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tp_calendar_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.GetUsersUnavailabilityParam":{"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"group_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"role_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough":{"entity_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"entity_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.share_records.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["equal"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseWrapper":{"ziapeopleenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"__zia_people_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseWrapper":{"associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordUsingExternalIDParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"uid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"uid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"startDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"startDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"endDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"endDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"territory_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.coql.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.coql.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.Properties":{"reorder_rows":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reorder_rows","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip","unique_for":"none","structure":true},"maximum_rows":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_rows","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.currencies.BodyWrapper":{"currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency"},"request_supported":["action","create","delete","read","update"],"name":"currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["tax added","tax updated"," tax deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordsParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"endDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"endDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"uid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"uid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"startDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"startDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete":{"move_subordinate":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","request_supported":["action","create","delete","read","update"],"name":"move_subordinate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","unique_for":"none","structure":true},"transfer":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","request_supported":["action","create","delete","read","update"],"name":"transfer","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionWrapper":{"portal_invite":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"portal_invite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Element":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Resource","request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Resource","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.send_mail.To":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionWrapper":{"global_picklists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"global_picklists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portals.APIException","zohocrmsdk.src.com.zoho.crm.api.portals.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionWrapper":{"replace_picklist_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"replace_picklist_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseWrapper":{"wizards":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard"},"request_supported":["action","create","delete","read","update"],"name":"wizards","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.taxes.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["EXPECTED_FIELD_MISSING","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","MANDATORY_NOT_FOUND","INVALID_DATA","INTERNAL_ERROR","REQUIRED_PARAM_MISSING","BAD_REQUEST","NO_PERMISSION","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deprecated_version","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","required field not found","Sequence number out of range","Sequence number cannot be repeated in same request","Given ID does not exist","tax not deleted","One of the expected parameter is missing"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCountWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUserCount","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCountWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia":{"media_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"media_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"media_url":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"media_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.GetHolidaysParam":{"year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"year","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false,"max_length":4},"shift_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shift_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["business_holiday","shift_holiday"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["users","roles","groups","territories"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.GetRecordLockingInformationParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.DetailsWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.coql.ClauseDetails","zohocrmsdk.src.com.zoho.crm.api.coql.ParseErrorDetails"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdate"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable":{"inline_compose_window":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"inline_compose_window","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"schedule_mail":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"Schedule_Mail","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"islivedeskenabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"isLiveDeskEnabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"email_cloud_picker":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"EMAIL_CLOUD_PICKER","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"old_compose_revert":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"OLD_COMPOSE_REVERT","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"attach_teamdrive":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"attach_teamdrive","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"mandateunsublink":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mandateUnsubLink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unsubscribe_link":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"UNSUBSCRIBE_LINK","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"email_preference":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"EMAIL_PREFERENCE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"form_integration_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"form_integration_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ATTACHMENT","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"isprivacyenabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"isPrivacyEnabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"best_time_to_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"best_time_to_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"auto_suggestion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"auto_suggestion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"zsurvey_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"zsurvey_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"subject_line_suggestion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject_line_suggestion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt":{"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"encfldids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"encFldIds","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"table":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"table","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.available_currencies.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.taxes.Tax":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territory_users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territory_users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.business_hours.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences":{"strictly_reporting":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"strictly_reporting","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Reporting_To_Hierarchy","Role_Hierarchy"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.GetRecordMergeParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.field_attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.backup.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.backup.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.backup.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","BAD_REQUEST","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUserCount":{"associated_users_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser"},"request_supported":["action","create","delete","read","update"],"name":"associated_users_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields":{"associated_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"associated_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"operation_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","request_supported":["action","create","delete","read","update"],"name":"operation_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","unique_for":"none","structure":true},"updateexistingrecords":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_update_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"colour_code_enabled_by_system":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code_enabled_by_system","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","unique_for":"none","structure":true},"textarea":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","request_supported":["action","create","delete","read","update"],"name":"textarea","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customizable_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"customizable_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","unique_for":"none","structure":true},"businesscard_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"businesscard_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"sharing_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","request_supported":["action","create","delete","read","update"],"name":"sharing_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"refer_from_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","request_supported":["action","create","delete","read","update"],"name":"refer_from_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","unique_for":"none","structure":true},"subform":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","request_supported":["action","create","delete","read","update"],"name":"subform","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","unique_for":"none","structure":true},"separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"searchable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"searchable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"virtual_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"virtual_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","unique_for":"none","structure":true},"auto_number_65":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"allowed_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"allowed_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_upolad_optionlist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption"},"request_supported":["action","create","delete","read","update"],"name":"file_upolad_optionlist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email_parser":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","request_supported":["action","create","delete","read","update"],"name":"email_parser","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","unique_for":"none","structure":true},"multiuserlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiuserlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","unique_for":"none","structure":true},"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","unique_for":"none","structure":true},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","unique_for":"none","structure":true},"rollup_summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","request_supported":["action","create","delete","read","update"],"name":"rollup_summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","unique_for":"none","structure":true},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"global_picklist":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"autonumber":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"autonumber","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","unique_for":"none","structure":true},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","unique_for":"none","structure":true},"additional_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"additional_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"static_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"static_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"mass_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mass_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"blueprint_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"blueprint_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetGlobalPicklistParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags":{"deals":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"accounts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"contacts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enriched_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData","request_supported":["action","create","delete","read","update"],"name":"enriched_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enrich_based_on":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn","request_supported":["action","create","delete","read","update"],"name":"enrich_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue":{"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch"},"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch"},"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch"},"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Profile":{"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseWrapper":{"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.MergeWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper"},"name":"tags","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.BodyWrapper":{"duplicate_check_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","request_supported":["action","create","delete","read","update"],"name":"duplicate_check_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.Urls":{"data_links":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"data_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"attachment_links":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"attachment_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"expiry_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expiry_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.Note","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notes.Note"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notes.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.Requester":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.timelines.APIException","zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address":{"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record locking configuration created successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDeleteDetails":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"failed_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"deleted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","RUNNING","FAILED","SCHEDULED"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.CountWrapper":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.UpdateFieldsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.CreateShiftsHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.GetSharedRecordDetailsParam":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sharedTo":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sharedTo","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.AddTagsParam":{"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.MinifiedVariableGroup":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"delete_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit_shared_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit_shared_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Users":{"inactive":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"inactive","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"deleted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline":{"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Data":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.taxes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description":{"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.BodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":false,"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper"},"name":"file","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":10}}} \ No newline at end of file diff --git a/zohocrmsdk/__init__.py b/zohocrmsdk/__init__.py new file mode 100755 index 0000000..db9863f --- /dev/null +++ b/zohocrmsdk/__init__.py @@ -0,0 +1 @@ +from . import src \ No newline at end of file diff --git a/zohocrmsdk/src/__init__.py b/zohocrmsdk/src/__init__.py new file mode 100755 index 0000000..e742b6a --- /dev/null +++ b/zohocrmsdk/src/__init__.py @@ -0,0 +1 @@ +from . import com \ No newline at end of file diff --git a/zohocrmsdk/src/com/__init__.py b/zohocrmsdk/src/com/__init__.py new file mode 100755 index 0000000..e2b4c1a --- /dev/null +++ b/zohocrmsdk/src/com/__init__.py @@ -0,0 +1 @@ +from . import zoho \ No newline at end of file diff --git a/zohocrmsdk/src/com/zoho/__init__.py b/zohocrmsdk/src/com/zoho/__init__.py new file mode 100755 index 0000000..893812e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/__init__.py @@ -0,0 +1,2 @@ +from . import api +from . import crm \ No newline at end of file diff --git a/zohocrmsdk/src/com/zoho/api/__init__.py b/zohocrmsdk/src/com/zoho/api/__init__.py new file mode 100755 index 0000000..beecef6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/__init__.py @@ -0,0 +1,2 @@ +from . import authenticator +from . import logger diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/__init__.py b/zohocrmsdk/src/com/zoho/api/authenticator/__init__.py new file mode 100755 index 0000000..ac7dc36 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/__init__.py @@ -0,0 +1,3 @@ +from .token import Token +from .oauth_token import OAuthToken +from . import store diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/oauth_token.py b/zohocrmsdk/src/com/zoho/api/authenticator/oauth_token.py new file mode 100755 index 0000000..dad9ebc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/oauth_token.py @@ -0,0 +1,510 @@ +try: + import threading + import logging + import enum + import json + import time + import requests + from .token import Token + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from ...crm.api.util import APIHTTPConnector + from ...crm.api.util import Utility + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from ...crm.api.util.constants import Constants + from ...crm.api.user_signature import UserSignature + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter + +except Exception as e: + import threading + import logging + import enum + import json + import time + import requests + from .token import Token + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from ...crm.api.util import APIHTTPConnector + from ...crm.api.util import Utility + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from ...crm.api.util.constants import Constants + from ...crm.api.dc.data_center import DataCenter + + +class OAuthToken(Token): + """ + This class maintains the tokens and authenticates every request. + """ + + logger = logging.getLogger('SDKLogger') + lock = threading.Lock() + + def __init__(self, client_id=None, client_secret=None, grant_token=None, refresh_token=None, redirect_url=None, + id=None, access_token=None, user_signature=None, api_domain=None, find_user=True): + + """ + Creates an OAuthToken class instance with the specified parameters. + + Parameters: + client_id (str) : A string containing the OAuth client id. + client_secret (str) : A string containing the OAuth client secret. + grant_token (str) : A string containing the GRANT token. + refresh_token (str) : A string containing the REFRESH token. + redirect_url (str) : A string containing the OAuth redirect URL. Default value is None + id (str) : A string containing the Id. Default value is None + user_signature(UserSignature) : An instance of UserSignature + api_domain(str) : A string containing the api_domain + """ + + error = {} + + if grant_token is None and refresh_token is None and id is None and access_token is None and user_signature is None: + raise SDKException(code=Constants.MANDATORY_VALUE_ERROR, message=Constants.MANDATORY_KEY_ERROR, + details=Constants.OAUTH_MANDATORY_KEYS) + + if id is None and access_token is None and user_signature is None: + if not isinstance(client_id, str): + error[Constants.FIELD] = Constants.CLIENT_ID + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if not isinstance(client_secret, str): + error[Constants.FIELD] = Constants.CLIENT_SECRET + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if grant_token is not None and not isinstance(grant_token, str): + error[Constants.FIELD] = Constants.GRANT_TOKEN + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if refresh_token is not None and not isinstance(refresh_token, str): + error[Constants.FIELD] = Constants.REFRESH_TOKEN + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if redirect_url is not None and not isinstance(redirect_url, str): + error[Constants.FIELD] = Constants.REDIRECT_URI + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if id is not None and not isinstance(id, str): + error[Constants.FIELD] = Constants.ID + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if access_token is not None and not isinstance(access_token, str): + error[Constants.FIELD] = Constants.ACCESS_TOKEN + error[Constants.EXPECTED_TYPE] = Constants.STRING + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + if user_signature is not None and not isinstance(user_signature, UserSignature): + error[Constants.FIELD] = Constants.USER_NAME + error[Constants.EXPECTED_TYPE] = Constants.USER_SIGNATURE_ERROR_MESSAGE + error[Constants.CLASS] = OAuthToken.__name__ + raise SDKException(code=Constants.TOKEN_ERROR, details=error) + + self.__client_id = client_id + self.__client_secret = client_secret + self.__redirect_url = redirect_url + self.__grant_token = grant_token + self.__refresh_token = refresh_token + self.__id = id + self.__access_token = access_token + self.__expires_in = None + self.__user_signature = user_signature + self.__api_domain = api_domain + self.__find_user = find_user + + def get_client_id(self): + """ + This is a getter method to get __client_id. + + Returns: + string: A string representing __client_id + """ + + return self.__client_id + + def get_client_secret(self): + """ + This is a getter method to get __client_secret. + + Returns: + string: A string representing __client_secret + """ + + return self.__client_secret + + def get_redirect_url(self): + """ + This is a getter method to get __redirect_url. + + Returns: + string: A string representing __redirect_url + """ + + return self.__redirect_url + + def get_grant_token(self): + """ + This is a getter method to get __grant_token. + + Returns: + string: A string representing __grant_token + """ + return self.__grant_token + + def get_refresh_token(self): + """ + This is a getter method to get __refresh_token. + + Returns: + string: A string representing __refresh_token + """ + + return self.__refresh_token + + def get_access_token(self): + """ + This is a getter method to get __access_token. + + Returns: + string: A string representing __access_token + """ + + return self.__access_token + + def get_id(self): + """ + This is a getter method to get __id. + + Returns: + string: A string representing __id + """ + + return self.__id + + def get_expires_in(self): + """ + This is a getter method to get __expires_in. + + Returns: + string: A string representing __expires_in + """ + + return self.__expires_in + + def get_user_signature(self): + """ + This is a getter method to get __user_signature + + Returns: + user_signature(UserSignature) : An instance of UserSignature + """ + + return self.__user_signature + + def get_api_domain(self): + """ + This is a getter method to get api_domain + + Returns: + string: A string representing __api_domain + """ + + return self.__api_domain + + def set_grant_token(self, grant_token): + """ + This is a setter method to set __grant_token. + + """ + self.__grant_token = grant_token + + def set_refresh_token(self, refresh_token): + """ + This is a setter method to set __refresh_token. + + """ + self.__refresh_token = refresh_token + + def set_redirect_url(self, redirect_url): + """ + This is a setter method to set __redirect_url. + + """ + self.__redirect_url = redirect_url + + def set_access_token(self, access_token): + """ + This is a setter method to set __access_token. + + """ + + self.__access_token = access_token + + def set_client_id(self, client_id): + """ + This is a setter method to set __client_id. + + """ + + self.__client_id = client_id + + def set_client_secret(self, client_secret): + """ + This is a setter method to set __client_secret. + + """ + + self.__client_secret = client_secret + + def set_id(self, id): + """ + This is a setter method to set __id. + + """ + + self.__id = id + + def set_expires_in(self, expires_in): + """ + This is a setter method to set __expires_in. + + """ + + self.__expires_in = expires_in + + def set_user_signature(self, user_signature): + """ + This is a setter method to set __user_signature. + + """ + + self.__user_signature = user_signature + + def set_api_domain(self, api_domain): + """ + This is a setter method to set __api_domain + """ + + self.__api_domain = api_domain + + def generate_token(self): + self.get_token() + + def get_token(self): + initializer = Initializer.get_initializer() + store = initializer.store + + oauth_token = None + if self.get_id() is not None: + oauth_token = store.find_token_by_id(self.get_id()) + self.merge_objects(self, oauth_token) + oauth_token.__find_user = self.__find_user + else: + oauth_token = store.find_token(self) + if oauth_token is None: + if self.get_user_signature() is not None: + self.check_token_details() + oauth_token = self + if oauth_token.get_api_domain() is None or len(oauth_token.get_api_domain()) <= 0: + if initializer.environment is None: + raise SDKException(Constants.ENVIRONMENT_ERROR_1, Constants.ENVIRONMENT_ERROR_MESSAGE + ":") + oauth_token.set_api_domain(initializer.environment.url) + environment = DataCenter.get(oauth_token.get_api_domain()) + if environment is not None: + try: + initializer = Initializer.get_initializer() + setattr(initializer, Constants.ENVIRONMENT, environment) + except Exception as e: + raise SDKException(Constants.ENVIRONMENT_ERROR_RESPONSE + ":", cause=e) + else: + if initializer.environment is None: + raise SDKException(Constants.ENVIRONMENT_ERROR_1, Constants.ENVIRONMENT_ERROR_MESSAGE + ":") + + url = initializer.environment.accounts_url + save = False + if oauth_token.get_access_token() is None or len(oauth_token.get_access_token()) == 0: + if oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + logging.getLogger("SDKLogger").info(Constants.ACCESS_TOKEN_USING_REFRESH_TOKEN_MESSAGE) + oauth_token.refresh_access_token(oauth_token, url) + else: + logging.getLogger("SDKLogger").info(Constants.ACCESS_TOKEN_USING_GRANT_TOKEN_MESSAGE) + oauth_token.generate_access_token(oauth_token, url) + save = True + elif (oauth_token.get_expires_in() is not None and len(oauth_token.get_expires_in()) > 0 and int( + oauth_token.get_expires_in()) - int(time.time() * 1000) < 5000): + logging.getLogger("SDKLogger").info(Constants.REFRESH_TOKEN_MESSAGE) + oauth_token.refresh_access_token(oauth_token, url) + save = True + elif oauth_token.get_expires_in() is None and oauth_token.get_access_token() is not None and \ + oauth_token.get_id() is None: + + save = True + if save: + try: + if oauth_token.__user_signature is None and oauth_token.__find_user: + try: + user_name = Utility().get_user_name(oauth_token.get_access_token()) + if user_name is not None: + oauth_token.set_user_signature(UserSignature(user_name)) + except SDKException as ex: + logging.getLogger("SDKLogger").error(Constants.API_EXCEPTION, ex) + store.save_token(oauth_token) + except Exception as ex: + logging.getLogger("SDKLogger").error(Constants.SAVE_TOKEN_ERROR, ex) + return oauth_token.get_access_token() + + def check_token_details(self): + if self.are_all_objects_null([self.__grant_token, self.__refresh_token]): + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.GET_TOKEN_BY_USER_NAME_ERROR + " - " + + str.join(", ", Constants.OAUTH_MANDATORY_KEYS2)) + return True + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + @staticmethod + def merge_objects(first, second): + try: + fields = dir(first) + for field1 in fields: + if any(field2 in field1 for field2 in Constants.OAUTH_TOKEN_FIELDS): + if not field1.startswith('__'): + value1 = getattr(first, field1) + value2 = getattr(second, field1) + value = value1 if value1 is not None else value2 + setattr(first, field1, value) + + except Exception as ex: + raise SDKException(Constants.MERGE_OBJECT, cause=ex) + + def authenticate(self, url_connection): + if Constants.AUTHORIZATION not in url_connection.headers: + url_connection.add_header(Constants.AUTHORIZATION, Constants.OAUTH_HEADER_PREFIX + self.get_token()) + + def refresh_access_token(self, oauth_token, url): + try: + body = { + Constants.REFRESH_TOKEN: oauth_token.__refresh_token, + Constants.CLIENT_ID: oauth_token.__client_id, + Constants.CLIENT_SECRET: oauth_token.__client_secret, + Constants.GRANT_TYPE: Constants.REFRESH_TOKEN + } + + response = requests.post(url, data=body, params=None, headers=None, allow_redirects=False).json() + self.parse_response(oauth_token, response) + + except SDKException as ex: + raise ex + + except Exception as ex: + raise SDKException(code=Constants.SAVE_TOKEN_ERROR, cause=ex) + + return oauth_token + + def generate_access_token(self, oauth_token, url): + try: + body = { + Constants.CLIENT_ID: oauth_token.__client_id, + Constants.CLIENT_SECRET: oauth_token.__client_secret, + Constants.REDIRECT_URI: oauth_token.__redirect_url if oauth_token.__redirect_url is not None else None, + Constants.GRANT_TYPE: Constants.GRANT_TYPE_AUTH_CODE, + Constants.CODE: oauth_token.__grant_token + } + + headers = dict() + headers[Constants.USER_AGENT_KEY] = Constants.USER_AGENT + response = requests.post(url, data=body, params=None, headers=headers, allow_redirects=True).json() + self.parse_response(oauth_token, response) + + except SDKException as ex: + raise ex + + except Exception as ex: + raise SDKException(code=Constants.SAVE_TOKEN_ERROR, cause=ex) + + return self + + def parse_response(self, oauth_token, response): + response_json = dict(response) + + if Constants.ACCESS_TOKEN not in response_json: + raise SDKException(code=Constants.INVALID_TOKEN_ERROR, message=str(response_json.get( + Constants.ERROR_KEY)) if Constants.ERROR_KEY in response_json else Constants.NO_ACCESS_TOKEN_ERROR) + + oauth_token.__access_token = response_json.get(Constants.ACCESS_TOKEN) + oauth_token.__expires_in = str(int(time.time() * 1000) + self.get_token_expires_in(response=response_json)) + + if Constants.REFRESH_TOKEN in response_json: + oauth_token.__refresh_token = response_json.get(Constants.REFRESH_TOKEN) + + if Constants.API_DOMAIN in response_json: + oauth_token.__api_domain = response_json.get(Constants.API_DOMAIN) + + return oauth_token + + @staticmethod + def get_token_expires_in(response): + return int(response[Constants.EXPIRES_IN]) if Constants.EXPIRES_IN_SEC in response else int( + response[Constants.EXPIRES_IN]) * 1000 + + def remove(self): + try: + Initializer.get_initializer().store.delete_token(self.get_id()) + return True + except Exception: + return False + + def revoke(self, id1): + try: + if Initializer.get_initializer() is None: + raise SDKException(Constants.SDK_UNINITIALIZATION_ERROR, Constants.SDK_UNINITIALIZATION_MESSAGE) + initializer = Initializer.get_initializer() + store = initializer.store + url = initializer.environment.accounts_url + is_revoke = False + oauthToken = OAuthToken() + oauthToken.set_id(id1) + store.find_token(oauthToken) + if oauthToken is not None and oauthToken.get_refresh_token() is not None: + is_revoke = self.revoke_refresh_token(oauthToken.get_refresh_token(), url + Constants.REVOKE_URL) + logging.getLogger("SDKLogger").info(Constants.ID + " : " + id1 + Constants.REFRESH_TOKEN_REMOVED) + else: + logging.getLogger("SDKLogger").info(Constants.ID + " : " + id1 + Constants.TOKEN_NOT_FOUND) + + return is_revoke + except SDKException as ex: + raise ex + except Exception as e1: + raise SDKException(cause=e1) + + @staticmethod + def revoke_refresh_token(refreshToken, url): + try: + body = { + Constants.TOKEN: refreshToken + } + headers = dict() + response = requests.post(url, data=body, params=None, headers=headers, allow_redirects=True).json() + responseJSON = dict(response) + if (responseJSON is not None and Constants.STATUS in responseJSON and responseJSON.get( + Constants.STATUS) == Constants.STATUS_SUCCESS): + return True + return False + except SDKException as ex: + raise ex + except Exception as e3: + raise SDKException(Constants.REVOKE_TOKEN_ERROR, cause=e3) diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/store/__init__.py b/zohocrmsdk/src/com/zoho/api/authenticator/store/__init__.py new file mode 100755 index 0000000..e71b51d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/store/__init__.py @@ -0,0 +1,3 @@ +from .db_store import DBStore +from .file_store import FileStore +from .token_store import TokenStore diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/store/db_store.py b/zohocrmsdk/src/com/zoho/api/authenticator/store/db_store.py new file mode 100755 index 0000000..2c85cbb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/store/db_store.py @@ -0,0 +1,419 @@ +try: + from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +except Exception as e: + from .token_store import TokenStore + from ..oauth_token import OAuthToken + from ....crm.api.util.constants import Constants + from ....crm.api.exception.sdk_exception import SDKException + from ....crm.api.user_signature import UserSignature + + +class DBStore(TokenStore): + + """ + This class to store user token details to the MySQL DataBase. + """ + + def __init__(self, host=Constants.MYSQL_HOST, database_name=Constants.MYSQL_DATABASE_NAME, + user_name=Constants.MYSQL_USER_NAME, password="", port_number=Constants.MYSQL_PORT_NUMBER, + table_name=Constants.MYSQL_TABLE_NAME): + + """ + Creates a DBStore class instance with the specified parameters. + + Parameters: + host (str) : A string containing the DataBase host name. Default value is localhost + database_name (str) : A string containing the DataBase name. Default value is zohooauth + user_name (str) : A string containing the DataBase user name. Default value is root + password (str) : A string containing the DataBase password. Default value is an empty string + port_number (str) : A string containing the DataBase port number. Default value is 3306 + """ + + self.__host = host + self.__database_name = database_name + self.__user_name = user_name + self.__password = password + self.__port_number = port_number + self.__table_name = table_name + + def get_host(self): + """ + This is a getter method to get __host. + + Returns: + string: A string representing __host + """ + + return self.__host + + def get_database_name(self): + """ + This is a getter method to get __database_name. + + Returns: + string: A string representing __database_name + """ + + return self.__database_name + + def get_user_name(self): + """ + This is a getter method to get __user_name. + + Returns: + string: A string representing __user_name + """ + + return self.__user_name + + def get_password(self): + """ + This is a getter method to get __password. + + Returns: + string: A string representing __password + """ + return self.__password + + def get_port_number(self): + """ + This is a getter method to get __port_number. + + Returns: + string: A string representing __port_number + """ + + return self.__port_number + + def get_table_name(self): + """ + This is a getter method to get __table_name. + + Returns: + string: A string representing __table_name + """ + + return self.__table_name + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + def find_token(self, token): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + connection = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + if isinstance(token, OAuthToken): + oauth_token = token + query = "select * from " + self.__table_name + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + " where user_name='" + name + "'" + elif oauth_token.get_access_token() is not None and self.are_all_objects_null([oauth_token.get_client_id(), oauth_token.get_client_secret()]): + query= query + " where access_token='" + oauth_token.get_access_token() + "'" + elif oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + if oauth_token.get_grant_token() is not None and len(oauth_token.get_grant_token()) > 0: + query = query + " where grant_token='" + oauth_token.get_grant_token() + "'" + elif oauth_token.get_refresh_token() is not None and len(oauth_token.get_refresh_token()) > 0: + query = query + " where refresh_token='" + oauth_token.get_refresh_token() + "'" + query = query + " limit 1" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + if result is None: + return None + self.set_merge_data(oauth_token, result) + + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1, cause=ex) + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + return token + + @staticmethod + def get_data(next_record): + return next_record if next_record is not None else None + + @staticmethod + def set_merge_data(oauth_token, nextRecord): + if oauth_token.get_id() is None: + oauth_token.set_id(DBStore.get_data(nextRecord[0])) + if oauth_token.get_user_signature() is None: + name = DBStore.get_data(nextRecord[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(DBStore.get_data(nextRecord[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(DBStore.get_data(nextRecord[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(DBStore.get_data(nextRecord[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(DBStore.get_data(nextRecord[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(DBStore.get_data(nextRecord[6])) + if oauth_token.get_expires_in() is None: + expiresIn = DBStore.get_data(nextRecord[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(DBStore.get_data(nextRecord[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(DBStore.get_data(nextRecord[9])) + + def save_token(self, token): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + if not isinstance(token, OAuthToken): + return + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name,password=self.__password, port=self.__port_number) + oauthToken = token + query = "update " + self.__table_name + " set " + if oauthToken.get_user_signature() is not None: + name = oauthToken.get_user_signature().get_name() + if name is not None and len(name) > 0: + query = query + self.set_token(oauthToken) + " where user_name='" + name + "'" + elif oauthToken.get_access_token() is not None and len(oauthToken.get_access_token()) > 0 and \ + self.are_all_objects_null([oauthToken.get_client_id(), oauthToken.get_client_secret()]): + query = query + self.set_token(oauthToken) + " where access_token='" + oauthToken.get_access_token() + "'" + elif ((oauthToken.get_refresh_token() is not None and len(oauthToken.get_refresh_token()) > 0) or + (oauthToken.get_grant_token() is not None and len(oauthToken.get_grant_token()) > 0)) and oauthToken.get_client_id() is not None and oauthToken.get_client_secret() is not None: + if oauthToken.get_grant_token() is not None and len(oauthToken.get_grant_token()) > 0: + query = query + self.set_token(oauthToken) + " where grant_token='" + oauthToken.get_grant_token() + "'" + elif oauthToken.get_refresh_token() is not None and len(oauthToken.get_refresh_token()) > 0: + query = query + self.set_token(oauthToken) + " where refresh_token='" + oauthToken.get_refresh_token() + "'" + query = query + " limit 1" + try: + cursor = connection.cursor() + cursor.execute(query) + if cursor.rowcount <= 0: + if oauthToken.get_id() is not None or oauthToken.get_user_signature() is not None: + if oauthToken.get_refresh_token() is None and oauthToken.get_grant_token() is None and oauthToken.get_access_token() is None: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_DB_ERROR1) + if oauthToken.get_id() is None: + newId = str(self.generate_id()) + oauthToken.set_id(newId) + query = "insert into " + self.__table_name + " (id,user_name,client_id,client_secret,refresh_token,access_token,grant_token,expiry_time,redirect_url,api_domain) values (%s,%s,%s,%s,%s,%s,%s,%s,%s,%s);" + val = (token.get_id(), token.get_user_signature().get_name() if token.get_user_signature() is not None else None, token.get_client_id(), token.get_client_secret(), token.get_refresh_token(), token.get_access_token(), token.get_grant_token(), token.get_expires_in(), token.get_redirect_url(), token.get_api_domain()) + cursor.execute(query, val) + except Error as e: + raise e + finally: + connection.commit() + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Exception as ex: + raise SDKException(Constants.TOKEN_STORE, Constants.SAVE_TOKEN_DB_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauthToken): + oauthToken.set_id(None) + oauthToken.set_user_signature(None) + oauthToken.set_client_id(None) + oauthToken.set_client_secret(None) + oauthToken.set_refresh_token(None) + oauthToken.set_access_token(None) + oauthToken.set_grant_token(None) + oauthToken.set_redirect_url(None) + oauthToken.set_expires_in(None) + oauthToken.set_api_domain(None) + + def set_token(self, oauth_token): + query = [] + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + if name is not None and len(name) > 0: + query.append(self.set_token_info(Constants.USER_NAME, name)) + if oauth_token.get_api_domain() is not None: + query.append(self.set_token_info(Constants.API_DOMAIN, oauth_token.get_api_domain())) + if oauth_token.get_client_id() is not None: + query.append(self.set_token_info(Constants.CLIENT_ID, oauth_token.get_client_id())) + if oauth_token.get_client_secret() is not None: + query.append(self.set_token_info(Constants.CLIENT_SECRET, oauth_token.get_client_secret())) + if oauth_token.get_refresh_token() is not None: + query.append(self.set_token_info(Constants.REFRESH_TOKEN, oauth_token.get_refresh_token())) + if oauth_token.get_access_token() is not None: + query.append(self.set_token_info(Constants.ACCESS_TOKEN, oauth_token.get_access_token())) + if oauth_token.get_grant_token() is not None: + query.append(self.set_token_info(Constants.GRANT_TOKEN, oauth_token.get_grant_token())) + if oauth_token.get_expires_in() is not None: + query.append(self.set_token_info(Constants.EXPIRY_TIME, oauth_token.get_expires_in())) + if oauth_token.get_redirect_url() is not None: + query.append(self.set_token_info(Constants.REDIRECT_URL, oauth_token.get_redirect_url())) + return str.join(",", query) + + @staticmethod + def set_token_info(key, value): + return key + "='" + value + "'" + + def delete_token(self, id): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + + try: + cursor = connection.cursor() + query = "delete from " + self.__table_name + " where id= " + id + ";" + cursor.execute(query) + connection.commit() + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKEN_DB_ERROR, cause=ex) + + def get_tokens(self): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + tokens = [] + + try: + cursor = connection.cursor() + query = 'select * from ' + self.__table_name + ";" + cursor.execute(query) + results = cursor.fetchall() + + for result in results: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, result) + tokens.append(oauth_token) + + return tokens + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_DB_ERROR, cause=ex) + + def delete_tokens(self): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + + try: + cursor = connection.cursor() + query = 'delete from ' + self.__table_name + ";" + cursor.execute(query) + connection.commit() + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_DB_ERROR, cause=ex) + + def find_token_by_id(self, id): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + try: + query = "select * from " + self.__table_name + " where id='" + id + "'" + oauthToken = object.__new__(OAuthToken) + self.set_oauth_token(oauthToken) + cursor = connection.cursor() + cursor.execute(query) + results = cursor.fetchall() + if results is None or len(results) <= 0: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_DB_ERROR) + for result in results: + self.set_merge_data(oauthToken, result) + return oauthToken + + except Error as ex: + raise ex + + finally: + cursor.close() if cursor is not None else None + connection.close() if connection is not None else None + + except Error as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_BY_ID_DB_ERROR, cause=ex) + + def generate_id(self): + try: + import mysql.connector + from mysql.connector import Error + except Exception: + import mysql.connector + from mysql.connector import Error + cursor = None + connection = None + try: + connection = mysql.connector.connect(host=self.__host, database=self.__database_name, user=self.__user_name, password=self.__password, port=self.__port_number) + query = "select max(id) as id from " + self.__table_name + ";" + cursor = connection.cursor() + cursor.execute(query) + result = cursor.fetchone() + max1 = result[0] + if max1 is None: + return 1 + else: + return int(max1) + 1 + except Exception as e1: + raise SDKException(Constants.TOKEN_STORE, Constants.GENERATE_TOKEN_ID_ERROR, cause=e1) + finally: + cursor.close() if connection is not None else None + connection.close() if connection is not None else None \ No newline at end of file diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/store/file_store.py b/zohocrmsdk/src/com/zoho/api/authenticator/store/file_store.py new file mode 100755 index 0000000..8bd3dfd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/store/file_store.py @@ -0,0 +1,298 @@ +try: + import os + import csv + from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore + from zohocrmsdk.src.com.zoho.api.authenticator.oauth_token import OAuthToken + from ....crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + +except Exception as e: + import os + import csv + from .token_store import TokenStore + from ..oauth_token import OAuthToken + from ....crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + + +class FileStore(TokenStore): + """ + The class to store user token details to the file. + """ + + def __init__(self, file_path): + + """ + Creates an FileStore class instance with the specified parameters. + + Parameters: + file_path (str) : A string containing the absolute file path of the file to store tokens + + """ + + self.file_path = file_path + is_create = False + self.headers = [Constants.ID, Constants.USER_NAME, Constants.CLIENT_ID, Constants.CLIENT_SECRET, + Constants.REFRESH_TOKEN, Constants.ACCESS_TOKEN, Constants.GRANT_TOKEN, Constants.EXPIRY_TIME, + Constants.REDIRECT_URI, Constants.API_DOMAIN] + + if (os.path.exists(file_path) and os.stat(file_path).st_size == 0) or not os.path.exists(file_path): + is_create = True + with open(self.file_path, mode='w', newline='') as token_file: + csv_writer = csv.writer(token_file, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + + csv_writer.writerow(self.headers) + if not is_create: + with open(file_path, 'r') as file: + csvReader = csv.reader(file) + allContents = list(csvReader) + headers = allContents[0] + if len(headers) == 9: + allContents = [arr + [''] for arr in allContents] + allContents[0] = self.headers + with open(file_path, 'w', newline='') as file: + csvWriter = csv.writer(file) + csvWriter.writerows(allContents) + + def find_token(self, token): + if not isinstance(token, OAuthToken): + return token + try: + oauth_token = token + is_row_present = False + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=",") + next(data, None) + for next_record in data: + if len(next_record) == 0: + continue + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + return oauth_token + if not is_row_present: + return None + except IOError as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKEN_FILE_ERROR, cause=ex) + finally: + f.close() + + def set_merge_data(self, oauth_token, nextRecord): + if oauth_token.get_id() is None: + oauth_token.set_id(self.get_data(nextRecord[0])) + if oauth_token.get_user_signature() is None: + name = self.get_data(nextRecord[1]) + if name is not None: + oauth_token.set_user_signature(UserSignature(name)) + if oauth_token.get_client_id() is None: + oauth_token.set_client_id(self.get_data(nextRecord[2])) + if oauth_token.get_client_secret() is None: + oauth_token.set_client_secret(self.get_data(nextRecord[3])) + if oauth_token.get_refresh_token() is None: + oauth_token.set_refresh_token(self.get_data(nextRecord[4])) + if oauth_token.get_access_token() is None: + oauth_token.set_access_token(self.get_data(nextRecord[5])) + if oauth_token.get_grant_token() is None: + oauth_token.set_grant_token(self.get_data(nextRecord[6])) + if oauth_token.get_expires_in() is None: + expiresIn = self.get_data(nextRecord[7]) + if expiresIn is not None: + oauth_token.set_expires_in(str(expiresIn)) + if oauth_token.get_redirect_url() is None: + oauth_token.set_redirect_url(self.get_data(nextRecord[8])) + if oauth_token.get_api_domain() is None: + oauth_token.set_api_domain(self.get_data(nextRecord[9])) + + def check_condition(self, oauth_token, nextRecord): + is_row_present = False + if oauth_token.get_user_signature() is not None: + name = oauth_token.get_user_signature().get_name() + userName = self.get_data(nextRecord[1]) + if name is not None and len(name) > 0 and userName is not None and len(userName) > 0 and name == userName: + is_row_present = True + elif oauth_token.get_access_token() is not None and self.are_all_objects_null( + [oauth_token.get_client_id(), oauth_token.get_client_secret()]): + accessToken = self.get_data(nextRecord[5]) + if accessToken is not None and len(accessToken) > 0 and len( + oauth_token.get_access_token()) > 0 and oauth_token.get_access_token() == accessToken: + is_row_present = True + elif ( + oauth_token.get_refresh_token() is not None or oauth_token.get_grant_token() is not None) and oauth_token.get_client_id() is not None and oauth_token.get_client_secret() is not None: + grantToken = self.get_data(nextRecord[6]) + refreshToken = self.get_data(nextRecord[4]) + if grantToken is not None and len(grantToken) > 0 and oauth_token.get_grant_token() is not None and len( + oauth_token.get_grant_token()) > 0 and oauth_token.get_grant_token() == grantToken: + is_row_present = True + elif refreshToken is not None and len( + refreshToken) > 0 and oauth_token.get_refresh_token() is not None and len( + oauth_token.get_refresh_token()) > 0 and oauth_token.get_refresh_token() == refreshToken: + is_row_present = True + return is_row_present + + def save_token(self, token): + if isinstance(token, OAuthToken): + try: + is_row_present = False + all_contents = list() + oauth_token = token + with open(self.file_path, mode="r") as f: + data = csv.reader(f, delimiter=",") + all_contents = list(data) + for next_record in all_contents: + if len(next_record) > 0: + if oauth_token.get_id() is not None: + id = self.get_data(next_record[0]) + if id is not None and oauth_token.get_id() is not None and id == oauth_token.get_id(): + is_row_present= True + + else: + is_row_present = self.check_condition(oauth_token, next_record) + if is_row_present: + self.set_merge_data(oauth_token, next_record) + i = all_contents.index(next_record) + all_contents[i] = self.set_token(oauth_token) + break + else: + all_contents.remove(next_record) + if not is_row_present: + if oauth_token.get_id() is not None or oauth_token.get_user_signature() is not None: + if ( + oauth_token.get_refresh_token() is None and oauth_token.get_grant_token() is None and oauth_token.get_access_token() is None): + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_FILE_ERROR1) + if oauth_token.get_id() is None: + newId = self.generate_id(all_contents) + oauth_token.set_id(newId) + all_contents.append(self.set_token(oauth_token)) + with open(self.file_path, mode='w', newline='') as f: + csv_writer = csv.writer(f, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + csv_writer.writerows(all_contents) + except IOError as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.SAVE_TOKEN_FILE_ERROR, cause=ex) + except Exception as error: + raise error + finally: + f.close() + + @staticmethod + def set_token(oauth_token): + data = [] + data.insert(0, oauth_token.get_id()) + data.insert(1, + oauth_token.get_user_signature().get_name() if oauth_token.get_user_signature() is not None else "") + data.insert(2, oauth_token.get_client_id()) + data.insert(3, oauth_token.get_client_secret()) + data.insert(4, oauth_token.get_refresh_token()) + data.insert(5, oauth_token.get_access_token()) + data.insert(6, oauth_token.get_grant_token()) + data.insert(7, oauth_token.get_expires_in()) + data.insert(8, oauth_token.get_redirect_url()) + data.insert(9, oauth_token.get_api_domain()) + return data + + def delete_token(self, id): + try: + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=',') + all_contents = list(data) + for i in range(len(all_contents)): + next_record = all_contents[i] + if len(next_record) > 1: + recordId = self.get_data(next_record[0]) + if recordId is not None and recordId == id: + is_row_present = True + all_contents.pop(i) + break + with open(self.file_path, mode='w') as f: + csv_writer = csv.writer(f, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + csv_writer.writerows(all_contents) + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e2: + raise SDKException(Constants.TOKEN_STORE, Constants.DELETE_TOKENS_FILE_ERROR, cause=e2) + + def get_tokens(self): + tokens = [] + + try: + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=',') + next(data, None) + for next_record in data: + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + self.set_merge_data(oauth_token, next_record) + tokens.append(oauth_token) + + return tokens + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.GET_TOKENS_FILE_ERROR, cause=ex) + + def delete_tokens(self): + try: + with open(self.file_path, mode='w') as token_file: + csv_writer = csv.writer(token_file, delimiter=',', quotechar='"', quoting=csv.QUOTE_MINIMAL) + csv_writer.writerow(self.headers) + except Exception as ex: + raise SDKException(code=Constants.TOKEN_STORE, message=Constants.DELETE_TOKENS_FILE_ERROR, cause=ex) + + @staticmethod + def set_oauth_token(oauth_token): + oauth_token.set_id(None) + oauth_token.set_user_signature(None) + oauth_token.set_client_id(None) + oauth_token.set_client_secret(None) + oauth_token.set_refresh_token(None) + oauth_token.set_access_token(None) + oauth_token.set_grant_token(None) + oauth_token.set_redirect_url(None) + oauth_token.set_expires_in(None) + oauth_token.set_api_domain(None) + + def find_token_by_id(self, id): + try: + is_row_present = False + oauth_token = object.__new__(OAuthToken) + self.set_oauth_token(oauth_token) + + with open(self.file_path, mode='r') as f: + data = csv.reader(f, delimiter=',') + all_contents = list(data) + for content in all_contents: + if content[0] == id: + is_row_present = True + self.set_merge_data(oauth_token, content) + return oauth_token + if not is_row_present: + raise SDKException(Constants.TOKEN_STORE, Constants.GET_TOKEN_BY_ID_FILE_ERROR) + except SDKException as ex: + raise ex + except Exception as e: + raise SDKException(Constants.TOKEN_STORE, Constants.TOKEN_BY_ID_FILE_ERROR, cause=e) + finally: + f.close() + return None + + @staticmethod + def get_data(value): + return value if (value is not None and len(value) > 0) else None + + @staticmethod + def are_all_objects_null(object1): + for obj in object1: + if obj is not None: + return False + return True + + @staticmethod + def generate_id(all_contents): + maxValue = 0 + if len(all_contents) > 0: + for i in range(len(all_contents) - 1): + next_record = all_contents[i + 1] + if next_record is not None and len(next_record) > 1 and len(next_record[0]) > 0: + if maxValue < int(next_record[0]): + maxValue = int(next_record[0]) + return str(maxValue + 1) diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py b/zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py new file mode 100755 index 0000000..fe8fdd9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/store/token_store.py @@ -0,0 +1,86 @@ +try: + from abc import ABC, abstractmethod + +except Exception as e: + from abc import ABC, abstractmethod + + +class TokenStore(ABC): + + """ + This class is to store user token details. + """ + + @abstractmethod + def find_token(self, token): + + """ + The method to get user token details. + + Parameters: + token (Token) : A Token class instance. + + Returns: + Token : A Token class instance representing the user token details. + """ + + pass + + @abstractmethod + def save_token(self, token): + + """ + The method to store user token details. + + Parameters: + token (Token) : A Token class instance. + + """ + + pass + + @abstractmethod + def delete_token(self, id): + + """ + The method to delete user token details. + + Parameters: + id (String) : A String representing Token id. + """ + + pass + + @abstractmethod + def get_tokens(self): + + """ + The method to retrieve all the stored tokens. + + Returns: + list : A List of Token instances + """ + + pass + + @abstractmethod + def delete_tokens(self): + + """ + The method to delete all the stored tokens. + """ + + pass + @abstractmethod + def find_token_by_id(self, id): + + """ + The method to get id token details. + + Parameters: + id (String) : A String id. + Returns: + Token : A Token class instance representing the id token details. + """ + + pass diff --git a/zohocrmsdk/src/com/zoho/api/authenticator/token.py b/zohocrmsdk/src/com/zoho/api/authenticator/token.py new file mode 100755 index 0000000..267b3cc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/authenticator/token.py @@ -0,0 +1,42 @@ +from abc import abstractmethod, ABC + + +class Token(ABC): + + """ + The class to verify and set token to the APIHTTPConnector instance, to authenticate requests. + """ + + @abstractmethod + def authenticate(self, url_connection): + + """ + The method to set token to APIHTTPConnector instance + + Parameters: + url_connection (APIHTTPConnector) : A APIHTTPConnector class instance. + """ + + pass + + @abstractmethod + def remove(self): + + """ + The method to remove the token from store. + + Returns: + bool: A Boolean value representing the removed status. + """ + pass + + @abstractmethod + def generate_token(self): + + """ + The method to generate the Token + + Returns: + oauthToken (OauthToken) : A OauthToken class instance + """ + pass \ No newline at end of file diff --git a/zohocrmsdk/src/com/zoho/api/logger/__init__.py b/zohocrmsdk/src/com/zoho/api/logger/__init__.py new file mode 100755 index 0000000..6e84027 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/logger/__init__.py @@ -0,0 +1,2 @@ +from .logger import Logger, SDKLogger + diff --git a/zohocrmsdk/src/com/zoho/api/logger/logger.py b/zohocrmsdk/src/com/zoho/api/logger/logger.py new file mode 100755 index 0000000..7ae2646 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/api/logger/logger.py @@ -0,0 +1,93 @@ +try: + import logging + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from ...crm.api.util.constants import Constants +except: + from ...crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + + +class Logger(object): + + """ + This class represents the Logger level and the file path. + """ + + def __init__(self, level, file_path=None): + self.__level = level + self.__file_path = file_path + + def get_level(self): + """ + This is a getter method to get __level. + + Returns: + string: A enum representing __level + """ + + return self.__level + + def get_file_path(self): + """ + This is a getter method to get __file_path. + + Returns: + string: A string representing __file_path + """ + + return self.__file_path + + @staticmethod + def get_instance(level, file_path=None): + + """ + Creates an Logger class instance with the specified log level and file path. + :param level: A Levels class instance containing the log level. + :param file_path: A str containing the log file path. + :return: A Logger class instance. + """ + + return Logger(level=level, file_path=file_path) + + import enum + + class Levels(enum.Enum): + + """ + This class represents the possible logger levels + """ + + CRITICAL = logging.CRITICAL + ERROR = logging.ERROR + WARNING = logging.WARNING + INFO = logging.INFO + DEBUG = logging.DEBUG + NOTSET = logging.NOTSET + + +class SDKLogger(object): + + """ + The class to initialize the SDK logger. + """ + + def __init__(self, logger_instance): + + logger = logging.getLogger('SDKLogger') + logger_level = logger_instance.get_level() + logger_file_path = logger_instance.get_file_path() + if logger_level is not None and logger_level != logging.NOTSET and logger_file_path is not None and logger_file_path != "": + file_handler = logging.FileHandler(logger_file_path) + formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(module)s - %(filename)s - %(funcName)s - %(lineno)d - %(message)s') + file_handler.setLevel(logger_level.name) + file_handler.setFormatter(formatter) + logger.addHandler(file_handler) + if logger_level is not None and Constants.LOGGER_LEVELS.__contains__(logger_level.name): + logger.setLevel(logger_level.name) + + @staticmethod + def initialize(logger_instance): + try: + SDKLogger(logger_instance=logger_instance) + except Exception as ex: + raise SDKException(message=Constants.LOGGER_INITIALIZATION_ERROR, cause=ex) diff --git a/zohocrmsdk/src/com/zoho/crm/__init__.py b/zohocrmsdk/src/com/zoho/crm/__init__.py new file mode 100755 index 0000000..9468875 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/__init__.py @@ -0,0 +1 @@ +from . import api \ No newline at end of file diff --git a/zohocrmsdk/src/com/zoho/crm/api/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/__init__.py new file mode 100644 index 0000000..f1e30c0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/__init__.py @@ -0,0 +1,114 @@ +from . import dc +from . import exception +from . import util +from .header import Header +from .header_map import HeaderMap +from .param import Param +from .parameter_map import ParameterMap +from .initializer import Initializer +from .user_signature import UserSignature +from .request_proxy import RequestProxy +from .sdk_config import SDKConfig +from . import coql +from . import users_transfer_delete +from . import user_type_users +from . import associate_email +from . import unsubscribe_links +from . import unblock_email +from . import layouts +from . import variable_groups +from . import webforms +from . import service_preference +from . import bulk_read +from . import shift_hours +from . import pipeline +from . import field_map_dependency +from . import inventory_convert +from . import users_territories +from . import appointment_preference +from . import users_unavailability +from . import fields +from . import blueprint +from . import privacy_preference +from . import taxes +from . import roles +from . import email_related_records +from . import modules +from . import portal_invite +from . import attachments +from . import find_and_merge +from . import global_picklists +from . import timelines +from . import user_groups +from . import contact_roles +from . import entity_scores +from . import conversion_option +from . import scoring_rules +from . import portals +from . import available_currencies +from . import digest +from . import org +from . import mail_merge +from . import fiscal_year +from . import record_locking_configuration +from . import users +from . import mass_change_owner +from . import custom_views +from . import tags +from . import email_templates +from . import files +from . import mass_convert +from . import privacy_configurable_apps +from . import email_compose_meta +from . import templates +from . import definition +from . import territories +from . import email_drafts +from . import cancel_meetings +from . import territory_users +from . import business_hours +from . import portals_meta +from . import email_sharing_details +from . import share_records +from . import inventory_templates +from . import features +from . import from_addresses +from . import wizards +from . import holidays +from . import profiles +from . import send_mail +from . import mass_delete_cvid +from . import deal_contact_roles +from . import currencies +from . import convert_lead +from . import notes +from . import isc_signature +from . import field_attachments +from . import backup +from . import related_lists +from . import inventory_mass_convert +from . import reschedule_history +from . import variables +from . import related_records +from . import record_locking +from . import change_owner +from . import download_inline_images +from . import assignment_rules +from . import notifications +from . import bulk_write +from . import portal_user_type +from . import download_attachments +from . import record +from . import hipaa_compliance +from . import pick_list_values +from . import zia_people_enrichment +from . import functions +from . import apis +from . import duplicate_check_preference +from . import zia_allowed_field_mappings +from . import cadences +from . import zia_enrichment +from . import audit_log_export +from . import cadences_execution +from . import zia_org_enrichment +from . import mass_delete_tags diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/apis/__init__.py new file mode 100644 index 0000000..b34a5bb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/__init__.py @@ -0,0 +1,6 @@ +from .operation_types import OperationTypes +from .api_exception import APIException +from .supported_api import SupportedAPI +from .response_handler import ResponseHandler +from .apis_operations import APIsOperations, GetSupportedAPIParam +from .response_wrapper import ResponseWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/apis/api_exception.py new file mode 100644 index 0000000..5982980 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.apis.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/apis_operations.py b/zohocrmsdk/src/com/zoho/crm/api/apis/apis_operations.py new file mode 100644 index 0000000..ccc034a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/apis_operations.py @@ -0,0 +1,52 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class APIsOperations(object): + def __init__(self, filters=None): + """ + Creates an instance of ApisOperations with the given parameters + + Parameters: + filters (string) : A string representing the filters + """ + + if filters is not None and not isinstance(filters, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: str', None, None) + + self.__filters = filters + + + def get_supported_api(self): + """ + The method to get supported api + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__apis' + 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('filters', 'com.zoho.crm.api.Apis.GetSupportedAPIParam'), self.__filters) + try: + from zohocrmsdk.src.com.zoho.crm.api.apis.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetSupportedAPIParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/operation_types.py b/zohocrmsdk/src/com/zoho/crm/api/apis/operation_types.py new file mode 100644 index 0000000..aa1b5a7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/operation_types.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OperationTypes(object): + def __init__(self): + """Creates an instance of OperationTypes""" + + self.__method = None + self.__oauth_scope = None + self.__max_credits = None + self.__min_credits = None + self.__key_modified = dict() + + def get_method(self): + """ + The method to get the method + + Returns: + string: A string representing the method + """ + + return self.__method + + def set_method(self, method): + """ + The method to set the value to method + + Parameters: + method (string) : A string representing the method + """ + + if method is not None and not isinstance(method, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: method EXPECTED TYPE: str', None, None) + + self.__method = method + self.__key_modified['method'] = 1 + + def get_oauth_scope(self): + """ + The method to get the oauth_scope + + Returns: + string: A string representing the oauth_scope + """ + + return self.__oauth_scope + + def set_oauth_scope(self, oauth_scope): + """ + The method to set the value to oauth_scope + + Parameters: + oauth_scope (string) : A string representing the oauth_scope + """ + + if oauth_scope is not None and not isinstance(oauth_scope, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: oauth_scope EXPECTED TYPE: str', None, None) + + self.__oauth_scope = oauth_scope + self.__key_modified['oauth_scope'] = 1 + + def get_max_credits(self): + """ + The method to get the max_credits + + Returns: + int: An int representing the max_credits + """ + + return self.__max_credits + + def set_max_credits(self, max_credits): + """ + The method to set the value to max_credits + + Parameters: + max_credits (int) : An int representing the max_credits + """ + + if max_credits is not None and not isinstance(max_credits, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: max_credits EXPECTED TYPE: int', None, None) + + self.__max_credits = max_credits + self.__key_modified['max_credits'] = 1 + + def get_min_credits(self): + """ + The method to get the min_credits + + Returns: + int: An int representing the min_credits + """ + + return self.__min_credits + + def set_min_credits(self, min_credits): + """ + The method to set the value to min_credits + + Parameters: + min_credits (int) : An int representing the min_credits + """ + + if min_credits is not None and not isinstance(min_credits, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: min_credits EXPECTED TYPE: int', None, None) + + self.__min_credits = min_credits + self.__key_modified['min_credits'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/apis/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/apis/response_wrapper.py new file mode 100644 index 0000000..3f1732e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.apis.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__apis = None + self.__key_modified = dict() + + def get_apis(self): + """ + The method to get the apis + + Returns: + list: An instance of list + """ + + return self.__apis + + def set_apis(self, apis): + """ + The method to set the value to apis + + Parameters: + apis (list) : An instance of list + """ + + if apis is not None and not isinstance(apis, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: apis EXPECTED TYPE: list', None, None) + + self.__apis = apis + self.__key_modified['__apis'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/apis/supported_api.py b/zohocrmsdk/src/com/zoho/crm/api/apis/supported_api.py new file mode 100644 index 0000000..abc6302 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/apis/supported_api.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SupportedAPI(object): + def __init__(self): + """Creates an instance of SupportedAPI""" + + self.__path = None + self.__operation_types = None + self.__key_modified = dict() + + def get_path(self): + """ + The method to get the path + + Returns: + string: A string representing the path + """ + + return self.__path + + def set_path(self, path): + """ + The method to set the value to path + + Parameters: + path (string) : A string representing the path + """ + + if path is not None and not isinstance(path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: path EXPECTED TYPE: str', None, None) + + self.__path = path + self.__key_modified['path'] = 1 + + def get_operation_types(self): + """ + The method to get the operation_types + + Returns: + list: An instance of list + """ + + return self.__operation_types + + def set_operation_types(self, operation_types): + """ + The method to set the value to operation_types + + Parameters: + operation_types (list) : An instance of list + """ + + if operation_types is not None and not isinstance(operation_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_types EXPECTED TYPE: list', None, None) + + self.__operation_types = operation_types + self.__key_modified['operation_types'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/__init__.py new file mode 100644 index 0000000..19cf011 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/__init__.py @@ -0,0 +1,14 @@ +from .deal_record_configuration import DealRecordConfiguration +from .action_wrapper import ActionWrapper +from .body_wrapper import BodyWrapper +from .field_mappings import FieldMappings +from .layout import Layout +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .field import Field +from .success_response import SuccessResponse +from .appointment_preference_operations import AppointmentPreferenceOperations, GetAppointmentPreferenceParam +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .appointment_preference import AppointmentPreference diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_wrapper.py new file mode 100644 index 0000000..edd45eb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__appointment_preferences = None + self.__key_modified = dict() + + def get_appointment_preferences(self): + """ + The method to get the appointment_preferences + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__appointment_preferences + + def set_appointment_preferences(self, appointment_preferences): + """ + The method to set the value to appointment_preferences + + Parameters: + appointment_preferences (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if appointment_preferences is not None and not isinstance(appointment_preferences, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: ActionResponse', None, None) + + self.__appointment_preferences = appointment_preferences + self.__key_modified['appointment_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/api_exception.py new file mode 100644 index 0000000..441f282 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference.py new file mode 100644 index 0000000..387b645 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class AppointmentPreference(object): + def __init__(self): + """Creates an instance of AppointmentPreference""" + + self.__show_job_sheet = None + self.__when_duration_exceeds = None + self.__when_appointment_completed = None + self.__allow_booking_outside_service_availability = None + self.__allow_booking_outside_businesshours = None + self.__deal_record_configuration = None + self.__key_modified = dict() + + def get_show_job_sheet(self): + """ + The method to get the show_job_sheet + + Returns: + bool: A bool representing the show_job_sheet + """ + + return self.__show_job_sheet + + def set_show_job_sheet(self, show_job_sheet): + """ + The method to set the value to show_job_sheet + + Parameters: + show_job_sheet (bool) : A bool representing the show_job_sheet + """ + + if show_job_sheet is not None and not isinstance(show_job_sheet, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_job_sheet EXPECTED TYPE: bool', None, None) + + self.__show_job_sheet = show_job_sheet + self.__key_modified['show_job_sheet'] = 1 + + def get_when_duration_exceeds(self): + """ + The method to get the when_duration_exceeds + + Returns: + string: A string representing the when_duration_exceeds + """ + + return self.__when_duration_exceeds + + def set_when_duration_exceeds(self, when_duration_exceeds): + """ + The method to set the value to when_duration_exceeds + + Parameters: + when_duration_exceeds (string) : A string representing the when_duration_exceeds + """ + + if when_duration_exceeds is not None and not isinstance(when_duration_exceeds, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: when_duration_exceeds EXPECTED TYPE: str', None, None) + + self.__when_duration_exceeds = when_duration_exceeds + self.__key_modified['when_duration_exceeds'] = 1 + + def get_when_appointment_completed(self): + """ + The method to get the when_appointment_completed + + Returns: + Choice: An instance of Choice + """ + + return self.__when_appointment_completed + + def set_when_appointment_completed(self, when_appointment_completed): + """ + The method to set the value to when_appointment_completed + + Parameters: + when_appointment_completed (Choice) : An instance of Choice + """ + + if when_appointment_completed is not None and not isinstance(when_appointment_completed, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: when_appointment_completed EXPECTED TYPE: Choice', None, None) + + self.__when_appointment_completed = when_appointment_completed + self.__key_modified['when_appointment_completed'] = 1 + + def get_allow_booking_outside_service_availability(self): + """ + The method to get the allow_booking_outside_service_availability + + Returns: + bool: A bool representing the allow_booking_outside_service_availability + """ + + return self.__allow_booking_outside_service_availability + + def set_allow_booking_outside_service_availability(self, allow_booking_outside_service_availability): + """ + The method to set the value to allow_booking_outside_service_availability + + Parameters: + allow_booking_outside_service_availability (bool) : A bool representing the allow_booking_outside_service_availability + """ + + if allow_booking_outside_service_availability is not None and not isinstance(allow_booking_outside_service_availability, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allow_booking_outside_service_availability EXPECTED TYPE: bool', None, None) + + self.__allow_booking_outside_service_availability = allow_booking_outside_service_availability + self.__key_modified['allow_booking_outside_service_availability'] = 1 + + def get_allow_booking_outside_businesshours(self): + """ + The method to get the allow_booking_outside_businesshours + + Returns: + bool: A bool representing the allow_booking_outside_businesshours + """ + + return self.__allow_booking_outside_businesshours + + def set_allow_booking_outside_businesshours(self, allow_booking_outside_businesshours): + """ + The method to set the value to allow_booking_outside_businesshours + + Parameters: + allow_booking_outside_businesshours (bool) : A bool representing the allow_booking_outside_businesshours + """ + + if allow_booking_outside_businesshours is not None and not isinstance(allow_booking_outside_businesshours, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allow_booking_outside_businesshours EXPECTED TYPE: bool', None, None) + + self.__allow_booking_outside_businesshours = allow_booking_outside_businesshours + self.__key_modified['allow_booking_outside_businesshours'] = 1 + + def get_deal_record_configuration(self): + """ + The method to get the deal_record_configuration + + Returns: + DealRecordConfiguration: An instance of DealRecordConfiguration + """ + + return self.__deal_record_configuration + + def set_deal_record_configuration(self, deal_record_configuration): + """ + The method to set the value to deal_record_configuration + + Parameters: + deal_record_configuration (DealRecordConfiguration) : An instance of DealRecordConfiguration + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.deal_record_configuration import DealRecordConfiguration + except Exception: + from .deal_record_configuration import DealRecordConfiguration + + if deal_record_configuration is not None and not isinstance(deal_record_configuration, DealRecordConfiguration): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal_record_configuration EXPECTED TYPE: DealRecordConfiguration', None, None) + + self.__deal_record_configuration = deal_record_configuration + self.__key_modified['deal_record_configuration'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference_operations.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference_operations.py new file mode 100644 index 0000000..e64470a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/appointment_preference_operations.py @@ -0,0 +1,90 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class AppointmentPreferenceOperations(object): + def __init__(self): + """Creates an instance of AppointmentPreferenceOperations""" + pass + + def get_appointment_preference(self, param_instance=None): + """ + The method to get appointment preference + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/appointment_preferences' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_appointment_preference(self, request): + """ + The method to update appointment preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/appointment_preferences' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAppointmentPreferenceParam(object): + include = Param('include', 'com.zoho.crm.api.AppointmentPreference.GetAppointmentPreferenceParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/body_wrapper.py new file mode 100644 index 0000000..f5e9216 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__appointment_preferences = None + self.__key_modified = dict() + + def get_appointment_preferences(self): + """ + The method to get the appointment_preferences + + Returns: + AppointmentPreference: An instance of AppointmentPreference + """ + + return self.__appointment_preferences + + def set_appointment_preferences(self, appointment_preferences): + """ + The method to set the value to appointment_preferences + + Parameters: + appointment_preferences (AppointmentPreference) : An instance of AppointmentPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.appointment_preference import AppointmentPreference + except Exception: + from .appointment_preference import AppointmentPreference + + if appointment_preferences is not None and not isinstance(appointment_preferences, AppointmentPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: AppointmentPreference', None, None) + + self.__appointment_preferences = appointment_preferences + self.__key_modified['appointment_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/deal_record_configuration.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/deal_record_configuration.py new file mode 100644 index 0000000..c9de7dc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/deal_record_configuration.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DealRecordConfiguration(object): + def __init__(self): + """Creates an instance of DealRecordConfiguration""" + + self.__layout = None + self.__field_mappings = None + self.__id = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_field_mappings(self): + """ + The method to get the field_mappings + + Returns: + list: An instance of list + """ + + return self.__field_mappings + + def set_field_mappings(self, field_mappings): + """ + The method to set the value to field_mappings + + Parameters: + field_mappings (list) : An instance of list + """ + + if field_mappings is not None and not isinstance(field_mappings, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_mappings EXPECTED TYPE: list', None, None) + + self.__field_mappings = field_mappings + self.__key_modified['field_mappings'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field_mappings.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field_mappings.py new file mode 100644 index 0000000..40d9847 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/field_mappings.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class FieldMappings(object): + def __init__(self): + """Creates an instance of FieldMappings""" + + self.__type = None + self.__value = None + self.__field = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/layout.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/layout.py new file mode 100644 index 0000000..8d89a2a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_wrapper.py new file mode 100644 index 0000000..5d352e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__appointment_preferences = None + self.__key_modified = dict() + + def get_appointment_preferences(self): + """ + The method to get the appointment_preferences + + Returns: + AppointmentPreference: An instance of AppointmentPreference + """ + + return self.__appointment_preferences + + def set_appointment_preferences(self, appointment_preferences): + """ + The method to set the value to appointment_preferences + + Parameters: + appointment_preferences (AppointmentPreference) : An instance of AppointmentPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.appointment_preference import AppointmentPreference + except Exception: + from .appointment_preference import AppointmentPreference + + if appointment_preferences is not None and not isinstance(appointment_preferences, AppointmentPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_preferences EXPECTED TYPE: AppointmentPreference', None, None) + + self.__appointment_preferences = appointment_preferences + self.__key_modified['appointment_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/success_response.py new file mode 100644 index 0000000..c97b00f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/appointment_preference/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.appointment_preference.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/__init__.py new file mode 100644 index 0000000..59cb385 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .assignment_rules_operations import AssignmentRulesOperations, GetAssignmentRulesParam, GetAssignmentRuleParam +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .assignment_rules import AssignmentRules +from .default_assignee import DefaultAssignee +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .user import User diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_wrapper.py new file mode 100644 index 0000000..6af9265 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__assignment_rules = None + self.__key_modified = dict() + + def get_assignment_rules(self): + """ + The method to get the assignment_rules + + Returns: + list: An instance of list + """ + + return self.__assignment_rules + + def set_assignment_rules(self, assignment_rules): + """ + The method to set the value to assignment_rules + + Parameters: + assignment_rules (list) : An instance of list + """ + + if assignment_rules is not None and not isinstance(assignment_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment_rules EXPECTED TYPE: list', None, None) + + self.__assignment_rules = assignment_rules + self.__key_modified['assignment_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/api_exception.py new file mode 100644 index 0000000..74c5967 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + + +class APIException(ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules.py new file mode 100644 index 0000000..96c527d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules.py @@ -0,0 +1,323 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignmentRules(object): + def __init__(self): + """Creates an instance of AssignmentRules""" + + self.__created_time = None + self.__modified_time = None + self.__default_assignee = None + self.__api_name = None + self.__modified_by = None + self.__created_by = None + self.__id = None + self.__name = None + self.__module = None + self.__description = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_default_assignee(self): + """ + The method to get the default_assignee + + Returns: + DefaultAssignee: An instance of DefaultAssignee + """ + + return self.__default_assignee + + def set_default_assignee(self, default_assignee): + """ + The method to set the value to default_assignee + + Parameters: + default_assignee (DefaultAssignee) : An instance of DefaultAssignee + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.default_assignee import DefaultAssignee + except Exception: + from .default_assignee import DefaultAssignee + + if default_assignee is not None and not isinstance(default_assignee, DefaultAssignee): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_assignee EXPECTED TYPE: DefaultAssignee', None, None) + + self.__default_assignee = default_assignee + self.__key_modified['default_assignee'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.py new file mode 100644 index 0000000..074a673 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/assignment_rules_operations.py @@ -0,0 +1,97 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class AssignmentRulesOperations(object): + def __init__(self): + """Creates an instance of AssignmentRulesOperations""" + pass + + def get_assignment_rules(self, param_instance=None): + """ + The method to get assignment rules + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/automation/assignment_rules' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_assignment_rule(self, id, param_instance=None): + """ + The method to get assignment rule + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/automation/assignment_rules/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetAssignmentRulesParam(object): + module = Param('module', 'com.zoho.crm.api.AssignmentRules.GetAssignmentRulesParam') + + +class GetAssignmentRuleParam(object): + module = Param('module', 'com.zoho.crm.api.AssignmentRules.GetAssignmentRuleParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/default_assignee.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/default_assignee.py new file mode 100644 index 0000000..352625d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/default_assignee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultAssignee(object): + def __init__(self): + """Creates an instance of DefaultAssignee""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_wrapper.py new file mode 100644 index 0000000..9c01b48 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__assignment_rules = None + self.__key_modified = dict() + + def get_assignment_rules(self): + """ + The method to get the assignment_rules + + Returns: + list: An instance of list + """ + + return self.__assignment_rules + + def set_assignment_rules(self, assignment_rules): + """ + The method to set the value to assignment_rules + + Parameters: + assignment_rules (list) : An instance of list + """ + + if assignment_rules is not None and not isinstance(assignment_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment_rules EXPECTED TYPE: list', None, None) + + self.__assignment_rules = assignment_rules + self.__key_modified['assignment_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/success_response.py new file mode 100644 index 0000000..dd37766 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.assignment_rules.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/user.py b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/user.py new file mode 100644 index 0000000..7a43185 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/assignment_rules/user.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..users import MinifiedUser + + +class User(MinifiedUser): + def __init__(self): + """Creates an instance of User""" + super().__init__() + + self.__zuid = None + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + int: An int representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (int) : An int representing the zuid + """ + + if zuid is not None and not isinstance(zuid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: int', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/__init__.py new file mode 100644 index 0000000..5d95c89 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/__init__.py @@ -0,0 +1,15 @@ +from .action_wrapper import ActionWrapper +from .attachments import Attachments +from .available import Available +from .body_wrapper import BodyWrapper +from .module_map import ModuleMap +from .api_exception import APIException +from .associate_email_operations import AssociateEmailOperations +from .linked_record import LinkedRecord +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .record import Record +from .associate_email import AssociateEmail +from .action_handler import ActionHandler +from .from1 import From +from .to import To diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_wrapper.py new file mode 100644 index 0000000..6a20921 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__emails = None + self.__key_modified = dict() + + def get_emails(self): + """ + The method to get the emails + + Returns: + list: An instance of list + """ + + return self.__emails + + def set_emails(self, emails): + """ + The method to set the value to emails + + Parameters: + emails (list) : An instance of list + """ + + if emails is not None and not isinstance(emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emails EXPECTED TYPE: list', None, None) + + self.__emails = emails + self.__key_modified['Emails'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/api_exception.py new file mode 100644 index 0000000..4a880de --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email.py new file mode 100644 index 0000000..72bd267 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email.py @@ -0,0 +1,361 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class AssociateEmail(object): + def __init__(self): + """Creates an instance of AssociateEmail""" + + self.__from_1 = None + self.__to = None + self.__cc = None + self.__bcc = None + self.__attachments = None + self.__content = None + self.__mail_format = None + self.__subject = None + self.__original_message_id = None + self.__sent = None + self.__date_time = None + self.__linked_record = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + From: An instance of From + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (From) : An instance of From + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.from1 import From + except Exception: + from .from1 import From + + if from_1 is not None and not isinstance(from_1, From): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: From', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_bcc(self): + """ + The method to get the bcc + + Returns: + list: An instance of list + """ + + return self.__bcc + + def set_bcc(self, bcc): + """ + The method to set the value to bcc + + Parameters: + bcc (list) : An instance of list + """ + + if bcc is not None and not isinstance(bcc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc EXPECTED TYPE: list', None, None) + + self.__bcc = bcc + self.__key_modified['bcc'] = 1 + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_mail_format(self): + """ + The method to get the mail_format + + Returns: + Choice: An instance of Choice + """ + + return self.__mail_format + + def set_mail_format(self, mail_format): + """ + The method to set the value to mail_format + + Parameters: + mail_format (Choice) : An instance of Choice + """ + + if mail_format is not None and not isinstance(mail_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_format EXPECTED TYPE: Choice', None, None) + + self.__mail_format = mail_format + self.__key_modified['mail_format'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_original_message_id(self): + """ + The method to get the original_message_id + + Returns: + string: A string representing the original_message_id + """ + + return self.__original_message_id + + def set_original_message_id(self, original_message_id): + """ + The method to set the value to original_message_id + + Parameters: + original_message_id (string) : A string representing the original_message_id + """ + + if original_message_id is not None and not isinstance(original_message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: original_message_id EXPECTED TYPE: str', None, None) + + self.__original_message_id = original_message_id + self.__key_modified['original_message_id'] = 1 + + def get_sent(self): + """ + The method to get the sent + + Returns: + bool: A bool representing the sent + """ + + return self.__sent + + def set_sent(self, sent): + """ + The method to set the value to sent + + Parameters: + sent (bool) : A bool representing the sent + """ + + if sent is not None and not isinstance(sent, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent EXPECTED TYPE: bool', None, None) + + self.__sent = sent + self.__key_modified['sent'] = 1 + + def get_date_time(self): + """ + The method to get the date_time + + Returns: + datetime: An instance of datetime + """ + + return self.__date_time + + def set_date_time(self, date_time): + """ + The method to set the value to date_time + + Parameters: + date_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if date_time is not None and not isinstance(date_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date_time EXPECTED TYPE: datetime', None, None) + + self.__date_time = date_time + self.__key_modified['date_time'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email_operations.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email_operations.py new file mode 100644 index 0000000..2601bfb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/associate_email_operations.py @@ -0,0 +1,61 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class AssociateEmailOperations(object): + def __init__(self): + """Creates an instance of AssociateEmailOperations""" + pass + + def associate(self, recordid, module, request): + """ + The method to associate + + Parameters: + recordid (int) : An int representing the recordid + module (string) : A string representing the module + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(recordid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recordid EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(recordid) + api_path = api_path + '/actions/associate_email' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/attachments.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/attachments.py new file mode 100644 index 0000000..ef5d1a9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/attachments.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachments(object): + def __init__(self): + """Creates an instance of Attachments""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/available.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/available.py new file mode 100644 index 0000000..8084bad --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/available.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Available(object): + def __init__(self): + """Creates an instance of Available""" + + self.__available = None + self.__record = None + self.__linked_record = None + self.__key_modified = dict() + + def get_available(self): + """ + The method to get the available + + Returns: + bool: A bool representing the available + """ + + return self.__available + + def set_available(self, available): + """ + The method to set the value to available + + Parameters: + available (bool) : A bool representing the available + """ + + if available is not None and not isinstance(available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available EXPECTED TYPE: bool', None, None) + + self.__available = available + self.__key_modified['available'] = 1 + + def get_record(self): + """ + The method to get the record + + Returns: + Record: An instance of Record + """ + + return self.__record + + def set_record(self, record): + """ + The method to set the value to record + + Parameters: + record (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.record import Record + except Exception: + from .record import Record + + if record is not None and not isinstance(record, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: Record', None, None) + + self.__record = record + self.__key_modified['record'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/body_wrapper.py new file mode 100644 index 0000000..99f093d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__emails = None + self.__key_modified = dict() + + def get_emails(self): + """ + The method to get the emails + + Returns: + list: An instance of list + """ + + return self.__emails + + def set_emails(self, emails): + """ + The method to set the value to emails + + Parameters: + emails (list) : An instance of list + """ + + if emails is not None and not isinstance(emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emails EXPECTED TYPE: list', None, None) + + self.__emails = emails + self.__key_modified['Emails'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/from1.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/from1.py new file mode 100644 index 0000000..9999b7b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/from1.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class From(object): + def __init__(self): + """Creates an instance of From""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/linked_record.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/linked_record.py new file mode 100644 index 0000000..1896540 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/linked_record.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedRecord(object): + def __init__(self): + """Creates an instance of LinkedRecord""" + + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/module_map.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/module_map.py new file mode 100644 index 0000000..cec4563 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/module_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleMap(object): + def __init__(self): + """Creates an instance of ModuleMap""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/record.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/record.py new file mode 100644 index 0000000..a0c8ca2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/record.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__module = None + self.__id = None + self.__linked_record = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.associate_email.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/success_response.py new file mode 100644 index 0000000..f0960c0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.associate_email.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/associate_email/to.py b/zohocrmsdk/src/com/zoho/crm/api/associate_email/to.py new file mode 100644 index 0000000..dbe309e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/associate_email/to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class To(object): + def __init__(self): + """Creates an instance of To""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/__init__.py new file mode 100644 index 0000000..70487ee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/__init__.py @@ -0,0 +1,13 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .attachments_operations import AttachmentsOperations, GetAttachmentsParam, UploadUrlAttachmentsParam, DeleteAttachmentsParam +from .attachment import Attachment +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .parent_id import ParentId +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/action_wrapper.py new file mode 100644 index 0000000..c20da36 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/api_exception.py new file mode 100644 index 0000000..f677437 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/attachment.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/attachment.py new file mode 100644 index 0000000..3cd9cae --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/attachment.py @@ -0,0 +1,498 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachment(object): + def __init__(self): + """Creates an instance of Attachment""" + + self.__owner = None + self.__modified_by = None + self.__created_by = None + self.__parent_id = None + self.__sharing_permission = None + self.__attachment_type = None + self.__id = None + self.__modified_time = None + self.__created_time = None + self.__file_name = None + self.__size = None + self.__editable = None + self.__file_id = None + self.__type = None + self.__se_module = None + self.__state = None + self.__link_url = None + self.__key_modified = dict() + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['Owner'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['Modified_By'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['Created_By'] = 1 + + def get_parent_id(self): + """ + The method to get the parent_id + + Returns: + ParentId: An instance of ParentId + """ + + return self.__parent_id + + def set_parent_id(self, parent_id): + """ + The method to set the value to parent_id + + Parameters: + parent_id (ParentId) : An instance of ParentId + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.parent_id import ParentId + except Exception: + from .parent_id import ParentId + + if parent_id is not None and not isinstance(parent_id, ParentId): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: ParentId', None, None) + + self.__parent_id = parent_id + self.__key_modified['Parent_Id'] = 1 + + def get_sharing_permission(self): + """ + The method to get the sharing_permission + + Returns: + string: A string representing the sharing_permission + """ + + return self.__sharing_permission + + def set_sharing_permission(self, sharing_permission): + """ + The method to set the value to sharing_permission + + Parameters: + sharing_permission (string) : A string representing the sharing_permission + """ + + if sharing_permission is not None and not isinstance(sharing_permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: str', None, None) + + self.__sharing_permission = sharing_permission + self.__key_modified['$sharing_permission'] = 1 + + def get_attachment_type(self): + """ + The method to get the attachment_type + + Returns: + int: An int representing the attachment_type + """ + + return self.__attachment_type + + def set_attachment_type(self, attachment_type): + """ + The method to set the value to attachment_type + + Parameters: + attachment_type (int) : An int representing the attachment_type + """ + + if attachment_type is not None and not isinstance(attachment_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_type EXPECTED TYPE: int', None, None) + + self.__attachment_type = attachment_type + self.__key_modified['$attachment_type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['Created_Time'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['File_Name'] = 1 + + def get_size(self): + """ + The method to get the size + + Returns: + string: A string representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (string) : A string representing the size + """ + + if size is not None and not isinstance(size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: str', None, None) + + self.__size = size + self.__key_modified['Size'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['$editable'] = 1 + + def get_file_id(self): + """ + The method to get the file_id + + Returns: + string: A string representing the file_id + """ + + return self.__file_id + + def set_file_id(self, file_id): + """ + The method to set the value to file_id + + Parameters: + file_id (string) : A string representing the file_id + """ + + if file_id is not None and not isinstance(file_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: str', None, None) + + self.__file_id = file_id + self.__key_modified['$file_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['$type'] = 1 + + def get_se_module(self): + """ + The method to get the se_module + + Returns: + string: A string representing the se_module + """ + + return self.__se_module + + def set_se_module(self, se_module): + """ + The method to set the value to se_module + + Parameters: + se_module (string) : A string representing the se_module + """ + + if se_module is not None and not isinstance(se_module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: se_module EXPECTED TYPE: str', None, None) + + self.__se_module = se_module + self.__key_modified['$se_module'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['$state'] = 1 + + def get_link_url(self): + """ + The method to get the link_url + + Returns: + string: A string representing the link_url + """ + + return self.__link_url + + def set_link_url(self, link_url): + """ + The method to set the value to link_url + + Parameters: + link_url (string) : A string representing the link_url + """ + + if link_url is not None and not isinstance(link_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: link_url EXPECTED TYPE: str', None, None) + + self.__link_url = link_url + self.__key_modified['$link_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/attachments_operations.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/attachments_operations.py new file mode 100644 index 0000000..0380ca3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/attachments_operations.py @@ -0,0 +1,304 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class AttachmentsOperations(object): + def __init__(self): + """Creates an instance of AttachmentsOperations""" + pass + + def upload_attachments(self, record_id, module, request): + """ + The method to upload attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + request (FileBodyWrapper) : An instance of FileBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_attachments(self, record_id, module, param_instance=None): + """ + The method to get attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def upload_url_attachments(self, record_id, module, param_instance=None): + """ + The method to upload url attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_attachments(self, record_id, module, param_instance=None): + """ + The method to delete attachments + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_attachment(self, id, record_id, module): + """ + The method to get attachment + + Parameters: + id (int) : An int representing the id + record_id (int) : An int representing the record_id + module (string) : A string representing the module + + 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) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'image/png') + + def delete_attachment(self, id, record_id, module): + """ + The method to delete attachment + + Parameters: + id (int) : An int representing the id + record_id (int) : An int representing the record_id + module (string) : A string representing the module + + 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) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Attachments/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAttachmentsParam(object): + fields = Param('fields', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + ids = Param('ids', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + page = Param('page', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + per_page = Param('per_page', 'com.zoho.crm.api.Attachments.GetAttachmentsParam') + + +class UploadUrlAttachmentsParam(object): + attachmenturl = Param('attachmentUrl', 'com.zoho.crm.api.Attachments.UploadUrlAttachmentsParam') + title = Param('title', 'com.zoho.crm.api.Attachments.UploadUrlAttachmentsParam') + + +class DeleteAttachmentsParam(object): + ids = Param('ids', 'com.zoho.crm.api.Attachments.DeleteAttachmentsParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/file_body_wrapper.py new file mode 100644 index 0000000..04e7acb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/info.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/owner.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/owner.py new file mode 100644 index 0000000..7c91803 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/owner.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__name = None + self.__email = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/parent_id.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/parent_id.py new file mode 100644 index 0000000..37fb995 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/parent_id.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ParentId(object): + def __init__(self): + """Creates an instance of ParentId""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/response_wrapper.py new file mode 100644 index 0000000..5f260d2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.attachments.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/attachments/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/attachments/success_response.py new file mode 100644 index 0000000..b461632 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/attachments/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.attachments.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/__init__.py new file mode 100644 index 0000000..3e42284 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .criteria import Criteria +from .module import Module +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .audit_log_export_operations import AuditLogExportOperations +from .field import Field +from .success_response import SuccessResponse +from .audit_log_export import AuditLogExport +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .user import User diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_wrapper.py new file mode 100644 index 0000000..2f30e4a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__audit_log_export = None + self.__key_modified = dict() + + def get_audit_log_export(self): + """ + The method to get the audit_log_export + + Returns: + list: An instance of list + """ + + return self.__audit_log_export + + def set_audit_log_export(self, audit_log_export): + """ + The method to set the value to audit_log_export + + Parameters: + audit_log_export (list) : An instance of list + """ + + if audit_log_export is not None and not isinstance(audit_log_export, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audit_log_export EXPECTED TYPE: list', None, None) + + self.__audit_log_export = audit_log_export + self.__key_modified['audit_log_export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/api_exception.py new file mode 100644 index 0000000..08d2ff2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export.py new file mode 100644 index 0000000..bbfa26b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export.py @@ -0,0 +1,265 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AuditLogExport(object): + def __init__(self): + """Creates an instance of AuditLogExport""" + + self.__criteria = None + self.__id = None + self.__status = None + self.__created_by = None + self.__download_links = None + self.__job_start_time = None + self.__job_end_time = None + self.__expiry_date = None + self.__key_modified = dict() + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_download_links(self): + """ + The method to get the download_links + + Returns: + list: An instance of list + """ + + return self.__download_links + + def set_download_links(self, download_links): + """ + The method to set the value to download_links + + Parameters: + download_links (list) : An instance of list + """ + + if download_links is not None and not isinstance(download_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_links EXPECTED TYPE: list', None, None) + + self.__download_links = download_links + self.__key_modified['download_links'] = 1 + + def get_job_start_time(self): + """ + The method to get the job_start_time + + Returns: + datetime: An instance of datetime + """ + + return self.__job_start_time + + def set_job_start_time(self, job_start_time): + """ + The method to set the value to job_start_time + + Parameters: + job_start_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if job_start_time is not None and not isinstance(job_start_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_start_time EXPECTED TYPE: datetime', None, None) + + self.__job_start_time = job_start_time + self.__key_modified['job_start_time'] = 1 + + def get_job_end_time(self): + """ + The method to get the job_end_time + + Returns: + datetime: An instance of datetime + """ + + return self.__job_end_time + + def set_job_end_time(self, job_end_time): + """ + The method to set the value to job_end_time + + Parameters: + job_end_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if job_end_time is not None and not isinstance(job_end_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_end_time EXPECTED TYPE: datetime', None, None) + + self.__job_end_time = job_end_time + self.__key_modified['job_end_time'] = 1 + + def get_expiry_date(self): + """ + The method to get the expiry_date + + Returns: + datetime: An instance of datetime + """ + + return self.__expiry_date + + def set_expiry_date(self, expiry_date): + """ + The method to set the value to expiry_date + + Parameters: + expiry_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if expiry_date is not None and not isinstance(expiry_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expiry_date EXPECTED TYPE: datetime', None, None) + + self.__expiry_date = expiry_date + self.__key_modified['expiry_date'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export_operations.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export_operations.py new file mode 100644 index 0000000..af6838b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/audit_log_export_operations.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class AuditLogExportOperations(object): + def __init__(self): + """Creates an instance of AuditLogExportOperations""" + pass + + def create_auditlog_export(self, request): + """ + The method to create auditlog export + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/audit_log_export' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_exported_auditlogs(self): + """ + The method to get exported auditlogs + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/audit_log_export' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_exported_auditlog(self, id): + """ + The method to get exported auditlog + + 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/v7/settings/audit_log_export/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/body_wrapper.py new file mode 100644 index 0000000..cd82ffa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__audit_log_export = None + self.__key_modified = dict() + + def get_audit_log_export(self): + """ + The method to get the audit_log_export + + Returns: + list: An instance of list + """ + + return self.__audit_log_export + + def set_audit_log_export(self, audit_log_export): + """ + The method to set the value to audit_log_export + + Parameters: + audit_log_export (list) : An instance of list + """ + + if audit_log_export is not None and not isinstance(audit_log_export, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audit_log_export EXPECTED TYPE: list', None, None) + + self.__audit_log_export = audit_log_export + self.__key_modified['audit_log_export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/criteria.py new file mode 100644 index 0000000..dedc9b0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__field = None + self.__comparator = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/field.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/field.py new file mode 100644 index 0000000..0ad50d5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/field.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/module.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/module.py new file mode 100644 index 0000000..93604c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_wrapper.py new file mode 100644 index 0000000..042cacf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__audit_log_export = None + self.__key_modified = dict() + + def get_audit_log_export(self): + """ + The method to get the audit_log_export + + Returns: + list: An instance of list + """ + + return self.__audit_log_export + + def set_audit_log_export(self, audit_log_export): + """ + The method to set the value to audit_log_export + + Parameters: + audit_log_export (list) : An instance of list + """ + + if audit_log_export is not None and not isinstance(audit_log_export, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audit_log_export EXPECTED TYPE: list', None, None) + + self.__audit_log_export = audit_log_export + self.__key_modified['audit_log_export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/success_response.py new file mode 100644 index 0000000..4e782f0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.audit_log_export.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/user.py b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/audit_log_export/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/available_currencies/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/__init__.py new file mode 100644 index 0000000..d05bd41 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/__init__.py @@ -0,0 +1,5 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .available_currencies_operations import AvailableCurrenciesOperations +from .response_wrapper import ResponseWrapper +from .currency import Currency diff --git a/zohocrmsdk/src/com/zoho/crm/api/available_currencies/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/api_exception.py new file mode 100644 index 0000000..858c618 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.available_currencies.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/available_currencies/available_currencies_operations.py b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/available_currencies_operations.py new file mode 100644 index 0000000..10c6175 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/available_currencies_operations.py @@ -0,0 +1,35 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class AvailableCurrenciesOperations(object): + def __init__(self): + """Creates an instance of AvailableCurrenciesOperations""" + pass + + def get_available_currencies(self): + """ + The method to get available currencies + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies/actions/available_currencies' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.available_currencies.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/available_currencies/currency.py b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/currency.py new file mode 100644 index 0000000..a23a795 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/currency.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__display_value = None + self.__decimal_separator = None + self.__symbol = None + self.__thousand_separator = None + self.__display_name = None + self.__iso_code = None + self.__decimal_places = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_decimal_separator(self): + """ + The method to get the decimal_separator + + Returns: + string: A string representing the decimal_separator + """ + + return self.__decimal_separator + + 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.__decimal_separator = decimal_separator + self.__key_modified['decimal_separator'] = 1 + + def get_symbol(self): + """ + The method to get the symbol + + Returns: + string: A string representing the symbol + """ + + return self.__symbol + + def set_symbol(self, symbol): + """ + The method to set the value to symbol + + Parameters: + symbol (string) : A string representing the symbol + """ + + if symbol is not None and not isinstance(symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: str', None, None) + + self.__symbol = symbol + self.__key_modified['symbol'] = 1 + + def get_thousand_separator(self): + """ + The method to get the thousand_separator + + Returns: + string: A string representing the thousand_separator + """ + + return self.__thousand_separator + + def set_thousand_separator(self, thousand_separator): + """ + The method to set the value to thousand_separator + + Parameters: + thousand_separator (string) : A string representing the thousand_separator + """ + + if thousand_separator is not None and not isinstance(thousand_separator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: thousand_separator EXPECTED TYPE: str', None, None) + + self.__thousand_separator = thousand_separator + self.__key_modified['thousand_separator'] = 1 + + def get_display_name(self): + """ + The method to get the display_name + + Returns: + string: A string representing the display_name + """ + + return self.__display_name + + def set_display_name(self, display_name): + """ + The method to set the value to display_name + + Parameters: + display_name (string) : A string representing the display_name + """ + + if display_name is not None and not isinstance(display_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_name EXPECTED TYPE: str', None, None) + + self.__display_name = display_name + self.__key_modified['display_name'] = 1 + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_decimal_places(self): + """ + The method to get the decimal_places + + Returns: + string: A string representing the decimal_places + """ + + return self.__decimal_places + + def set_decimal_places(self, decimal_places): + """ + The method to set the value to decimal_places + + Parameters: + decimal_places (string) : A string representing the decimal_places + """ + + if decimal_places is not None and not isinstance(decimal_places, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_places EXPECTED TYPE: str', None, None) + + self.__decimal_places = decimal_places + self.__key_modified['decimal_places'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_wrapper.py new file mode 100644 index 0000000..3407f48 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/available_currencies/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.available_currencies.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__available_currencies = None + self.__key_modified = dict() + + def get_available_currencies(self): + """ + The method to get the available_currencies + + Returns: + list: An instance of list + """ + + return self.__available_currencies + + def set_available_currencies(self, available_currencies): + """ + The method to set the value to available_currencies + + Parameters: + available_currencies (list) : An instance of list + """ + + if available_currencies is not None and not isinstance(available_currencies, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_currencies EXPECTED TYPE: list', None, None) + + self.__available_currencies = available_currencies + self.__key_modified['available_currencies'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/backup/__init__.py new file mode 100644 index 0000000..1b07848 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/__init__.py @@ -0,0 +1,17 @@ +from .action_wrapper import ActionWrapper +from .requester import Requester +from .backup import Backup +from .body_wrapper import BodyWrapper +from .history import History +from .api_exception import APIException +from .response_handler import ResponseHandler +from .urls_wrapper import UrlsWrapper +from .action_response import ActionResponse +from .urls import Urls +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .backup_operations import BackupOperations, HISTORYParam +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .history_wrapper import HistoryWrapper +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/backup/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/backup/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/backup/action_wrapper.py new file mode 100644 index 0000000..0250ae9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__backup = None + self.__key_modified = dict() + + def get_backup(self): + """ + The method to get the backup + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__backup + + def set_backup(self, backup): + """ + The method to set the value to backup + + Parameters: + backup (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if backup is not None and not isinstance(backup, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: backup EXPECTED TYPE: ActionResponse', None, None) + + self.__backup = backup + self.__key_modified['backup'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/backup/api_exception.py new file mode 100644 index 0000000..b86df08 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/backup.py b/zohocrmsdk/src/com/zoho/crm/api/backup/backup.py new file mode 100644 index 0000000..eca6bae --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/backup.py @@ -0,0 +1,208 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Backup(object): + def __init__(self): + """Creates an instance of Backup""" + + self.__rrule = None + self.__id = None + self.__start_date = None + self.__scheduled_date = None + self.__status = None + self.__requester = None + self.__key_modified = dict() + + def get_rrule(self): + """ + The method to get the rrule + + Returns: + string: A string representing the rrule + """ + + return self.__rrule + + def set_rrule(self, rrule): + """ + The method to set the value to rrule + + Parameters: + rrule (string) : A string representing the rrule + """ + + if rrule is not None and not isinstance(rrule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rrule EXPECTED TYPE: str', None, None) + + self.__rrule = rrule + self.__key_modified['rrule'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_start_date(self): + """ + The method to get the start_date + + Returns: + datetime: An instance of datetime + """ + + return self.__start_date + + def set_start_date(self, start_date): + """ + The method to set the value to start_date + + Parameters: + start_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if start_date is not None and not isinstance(start_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_date EXPECTED TYPE: datetime', None, None) + + self.__start_date = start_date + self.__key_modified['start_date'] = 1 + + def get_scheduled_date(self): + """ + The method to get the scheduled_date + + Returns: + datetime: An instance of datetime + """ + + return self.__scheduled_date + + def set_scheduled_date(self, scheduled_date): + """ + The method to set the value to scheduled_date + + Parameters: + scheduled_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if scheduled_date is not None and not isinstance(scheduled_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduled_date EXPECTED TYPE: datetime', None, None) + + self.__scheduled_date = scheduled_date + self.__key_modified['scheduled_date'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_requester(self): + """ + The method to get the requester + + Returns: + Requester: An instance of Requester + """ + + return self.__requester + + def set_requester(self, requester): + """ + The method to set the value to requester + + Parameters: + requester (Requester) : An instance of Requester + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.requester import Requester + except Exception: + from .requester import Requester + + if requester is not None and not isinstance(requester, Requester): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: requester EXPECTED TYPE: Requester', None, None) + + self.__requester = requester + self.__key_modified['requester'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/backup_operations.py b/zohocrmsdk/src/com/zoho/crm/api/backup/backup_operations.py new file mode 100644 index 0000000..1bcbf31 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/backup_operations.py @@ -0,0 +1,198 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class BackupOperations(object): + def __init__(self): + """Creates an instance of BackupOperations""" + pass + + def schedule(self, request): + """ + The method to schedule + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/bulk/v7/backup' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_details(self): + """ + The method to get details + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/backup' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_urls(self): + """ + The method to get urls + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/backup/urls' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def history(self, param_instance=None): + """ + The method to history + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/bulk/v7/backup/history' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def cancel(self, id): + """ + The method to cancel + + 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/bulk/v7/backup/' + api_path = api_path + str(id) + api_path = api_path + '/actions/cancel' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def download_backed_up_data(self, download_url): + """ + The method to download backed up data + + Parameters: + download_url (string) : A string representing the download_url + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(download_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_url EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/' + api_path = api_path + str(download_url) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/octet-stream') + + +class HISTORYParam(object): + page = Param('page', 'com.zoho.crm.api.Backup.HISTORYParam') + per_page = Param('per_page', 'com.zoho.crm.api.Backup.HISTORYParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/backup/body_wrapper.py new file mode 100644 index 0000000..d0a494d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__backup = None + self.__key_modified = dict() + + def get_backup(self): + """ + The method to get the backup + + Returns: + Backup: An instance of Backup + """ + + return self.__backup + + def set_backup(self, backup): + """ + The method to set the value to backup + + Parameters: + backup (Backup) : An instance of Backup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.backup import Backup + except Exception: + from .backup import Backup + + if backup is not None and not isinstance(backup, Backup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: backup EXPECTED TYPE: Backup', None, None) + + self.__backup = backup + self.__key_modified['backup'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/backup/file_body_wrapper.py new file mode 100644 index 0000000..3f1f589 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/history.py b/zohocrmsdk/src/com/zoho/crm/api/backup/history.py new file mode 100644 index 0000000..a14fe2c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/history.py @@ -0,0 +1,256 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class History(object): + def __init__(self): + """Creates an instance of History""" + + self.__id = None + self.__log_time = None + self.__action = None + self.__repeat_type = None + self.__count = None + self.__file_name = None + self.__state = None + self.__done_by = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_log_time(self): + """ + The method to get the log_time + + Returns: + datetime: An instance of datetime + """ + + return self.__log_time + + def set_log_time(self, log_time): + """ + The method to set the value to log_time + + Parameters: + log_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if log_time is not None and not isinstance(log_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: log_time EXPECTED TYPE: datetime', None, None) + + self.__log_time = log_time + self.__key_modified['log_time'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + string: A string representing the action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (string) : A string representing the action + """ + + if action is not None and not isinstance(action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: str', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_repeat_type(self): + """ + The method to get the repeat_type + + Returns: + string: A string representing the repeat_type + """ + + return self.__repeat_type + + def set_repeat_type(self, repeat_type): + """ + The method to set the value to repeat_type + + Parameters: + repeat_type (string) : A string representing the repeat_type + """ + + if repeat_type is not None and not isinstance(repeat_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: repeat_type EXPECTED TYPE: str', None, None) + + self.__repeat_type = repeat_type + self.__key_modified['repeat_type'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_done_by(self): + """ + The method to get the done_by + + Returns: + Requester: An instance of Requester + """ + + return self.__done_by + + def set_done_by(self, done_by): + """ + The method to set the value to done_by + + Parameters: + done_by (Requester) : An instance of Requester + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.requester import Requester + except Exception: + from .requester import Requester + + if done_by is not None and not isinstance(done_by, Requester): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: done_by EXPECTED TYPE: Requester', None, None) + + self.__done_by = done_by + self.__key_modified['done_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/history_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/backup/history_wrapper.py new file mode 100644 index 0000000..b727eda --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/history_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class HistoryWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of HistoryWrapper""" + super().__init__() + + self.__history = None + self.__info = None + self.__key_modified = dict() + + def get_history(self): + """ + The method to get the history + + Returns: + list: An instance of list + """ + + return self.__history + + def set_history(self, history): + """ + The method to set the value to history + + Parameters: + history (list) : An instance of list + """ + + if history is not None and not isinstance(history, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history EXPECTED TYPE: list', None, None) + + self.__history = history + self.__key_modified['history'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/info.py b/zohocrmsdk/src/com/zoho/crm/api/backup/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/requester.py b/zohocrmsdk/src/com/zoho/crm/api/backup/requester.py new file mode 100644 index 0000000..0e2d9a7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/requester.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Requester(object): + def __init__(self): + """Creates an instance of Requester""" + + self.__id = None + self.__name = None + self.__zuid = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/backup/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/backup/response_wrapper.py new file mode 100644 index 0000000..97ed619 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__backup = None + self.__key_modified = dict() + + def get_backup(self): + """ + The method to get the backup + + Returns: + Backup: An instance of Backup + """ + + return self.__backup + + def set_backup(self, backup): + """ + The method to set the value to backup + + Parameters: + backup (Backup) : An instance of Backup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.backup import Backup + except Exception: + from .backup import Backup + + if backup is not None and not isinstance(backup, Backup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: backup EXPECTED TYPE: Backup', None, None) + + self.__backup = backup + self.__key_modified['backup'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/backup/success_response.py new file mode 100644 index 0000000..5405fcb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/urls.py b/zohocrmsdk/src/com/zoho/crm/api/backup/urls.py new file mode 100644 index 0000000..510c7fa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/urls.py @@ -0,0 +1,126 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Urls(object): + def __init__(self): + """Creates an instance of Urls""" + + self.__data_links = None + self.__attachment_links = None + self.__expiry_date = None + self.__key_modified = dict() + + def get_data_links(self): + """ + The method to get the data_links + + Returns: + list: An instance of list + """ + + return self.__data_links + + def set_data_links(self, data_links): + """ + The method to set the value to data_links + + Parameters: + data_links (list) : An instance of list + """ + + if data_links is not None and not isinstance(data_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_links EXPECTED TYPE: list', None, None) + + self.__data_links = data_links + self.__key_modified['data_links'] = 1 + + def get_attachment_links(self): + """ + The method to get the attachment_links + + Returns: + list: An instance of list + """ + + return self.__attachment_links + + def set_attachment_links(self, attachment_links): + """ + The method to set the value to attachment_links + + Parameters: + attachment_links (list) : An instance of list + """ + + if attachment_links is not None and not isinstance(attachment_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_links EXPECTED TYPE: list', None, None) + + self.__attachment_links = attachment_links + self.__key_modified['attachment_links'] = 1 + + def get_expiry_date(self): + """ + The method to get the expiry_date + + Returns: + datetime: An instance of datetime + """ + + return self.__expiry_date + + def set_expiry_date(self, expiry_date): + """ + The method to set the value to expiry_date + + Parameters: + expiry_date (datetime) : An instance of datetime + """ + + from datetime import datetime + + if expiry_date is not None and not isinstance(expiry_date, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expiry_date EXPECTED TYPE: datetime', None, None) + + self.__expiry_date = expiry_date + self.__key_modified['expiry_date'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/backup/urls_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/backup/urls_wrapper.py new file mode 100644 index 0000000..3199348 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/backup/urls_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.backup.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class UrlsWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of UrlsWrapper""" + super().__init__() + + self.__urls = None + self.__key_modified = dict() + + def get_urls(self): + """ + The method to get the urls + + Returns: + Urls: An instance of Urls + """ + + return self.__urls + + def set_urls(self, urls): + """ + The method to set the value to urls + + Parameters: + urls (Urls) : An instance of Urls + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.backup.urls import Urls + except Exception: + from .urls import Urls + + if urls is not None and not isinstance(urls, Urls): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: urls EXPECTED TYPE: Urls', None, None) + + self.__urls = urls + self.__key_modified['urls'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/__init__.py new file mode 100644 index 0000000..cbd3da9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/__init__.py @@ -0,0 +1,26 @@ +from .crypt import Crypt +from .current_picklist import CurrentPicklist +from .tool_tip import ToolTip +from .api_exception import APIException +from .response_handler import ResponseHandler +from .association_details import AssociationDetails +from .success_response import SuccessResponse +from .currency import Currency +from .action_handler import ActionHandler +from .profile import Profile +from .module import Module +from .view_type import ViewType +from .lookup_field import LookupField +from .body_wrapper import BodyWrapper +from .next_transition import NextTransition +from .transition import Transition +from .multi_select_lookup import MultiSelectLookup +from .layout import Layout +from .field import Field +from .process_info import ProcessInfo +from .escalation import Escalation +from .blueprint_operations import BlueprintOperations +from .response_wrapper import ResponseWrapper +from .formula import Formula +from .auto_number import AutoNumber +from .blue_print import BluePrint diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/api_exception.py new file mode 100644 index 0000000..d972cb8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.blueprint.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.blueprint.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/association_details.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/association_details.py new file mode 100644 index 0000000..ce0f0d5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/association_details.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationDetails(object): + def __init__(self): + """Creates an instance of AssociationDetails""" + + self.__lookup_field = None + self.__related_field = None + self.__key_modified = dict() + + def get_lookup_field(self): + """ + The method to get the lookup_field + + Returns: + LookupField: An instance of LookupField + """ + + return self.__lookup_field + + def set_lookup_field(self, lookup_field): + """ + The method to set the value to lookup_field + + Parameters: + lookup_field (LookupField) : An instance of LookupField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.lookup_field import LookupField + except Exception: + from .lookup_field import LookupField + + if lookup_field is not None and not isinstance(lookup_field, LookupField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_field EXPECTED TYPE: LookupField', None, None) + + self.__lookup_field = lookup_field + self.__key_modified['lookup_field'] = 1 + + def get_related_field(self): + """ + The method to get the related_field + + Returns: + LookupField: An instance of LookupField + """ + + return self.__related_field + + def set_related_field(self, related_field): + """ + The method to set the value to related_field + + Parameters: + related_field (LookupField) : An instance of LookupField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.lookup_field import LookupField + except Exception: + from .lookup_field import LookupField + + if related_field is not None and not isinstance(related_field, LookupField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_field EXPECTED TYPE: LookupField', None, None) + + self.__related_field = related_field + self.__key_modified['related_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/auto_number.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/auto_number.py new file mode 100644 index 0000000..1738d1d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/auto_number.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutoNumber(object): + def __init__(self): + """Creates an instance of AutoNumber""" + + self.__prefix = None + self.__suffix = None + self.__start_number = None + self.__key_modified = dict() + + def get_prefix(self): + """ + The method to get the prefix + + Returns: + string: A string representing the prefix + """ + + return self.__prefix + + def set_prefix(self, prefix): + """ + The method to set the value to prefix + + Parameters: + prefix (string) : A string representing the prefix + """ + + if prefix is not None and not isinstance(prefix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix EXPECTED TYPE: str', None, None) + + self.__prefix = prefix + self.__key_modified['prefix'] = 1 + + def get_suffix(self): + """ + The method to get the suffix + + Returns: + string: A string representing the suffix + """ + + return self.__suffix + + def set_suffix(self, suffix): + """ + The method to set the value to suffix + + Parameters: + suffix (string) : A string representing the suffix + """ + + if suffix is not None and not isinstance(suffix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suffix EXPECTED TYPE: str', None, None) + + self.__suffix = suffix + self.__key_modified['suffix'] = 1 + + def get_start_number(self): + """ + The method to get the start_number + + Returns: + int: An int representing the start_number + """ + + return self.__start_number + + def set_start_number(self, start_number): + """ + The method to set the value to start_number + + Parameters: + start_number (int) : An int representing the start_number + """ + + if start_number is not None and not isinstance(start_number, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_number EXPECTED TYPE: int', None, None) + + self.__start_number = start_number + self.__key_modified['start_number'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/blue_print.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/blue_print.py new file mode 100644 index 0000000..e6b614d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/blue_print.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BluePrint(object): + def __init__(self): + """Creates an instance of BluePrint""" + + self.__transition_id = None + self.__data = None + self.__process_info = None + self.__transitions = None + self.__key_modified = dict() + + def get_transition_id(self): + """ + The method to get the transition_id + + Returns: + string: A string representing the transition_id + """ + + return self.__transition_id + + def set_transition_id(self, transition_id): + """ + The method to set the value to transition_id + + Parameters: + transition_id (string) : A string representing the transition_id + """ + + if transition_id is not None and not isinstance(transition_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transition_id EXPECTED TYPE: str', None, None) + + self.__transition_id = transition_id + self.__key_modified['transition_id'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + Record: An instance of Record + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if data is not None and not isinstance(data, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Record', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_process_info(self): + """ + The method to get the process_info + + Returns: + ProcessInfo: An instance of ProcessInfo + """ + + return self.__process_info + + def set_process_info(self, process_info): + """ + The method to set the value to process_info + + Parameters: + process_info (ProcessInfo) : An instance of ProcessInfo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.process_info import ProcessInfo + except Exception: + from .process_info import ProcessInfo + + if process_info is not None and not isinstance(process_info, ProcessInfo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_info EXPECTED TYPE: ProcessInfo', None, None) + + self.__process_info = process_info + self.__key_modified['process_info'] = 1 + + def get_transitions(self): + """ + The method to get the transitions + + Returns: + list: An instance of list + """ + + return self.__transitions + + def set_transitions(self, transitions): + """ + The method to set the value to transitions + + Parameters: + transitions (list) : An instance of list + """ + + if transitions is not None and not isinstance(transitions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transitions EXPECTED TYPE: list', None, None) + + self.__transitions = transitions + self.__key_modified['transitions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/blueprint_operations.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/blueprint_operations.py new file mode 100644 index 0000000..b2c75f0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/blueprint_operations.py @@ -0,0 +1,95 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class BlueprintOperations(object): + def __init__(self, record_id, module_api_name): + """ + Creates an instance of BlueprintOperations with the given parameters + + Parameters: + record_id (string) : A string representing the record_id + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(record_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: str', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module_api_name = module_api_name + + + def get_blueprint(self): + """ + The method to get blueprint + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + 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/blueprint' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_blueprint(self, request): + """ + The method to update blueprint + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + 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/blueprint' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/body_wrapper.py new file mode 100644 index 0000000..45b0c96 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__blueprint = None + self.__key_modified = dict() + + def get_blueprint(self): + """ + The method to get the blueprint + + Returns: + list: An instance of list + """ + + return self.__blueprint + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/crypt.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/crypt.py new file mode 100644 index 0000000..c4a477b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/crypt.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Crypt(object): + def __init__(self): + """Creates an instance of Crypt""" + + self.__mode = None + self.__column = None + self.__table = None + self.__status = None + self.__key_modified = dict() + + def get_mode(self): + """ + The method to get the mode + + Returns: + string: A string representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (string) : A string representing the mode + """ + + if mode is not None and not isinstance(mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: str', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_column(self): + """ + The method to get the column + + Returns: + string: A string representing the column + """ + + return self.__column + + def set_column(self, column): + """ + The method to set the value to column + + Parameters: + column (string) : A string representing the column + """ + + if column is not None and not isinstance(column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: str', None, None) + + self.__column = column + self.__key_modified['column'] = 1 + + def get_table(self): + """ + The method to get the table + + Returns: + string: A string representing the table + """ + + return self.__table + + def set_table(self, table): + """ + The method to set the value to table + + Parameters: + table (string) : A string representing the table + """ + + if table is not None and not isinstance(table, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: table EXPECTED TYPE: str', None, None) + + self.__table = table + self.__key_modified['table'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + int: An int representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (int) : An int representing the status + """ + + if status is not None and not isinstance(status, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: int', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/currency.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/currency.py new file mode 100644 index 0000000..9dae60b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/currency.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__rounding_option = None + self.__precision = None + self.__key_modified = dict() + + def get_rounding_option(self): + """ + The method to get the rounding_option + + Returns: + string: A string representing the rounding_option + """ + + return self.__rounding_option + + def set_rounding_option(self, rounding_option): + """ + The method to set the value to rounding_option + + Parameters: + rounding_option (string) : A string representing the rounding_option + """ + + if rounding_option is not None and not isinstance(rounding_option, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rounding_option EXPECTED TYPE: str', None, None) + + self.__rounding_option = rounding_option + self.__key_modified['rounding_option'] = 1 + + def get_precision(self): + """ + The method to get the precision + + Returns: + int: An int representing the precision + """ + + return self.__precision + + def set_precision(self, precision): + """ + The method to set the value to precision + + Parameters: + precision (int) : An int representing the precision + """ + + if precision is not None and not isinstance(precision, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: precision EXPECTED TYPE: int', None, None) + + self.__precision = precision + self.__key_modified['precision'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/current_picklist.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/current_picklist.py new file mode 100644 index 0000000..59fa325 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/current_picklist.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CurrentPicklist(object): + def __init__(self): + """Creates an instance of CurrentPicklist""" + + self.__colour_code = None + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/escalation.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/escalation.py new file mode 100644 index 0000000..13c4847 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/escalation.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Escalation(object): + def __init__(self): + """Creates an instance of Escalation""" + + self.__days = None + self.__status = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + int: An int representing the days + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (int) : An int representing the days + """ + + if days is not None and not isinstance(days, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: int', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/field.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/field.py new file mode 100644 index 0000000..3e924b0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/field.py @@ -0,0 +1,1269 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__external = None + self.__display_type = None + self.__filterable = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__ui_type = None + self.__private = None + self.__system_mandatory = None + self.__webhook = None + self.__json_type = None + self.__crypt = None + self.__field_label = None + self.__tooltip = None + self.__created_source = None + self.__layouts = None + self.__field_read_only = None + self.__content = None + self.__display_label = None + self.__validation_rule = None + self.__read_only = None + self.__association_details = None + self.__multi_module_lookup = None + self.__currency = None + self.__id = None + self.__custom_field = None + self.__lookup = None + self.__convert_mapping = None + self.__visible = None + self.__length = None + self.__column_name = None + self.__type = None + self.__view_type = None + self.__transition_sequence = None + self.__api_name = None + self.__unique = None + self.__history_tracking = None + self.__data_type = None + self.__formula = None + self.__decimal_place = None + self.__multiselectlookup = None + self.__pick_list_values = None + self.__auto_number = None + self.__personality_name = None + self.__mandatory = None + self.__quick_sequence_number = None + self.__profiles = None + self.__key_modified = dict() + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import External + except Exception: + from ..fields import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + Choice: An instance of Choice + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (Choice) : An instance of Choice + """ + + if display_type is not None and not isinstance(display_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: Choice', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Private + except Exception: + from ..fields import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.crypt import Crypt + except Exception: + from .crypt import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + ToolTip: An instance of ToolTip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (ToolTip) : An instance of ToolTip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.tool_tip import ToolTip + except Exception: + from .tool_tip import ToolTip + + if tooltip is not None and not isinstance(tooltip, ToolTip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: ToolTip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + Layout: An instance of Layout + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.layout import Layout + except Exception: + from .layout import Layout + + if layouts is not None and not isinstance(layouts, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: Layout', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_validation_rule(self): + """ + The method to get the validation_rule + + Returns: + string: A string representing the validation_rule + """ + + return self.__validation_rule + + def set_validation_rule(self, validation_rule): + """ + The method to set the value to validation_rule + + Parameters: + validation_rule (string) : A string representing the validation_rule + """ + + if validation_rule is not None and not isinstance(validation_rule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: str', None, None) + + self.__validation_rule = validation_rule + self.__key_modified['validation_rule'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.association_details import AssociationDetails + except Exception: + from .association_details import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MultiModuleLookup + except Exception: + from ..fields import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.currency import Currency + except Exception: + from .currency import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Module: An instance of Module + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.module import Module + except Exception: + from .module import Module + + if lookup is not None and not isinstance(lookup, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Module', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + dict: An instance of dict + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (dict) : An instance of dict + """ + + if convert_mapping is not None and not isinstance(convert_mapping, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: dict', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['_type'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.view_type import ViewType + except Exception: + from .view_type import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_transition_sequence(self): + """ + The method to get the transition_sequence + + Returns: + int: An int representing the transition_sequence + """ + + return self.__transition_sequence + + def set_transition_sequence(self, transition_sequence): + """ + The method to set the value to transition_sequence + + Parameters: + transition_sequence (int) : An int representing the transition_sequence + """ + + if transition_sequence is not None and not isinstance(transition_sequence, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transition_sequence EXPECTED TYPE: int', None, None) + + self.__transition_sequence = transition_sequence + self.__key_modified['transition_sequence'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Unique + except Exception: + from ..fields import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + bool: A bool representing the history_tracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (bool) : A bool representing the history_tracking + """ + + if history_tracking is not None and not isinstance(history_tracking, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: bool', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.formula import Formula + except Exception: + from .formula import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + string: A string representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (string) : A string representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: str', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + MultiSelectLookup: An instance of MultiSelectLookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (MultiSelectLookup) : An instance of MultiSelectLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.multi_select_lookup import MultiSelectLookup + except Exception: + from .multi_select_lookup import MultiSelectLookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, MultiSelectLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: MultiSelectLookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_auto_number(self): + """ + The method to get the auto_number + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number + + def set_auto_number(self, auto_number): + """ + The method to set the value to auto_number + + Parameters: + auto_number (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.auto_number import AutoNumber + except Exception: + from .auto_number import AutoNumber + + if auto_number is not None and not isinstance(auto_number, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number = auto_number + self.__key_modified['auto_number'] = 1 + + def get_personality_name(self): + """ + The method to get the personality_name + + Returns: + string: A string representing the personality_name + """ + + return self.__personality_name + + def set_personality_name(self, personality_name): + """ + The method to set the value to personality_name + + Parameters: + personality_name (string) : A string representing the personality_name + """ + + if personality_name is not None and not isinstance(personality_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: personality_name EXPECTED TYPE: str', None, None) + + self.__personality_name = personality_name + self.__key_modified['personality_name'] = 1 + + def get_mandatory(self): + """ + The method to get the mandatory + + Returns: + bool: A bool representing the mandatory + """ + + return self.__mandatory + + def set_mandatory(self, mandatory): + """ + The method to set the value to mandatory + + Parameters: + mandatory (bool) : A bool representing the mandatory + """ + + if mandatory is not None and not isinstance(mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mandatory EXPECTED TYPE: bool', None, None) + + self.__mandatory = mandatory + self.__key_modified['mandatory'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + int: An int representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (int) : An int representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: int', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/formula.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/formula.py new file mode 100644 index 0000000..37fbe8f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/formula.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Formula(object): + def __init__(self): + """Creates an instance of Formula""" + + self.__return_type = None + self.__expression = None + self.__key_modified = dict() + + def get_return_type(self): + """ + The method to get the return_type + + Returns: + string: A string representing the return_type + """ + + return self.__return_type + + def set_return_type(self, return_type): + """ + The method to set the value to return_type + + Parameters: + return_type (string) : A string representing the return_type + """ + + if return_type is not None and not isinstance(return_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: str', None, None) + + self.__return_type = return_type + self.__key_modified['return_type'] = 1 + + def get_expression(self): + """ + The method to get the expression + + Returns: + int: An int representing the expression + """ + + return self.__expression + + def set_expression(self, expression): + """ + The method to set the value to expression + + Parameters: + expression (int) : An int representing the expression + """ + + if expression is not None and not isinstance(expression, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: int', None, None) + + self.__expression = expression + self.__key_modified['expression'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/layout.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/layout.py new file mode 100644 index 0000000..a7330c3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/lookup_field.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/lookup_field.py new file mode 100644 index 0000000..20f16d4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/lookup_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LookupField(object): + def __init__(self): + """Creates an instance of LookupField""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/module.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/module.py new file mode 100644 index 0000000..e8b84ed --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/module.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__display_label = None + self.__api_name = None + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/multi_select_lookup.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/multi_select_lookup.py new file mode 100644 index 0000000..4436532 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/multi_select_lookup.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiSelectLookup(object): + def __init__(self): + """Creates an instance of MultiSelectLookup""" + + self.__display_label = None + self.__linking_module = None + self.__lookup_apiname = None + self.__api_name = None + self.__connectedlookup_apiname = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_linking_module(self): + """ + The method to get the linking_module + + Returns: + string: A string representing the linking_module + """ + + return self.__linking_module + + def set_linking_module(self, linking_module): + """ + The method to set the value to linking_module + + Parameters: + linking_module (string) : A string representing the linking_module + """ + + if linking_module is not None and not isinstance(linking_module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linking_module EXPECTED TYPE: str', None, None) + + self.__linking_module = linking_module + self.__key_modified['linking_module'] = 1 + + def get_lookup_apiname(self): + """ + The method to get the lookup_apiname + + Returns: + string: A string representing the lookup_apiname + """ + + return self.__lookup_apiname + + def set_lookup_apiname(self, lookup_apiname): + """ + The method to set the value to lookup_apiname + + Parameters: + lookup_apiname (string) : A string representing the lookup_apiname + """ + + if lookup_apiname is not None and not isinstance(lookup_apiname, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_apiname EXPECTED TYPE: str', None, None) + + self.__lookup_apiname = lookup_apiname + self.__key_modified['lookup_apiname'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_connectedlookup_apiname(self): + """ + The method to get the connectedlookup_apiname + + Returns: + string: A string representing the connectedlookup_apiname + """ + + return self.__connectedlookup_apiname + + 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 get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/next_transition.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/next_transition.py new file mode 100644 index 0000000..6a31758 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/next_transition.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NextTransition(object): + def __init__(self): + """Creates an instance of NextTransition""" + + self.__id = None + self.__name = None + self.__criteria_matched = None + self.__type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_criteria_matched(self): + """ + The method to get the criteria_matched + + Returns: + bool: A bool representing the criteria_matched + """ + + return self.__criteria_matched + + def set_criteria_matched(self, criteria_matched): + """ + The method to set the value to criteria_matched + + Parameters: + criteria_matched (bool) : A bool representing the criteria_matched + """ + + if criteria_matched is not None and not isinstance(criteria_matched, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria_matched EXPECTED TYPE: bool', None, None) + + self.__criteria_matched = criteria_matched + self.__key_modified['criteria_matched'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/process_info.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/process_info.py new file mode 100644 index 0000000..7bed267 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/process_info.py @@ -0,0 +1,359 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ProcessInfo(object): + def __init__(self): + """Creates an instance of ProcessInfo""" + + self.__field_id = None + self.__is_continuous = None + self.__api_name = None + self.__continuous = None + self.__field_label = None + self.__name = None + self.__column_name = None + self.__field_value = None + self.__id = None + self.__field_name = None + self.__escalation = None + self.__current_picklist = None + self.__key_modified = dict() + + def get_field_id(self): + """ + The method to get the field_id + + Returns: + int: An int representing the field_id + """ + + return self.__field_id + + def set_field_id(self, field_id): + """ + The method to set the value to field_id + + Parameters: + field_id (int) : An int representing the field_id + """ + + if field_id is not None and not isinstance(field_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_id EXPECTED TYPE: int', None, None) + + self.__field_id = field_id + self.__key_modified['field_id'] = 1 + + def get_is_continuous(self): + """ + The method to get the is_continuous + + Returns: + bool: A bool representing the is_continuous + """ + + return self.__is_continuous + + def set_is_continuous(self, is_continuous): + """ + The method to set the value to is_continuous + + Parameters: + is_continuous (bool) : A bool representing the is_continuous + """ + + if is_continuous is not None and not isinstance(is_continuous, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_continuous EXPECTED TYPE: bool', None, None) + + self.__is_continuous = is_continuous + self.__key_modified['is_continuous'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_continuous(self): + """ + The method to get the continuous + + Returns: + bool: A bool representing the continuous + """ + + return self.__continuous + + def set_continuous(self, continuous): + """ + The method to set the value to continuous + + Parameters: + continuous (bool) : A bool representing the continuous + """ + + if continuous is not None and not isinstance(continuous, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: continuous EXPECTED TYPE: bool', None, None) + + self.__continuous = continuous + self.__key_modified['continuous'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_field_value(self): + """ + The method to get the field_value + + Returns: + string: A string representing the field_value + """ + + return self.__field_value + + def set_field_value(self, field_value): + """ + The method to set the value to field_value + + Parameters: + field_value (string) : A string representing the field_value + """ + + if field_value is not None and not isinstance(field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_value EXPECTED TYPE: str', None, None) + + self.__field_value = field_value + self.__key_modified['field_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_field_name(self): + """ + The method to get the field_name + + Returns: + string: A string representing the field_name + """ + + return self.__field_name + + def set_field_name(self, field_name): + """ + The method to set the value to field_name + + Parameters: + field_name (string) : A string representing the field_name + """ + + if field_name is not None and not isinstance(field_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_name EXPECTED TYPE: str', None, None) + + self.__field_name = field_name + self.__key_modified['field_name'] = 1 + + def get_escalation(self): + """ + The method to get the escalation + + Returns: + Escalation: An instance of Escalation + """ + + return self.__escalation + + def set_escalation(self, escalation): + """ + The method to set the value to escalation + + Parameters: + escalation (Escalation) : An instance of Escalation + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.escalation import Escalation + except Exception: + from .escalation import Escalation + + if escalation is not None and not isinstance(escalation, Escalation): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: escalation EXPECTED TYPE: Escalation', None, None) + + self.__escalation = escalation + self.__key_modified['escalation'] = 1 + + def get_current_picklist(self): + """ + The method to get the current_picklist + + Returns: + CurrentPicklist: An instance of CurrentPicklist + """ + + return self.__current_picklist + + def set_current_picklist(self, current_picklist): + """ + The method to set the value to current_picklist + + Parameters: + current_picklist (CurrentPicklist) : An instance of CurrentPicklist + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.current_picklist import CurrentPicklist + except Exception: + from .current_picklist import CurrentPicklist + + if current_picklist is not None and not isinstance(current_picklist, CurrentPicklist): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: current_picklist EXPECTED TYPE: CurrentPicklist', None, None) + + self.__current_picklist = current_picklist + self.__key_modified['current_picklist'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/profile.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/profile.py new file mode 100644 index 0000000..f1dfbfe --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/profile.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__id = None + self.__name = None + self.__permission_type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + string: A string representing the permission_type + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (string) : A string representing the permission_type + """ + + if permission_type is not None and not isinstance(permission_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: str', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_wrapper.py new file mode 100644 index 0000000..02461ee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.blueprint.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__blueprint = None + self.__key_modified = dict() + + def get_blueprint(self): + """ + The method to get the blueprint + + Returns: + BluePrint: An instance of BluePrint + """ + + return self.__blueprint + + def set_blueprint(self, blueprint): + """ + The method to set the value to blueprint + + Parameters: + blueprint (BluePrint) : An instance of BluePrint + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.blue_print import BluePrint + except Exception: + from .blue_print import BluePrint + + if blueprint is not None and not isinstance(blueprint, BluePrint): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint EXPECTED TYPE: BluePrint', None, None) + + self.__blueprint = blueprint + self.__key_modified['blueprint'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/success_response.py new file mode 100644 index 0000000..5f74baf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.blueprint.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class SuccessResponse(ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/tool_tip.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/tool_tip.py new file mode 100644 index 0000000..5031570 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/tool_tip.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ToolTip(object): + def __init__(self): + """Creates an instance of ToolTip""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/transition.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/transition.py new file mode 100644 index 0000000..4d8ef98 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/transition.py @@ -0,0 +1,436 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Transition(object): + def __init__(self): + """Creates an instance of Transition""" + + self.__type = None + self.__execution_time = None + self.__sequence = None + self.__next_transitions = None + self.__parent_transition = None + self.__percent_partial_save = None + self.__data = None + self.__next_field_value = None + self.__text_color_code = None + self.__name = None + self.__criteria_matched = None + self.__id = None + self.__fields = None + self.__color_code = None + self.__criteria_message = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_execution_time(self): + """ + The method to get the execution_time + + Returns: + datetime: An instance of datetime + """ + + return self.__execution_time + + def set_execution_time(self, execution_time): + """ + The method to set the value to execution_time + + Parameters: + execution_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if execution_time is not None and not isinstance(execution_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execution_time EXPECTED TYPE: datetime', None, None) + + self.__execution_time = execution_time + self.__key_modified['execution_time'] = 1 + + def get_sequence(self): + """ + The method to get the sequence + + Returns: + int: An int representing the sequence + """ + + return self.__sequence + + def set_sequence(self, sequence): + """ + The method to set the value to sequence + + Parameters: + sequence (int) : An int representing the sequence + """ + + if sequence is not None and not isinstance(sequence, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sequence EXPECTED TYPE: int', None, None) + + self.__sequence = sequence + self.__key_modified['sequence'] = 1 + + def get_next_transitions(self): + """ + The method to get the next_transitions + + Returns: + list: An instance of list + """ + + return self.__next_transitions + + def set_next_transitions(self, next_transitions): + """ + The method to set the value to next_transitions + + Parameters: + next_transitions (list) : An instance of list + """ + + if next_transitions is not None and not isinstance(next_transitions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_transitions EXPECTED TYPE: list', None, None) + + self.__next_transitions = next_transitions + self.__key_modified['next_transitions'] = 1 + + def get_parent_transition(self): + """ + The method to get the parent_transition + + Returns: + Transition: An instance of Transition + """ + + return self.__parent_transition + + def set_parent_transition(self, parent_transition): + """ + The method to set the value to parent_transition + + Parameters: + parent_transition (Transition) : An instance of Transition + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.blueprint.transition import Transition + except Exception: + from .transition import Transition + + if parent_transition is not None and not isinstance(parent_transition, Transition): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_transition EXPECTED TYPE: Transition', None, None) + + self.__parent_transition = parent_transition + self.__key_modified['parent_transition'] = 1 + + def get_percent_partial_save(self): + """ + The method to get the percent_partial_save + + Returns: + float: A float representing the percent_partial_save + """ + + return self.__percent_partial_save + + def set_percent_partial_save(self, percent_partial_save): + """ + The method to set the value to percent_partial_save + + Parameters: + percent_partial_save (float) : A float representing the percent_partial_save + """ + + if percent_partial_save is not None and not isinstance(percent_partial_save, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: percent_partial_save EXPECTED TYPE: float', None, None) + + self.__percent_partial_save = percent_partial_save + self.__key_modified['percent_partial_save'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + Record: An instance of Record + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if data is not None and not isinstance(data, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: Record', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_next_field_value(self): + """ + The method to get the next_field_value + + Returns: + string: A string representing the next_field_value + """ + + return self.__next_field_value + + def set_next_field_value(self, next_field_value): + """ + The method to set the value to next_field_value + + Parameters: + next_field_value (string) : A string representing the next_field_value + """ + + if next_field_value is not None and not isinstance(next_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_field_value EXPECTED TYPE: str', None, None) + + self.__next_field_value = next_field_value + self.__key_modified['next_field_value'] = 1 + + def get_text_color_code(self): + """ + The method to get the text_color_code + + Returns: + string: A string representing the text_color_code + """ + + return self.__text_color_code + + def set_text_color_code(self, text_color_code): + """ + The method to set the value to text_color_code + + Parameters: + text_color_code (string) : A string representing the text_color_code + """ + + if text_color_code is not None and not isinstance(text_color_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: text_color_code EXPECTED TYPE: str', None, None) + + self.__text_color_code = text_color_code + self.__key_modified['text_color_code'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_criteria_matched(self): + """ + The method to get the criteria_matched + + Returns: + bool: A bool representing the criteria_matched + """ + + return self.__criteria_matched + + def set_criteria_matched(self, criteria_matched): + """ + The method to set the value to criteria_matched + + Parameters: + criteria_matched (bool) : A bool representing the criteria_matched + """ + + if criteria_matched is not None and not isinstance(criteria_matched, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria_matched EXPECTED TYPE: bool', None, None) + + self.__criteria_matched = criteria_matched + self.__key_modified['criteria_matched'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_color_code(self): + """ + The method to get the color_code + + Returns: + string: A string representing the color_code + """ + + return self.__color_code + + def set_color_code(self, color_code): + """ + The method to set the value to color_code + + Parameters: + color_code (string) : A string representing the color_code + """ + + if color_code is not None and not isinstance(color_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: str', None, None) + + self.__color_code = color_code + self.__key_modified['color_code'] = 1 + + def get_criteria_message(self): + """ + The method to get the criteria_message + + Returns: + string: A string representing the criteria_message + """ + + return self.__criteria_message + + def set_criteria_message(self, criteria_message): + """ + The method to set the value to criteria_message + + Parameters: + criteria_message (string) : A string representing the criteria_message + """ + + if criteria_message is not None and not isinstance(criteria_message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria_message EXPECTED TYPE: str', None, None) + + self.__criteria_message = criteria_message + self.__key_modified['criteria_message'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/blueprint/view_type.py b/zohocrmsdk/src/com/zoho/crm/api/blueprint/view_type.py new file mode 100644 index 0000000..52a24e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/blueprint/view_type.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ViewType(object): + def __init__(self): + """Creates an instance of ViewType""" + + self.__view = None + self.__edit = None + self.__create = None + self.__quick_create = None + self.__key_modified = dict() + + def get_view(self): + """ + The method to get the view + + Returns: + bool: A bool representing the view + """ + + return self.__view + + def set_view(self, view): + """ + The method to set the value to view + + Parameters: + view (bool) : A bool representing the view + """ + + if view is not None and not isinstance(view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view EXPECTED TYPE: bool', None, None) + + self.__view = view + self.__key_modified['view'] = 1 + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_create(self): + """ + The method to get the create + + Returns: + bool: A bool representing the create + """ + + return self.__create + + def set_create(self, create): + """ + The method to set the value to create + + Parameters: + create (bool) : A bool representing the create + """ + + if create is not None and not isinstance(create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create EXPECTED TYPE: bool', None, None) + + self.__create = create + self.__key_modified['create'] = 1 + + def get_quick_create(self): + """ + The method to get the quick_create + + Returns: + bool: A bool representing the quick_create + """ + + return self.__quick_create + + def set_quick_create(self, quick_create): + """ + The method to set the value to quick_create + + Parameters: + quick_create (bool) : A bool representing the quick_create + """ + + if quick_create is not None and not isinstance(quick_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_create EXPECTED TYPE: bool', None, None) + + self.__quick_create = quick_create + self.__key_modified['quick_create'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/__init__.py new file mode 100644 index 0000000..e29fdca --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .module_details import ModuleDetails +from .criteria import Criteria +from .query import Query +from .body_wrapper import BodyWrapper +from .result import Result +from .job_detail import JobDetail +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .bulk_read_operations import BulkReadOperations +from .file_body_wrapper import FileBodyWrapper +from .success_response import SuccessResponse +from .call_back import CallBack +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_wrapper.py new file mode 100644 index 0000000..6e9559f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/action_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + dict: An instance of dict + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (dict) : An instance of dict + """ + + if info is not None and not isinstance(info, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: dict', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/api_exception.py new file mode 100644 index 0000000..39aa4e4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/body_wrapper.py new file mode 100644 index 0000000..ab103ae --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/body_wrapper.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__callback = None + self.__query = None + self.__file_type = None + self.__key_modified = dict() + + def get_callback(self): + """ + The method to get the callback + + Returns: + CallBack: An instance of CallBack + """ + + return self.__callback + + def set_callback(self, callback): + """ + The method to set the value to callback + + Parameters: + callback (CallBack) : An instance of CallBack + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.call_back import CallBack + except Exception: + from .call_back import CallBack + + if callback is not None and not isinstance(callback, CallBack): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', None, None) + + self.__callback = callback + self.__key_modified['callback'] = 1 + + def get_query(self): + """ + The method to get the query + + Returns: + Query: An instance of Query + """ + + return self.__query + + def set_query(self, query): + """ + The method to set the value to query + + Parameters: + query (Query) : An instance of Query + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.query import Query + except Exception: + from .query import Query + + if query is not None and not isinstance(query, Query): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query EXPECTED TYPE: Query', None, None) + + self.__query = query + self.__key_modified['query'] = 1 + + def get_file_type(self): + """ + The method to get the file_type + + Returns: + Choice: An instance of Choice + """ + + return self.__file_type + + def set_file_type(self, file_type): + """ + The method to set the value to file_type + + Parameters: + file_type (Choice) : An instance of Choice + """ + + if file_type is not None and not isinstance(file_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Choice', None, None) + + self.__file_type = file_type + self.__key_modified['file_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/bulk_read_operations.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/bulk_read_operations.py new file mode 100644 index 0000000..5c5047b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/bulk_read_operations.py @@ -0,0 +1,110 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class BulkReadOperations(object): + def __init__(self): + """Creates an instance of BulkReadOperations""" + pass + + def create_bulk_read_job(self, request): + """ + The method to create bulk read job + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/bulk/v7/read' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_bulk_read_job_details(self, job_id): + """ + The method to get bulk read job details + + Parameters: + job_id (int) : An int representing the job_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/read/' + api_path = api_path + str(job_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def download_result(self, job_id): + """ + The method to download result + + Parameters: + job_id (int) : An int representing the job_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/read/' + api_path = api_path + str(job_id) + api_path = api_path + '/result' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/x-download') diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/call_back.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/call_back.py new file mode 100644 index 0000000..57aa396 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/call_back.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class CallBack(object): + def __init__(self): + """Creates an instance of CallBack""" + + self.__url = None + self.__method = None + self.__key_modified = dict() + + def get_url(self): + """ + The method to get the url + + Returns: + string: A string representing the url + """ + + return self.__url + + def set_url(self, url): + """ + The method to set the value to url + + Parameters: + url (string) : A string representing the url + """ + + if url is not None and not isinstance(url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: url EXPECTED TYPE: str', None, None) + + self.__url = url + self.__key_modified['url'] = 1 + + def get_method(self): + """ + The method to get the method + + Returns: + Choice: An instance of Choice + """ + + return self.__method + + def set_method(self, method): + """ + The method to set the value to method + + Parameters: + method (Choice) : An instance of Choice + """ + + if method is not None and not isinstance(method, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: method EXPECTED TYPE: Choice', None, None) + + self.__method = method + self.__key_modified['method'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/criteria.py new file mode 100644 index 0000000..14e9ea7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/criteria.py @@ -0,0 +1,226 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__type = None + self.__api_name = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__field = None + self.__comparator = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + Choice: An instance of Choice + """ + + return self.__group_operator + + 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 get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MinifiedField + except Exception: + from ..fields import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + Choice: An instance of Choice + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (Choice) : An instance of Choice + """ + + if comparator is not None and not isinstance(comparator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Choice', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/file_body_wrapper.py new file mode 100644 index 0000000..c2032d2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/job_detail.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/job_detail.py new file mode 100644 index 0000000..f16dc00 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/job_detail.py @@ -0,0 +1,266 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class JobDetail(object): + def __init__(self): + """Creates an instance of JobDetail""" + + self.__id = None + self.__operation = None + self.__state = None + self.__query = None + self.__created_by = None + self.__created_time = None + self.__result = None + self.__file_type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_operation(self): + """ + The method to get the operation + + Returns: + string: A string representing the operation + """ + + return self.__operation + + def set_operation(self, operation): + """ + The method to set the value to operation + + Parameters: + operation (string) : A string representing the operation + """ + + if operation is not None and not isinstance(operation, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: str', None, None) + + self.__operation = operation + self.__key_modified['operation'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + Choice: An instance of Choice + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (Choice) : An instance of Choice + """ + + if state is not None and not isinstance(state, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: Choice', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_query(self): + """ + The method to get the query + + Returns: + Query: An instance of Query + """ + + return self.__query + + def set_query(self, query): + """ + The method to set the value to query + + Parameters: + query (Query) : An instance of Query + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.query import Query + except Exception: + from .query import Query + + if query is not None and not isinstance(query, Query): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query EXPECTED TYPE: Query', None, None) + + self.__query = query + self.__key_modified['query'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_result(self): + """ + The method to get the result + + Returns: + Result: An instance of Result + """ + + return self.__result + + def set_result(self, result): + """ + The method to set the value to result + + Parameters: + result (Result) : An instance of Result + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.result import Result + except Exception: + from .result import Result + + if result is not None and not isinstance(result, Result): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: result EXPECTED TYPE: Result', None, None) + + self.__result = result + self.__key_modified['result'] = 1 + + def get_file_type(self): + """ + The method to get the file_type + + Returns: + Choice: An instance of Choice + """ + + return self.__file_type + + def set_file_type(self, file_type): + """ + The method to set the value to file_type + + Parameters: + file_type (Choice) : An instance of Choice + """ + + if file_type is not None and not isinstance(file_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Choice', None, None) + + self.__file_type = file_type + self.__key_modified['file_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/module_details.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/module_details.py new file mode 100644 index 0000000..4804564 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/module_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleDetails(object): + def __init__(self): + """Creates an instance of ModuleDetails""" + + self.__api_name = None + self.__module = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/query.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/query.py new file mode 100644 index 0000000..c7bf58a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/query.py @@ -0,0 +1,234 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Query(object): + def __init__(self): + """Creates an instance of Query""" + + self.__module = None + self.__cvid = None + self.__fields = None + self.__page = None + self.__criteria = None + self.__file_type = None + self.__page_token = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + int: An int representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (int) : An int representing the cvid + """ + + if cvid is not None and not isinstance(cvid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: int', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_file_type(self): + """ + The method to get the file_type + + Returns: + Choice: An instance of Choice + """ + + return self.__file_type + + def set_file_type(self, file_type): + """ + The method to set the value to file_type + + Parameters: + file_type (Choice) : An instance of Choice + """ + + if file_type is not None and not isinstance(file_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_type EXPECTED TYPE: Choice', None, None) + + self.__file_type = file_type + self.__key_modified['file_type'] = 1 + + def get_page_token(self): + """ + The method to get the page_token + + Returns: + string: A string representing the page_token + """ + + return self.__page_token + + def set_page_token(self, page_token): + """ + The method to set the value to page_token + + Parameters: + page_token (string) : A string representing the page_token + """ + + if page_token is not None and not isinstance(page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token EXPECTED TYPE: str', None, None) + + self.__page_token = page_token + self.__key_modified['page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_wrapper.py new file mode 100644 index 0000000..0b45ffa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/result.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/result.py new file mode 100644 index 0000000..6c05187 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/result.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Result(object): + def __init__(self): + """Creates an instance of Result""" + + self.__page = None + self.__count = None + self.__download_url = None + self.__per_page = None + self.__more_records = None + self.__next_page_token = None + self.__key_modified = dict() + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_download_url(self): + """ + The method to get the download_url + + Returns: + string: A string representing the download_url + """ + + return self.__download_url + + 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 get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_read/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/success_response.py new file mode 100644 index 0000000..77c177a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_read/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_read.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/__init__.py new file mode 100644 index 0000000..4a7218a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/__init__.py @@ -0,0 +1,15 @@ +from .request_wrapper import RequestWrapper +from .resource import Resource +from .default_value import DefaultValue +from .bulk_write_operations import BulkWriteOperations, UploadFileHeader +from .result import Result +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .file import File +from .success_response import SuccessResponse +from .bulk_write_response import BulkWriteResponse +from .call_back import CallBack +from .file_body_wrapper import FileBodyWrapper +from .field_mapping import FieldMapping +from .response_wrapper import ResponseWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/api_exception.py new file mode 100644 index 0000000..38b591b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/api_exception.py @@ -0,0 +1,306 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .response_wrapper import ResponseWrapper + + +class APIException(ActionResponse, ResponseWrapper, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__error_message = None + self.__error_code = None + self.__x_error = None + self.__info = None + self.__x_info = None + self.__http_status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_error_message(self): + """ + The method to get the error_message + + Returns: + Choice: An instance of Choice + """ + + return self.__error_message + + def set_error_message(self, error_message): + """ + The method to set the value to error_message + + Parameters: + error_message (Choice) : An instance of Choice + """ + + if error_message is not None and not isinstance(error_message, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: error_message EXPECTED TYPE: Choice', None, None) + + self.__error_message = error_message + self.__key_modified['ERROR_MESSAGE'] = 1 + + def get_error_code(self): + """ + The method to get the error_code + + Returns: + int: An int representing the error_code + """ + + return self.__error_code + + def set_error_code(self, error_code): + """ + The method to set the value to error_code + + Parameters: + error_code (int) : An int representing the error_code + """ + + if error_code is not None and not isinstance(error_code, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: error_code EXPECTED TYPE: int', None, None) + + self.__error_code = error_code + self.__key_modified['ERROR_CODE'] = 1 + + def get_x_error(self): + """ + The method to get the x_error + + Returns: + Choice: An instance of Choice + """ + + return self.__x_error + + def set_x_error(self, x_error): + """ + The method to set the value to x_error + + Parameters: + x_error (Choice) : An instance of Choice + """ + + if x_error is not None and not isinstance(x_error, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_error EXPECTED TYPE: Choice', None, None) + + self.__x_error = x_error + self.__key_modified['x-error'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Choice: An instance of Choice + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Choice) : An instance of Choice + """ + + if info is not None and not isinstance(info, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Choice', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def get_x_info(self): + """ + The method to get the x_info + + Returns: + Choice: An instance of Choice + """ + + return self.__x_info + + def set_x_info(self, x_info): + """ + The method to set the value to x_info + + Parameters: + x_info (Choice) : An instance of Choice + """ + + if x_info is not None and not isinstance(x_info, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_info EXPECTED TYPE: Choice', None, None) + + self.__x_info = x_info + self.__key_modified['x-info'] = 1 + + def get_http_status(self): + """ + The method to get the http_status + + Returns: + string: A string representing the http_status + """ + + return self.__http_status + + def set_http_status(self, http_status): + """ + The method to set the value to http_status + + Parameters: + http_status (string) : A string representing the http_status + """ + + if http_status is not None and not isinstance(http_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: http_status EXPECTED TYPE: str', None, None) + + self.__http_status = http_status + self.__key_modified['http_status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_operations.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_operations.py new file mode 100644 index 0000000..a37faf0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_operations.py @@ -0,0 +1,163 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class BulkWriteOperations(object): + def __init__(self): + """Creates an instance of BulkWriteOperations""" + pass + + def upload_file(self, request, header_instance=None): + """ + The method to upload file + + Parameters: + request (FileBodyWrapper) : An instance of FileBodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + 'https://content.zohoapis.com/crm/v7/upload' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def create_bulk_write_job(self, request): + """ + The method to create bulk write job + + Parameters: + request (RequestWrapper) : An instance of RequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.request_wrapper import RequestWrapper + except Exception: + from .request_wrapper import RequestWrapper + + if request is not None and not isinstance(request, RequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/write' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def get_bulk_write_job_details(self, job_id): + """ + The method to get bulk write job details + + Parameters: + job_id (string) : A string representing the job_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(job_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/bulk/v7/write/' + api_path = api_path + str(job_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + def download_bulk_write_result(self, download_url): + """ + The method to download bulk write result + + Parameters: + download_url (string) : A string representing the download_url + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(download_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_url EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/' + api_path = api_path + str(download_url) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/octet-stream') + + +class UploadFileHeader(object): + feature = Header('feature', 'com.zoho.crm.api.BulkWrite.UploadFileHeader') + x_crm_org = Header('X-CRM-ORG', 'com.zoho.crm.api.BulkWrite.UploadFileHeader') diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_response.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_response.py new file mode 100644 index 0000000..243ab3a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/bulk_write_response.py @@ -0,0 +1,294 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_wrapper import ResponseWrapper + + +class BulkWriteResponse(ResponseWrapper): + def __init__(self): + """Creates an instance of BulkWriteResponse""" + super().__init__() + + self.__status = None + self.__character_encoding = None + self.__resource = None + self.__id = None + self.__result = None + self.__created_by = None + self.__operation = None + self.__created_time = None + self.__callback = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_character_encoding(self): + """ + The method to get the character_encoding + + Returns: + string: A string representing the character_encoding + """ + + return self.__character_encoding + + def set_character_encoding(self, character_encoding): + """ + The method to set the value to character_encoding + + Parameters: + character_encoding (string) : A string representing the character_encoding + """ + + if character_encoding is not None and not isinstance(character_encoding, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: character_encoding EXPECTED TYPE: str', None, None) + + self.__character_encoding = character_encoding + self.__key_modified['character_encoding'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + list: An instance of list + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (list) : An instance of list + """ + + if resource is not None and not isinstance(resource, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: list', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_result(self): + """ + The method to get the result + + Returns: + Result: An instance of Result + """ + + return self.__result + + def set_result(self, result): + """ + The method to set the value to result + + Parameters: + result (Result) : An instance of Result + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.result import Result + except Exception: + from .result import Result + + if result is not None and not isinstance(result, Result): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: result EXPECTED TYPE: Result', None, None) + + self.__result = result + self.__key_modified['result'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_operation(self): + """ + The method to get the operation + + Returns: + string: A string representing the operation + """ + + return self.__operation + + def set_operation(self, operation): + """ + The method to set the value to operation + + Parameters: + operation (string) : A string representing the operation + """ + + if operation is not None and not isinstance(operation, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: str', None, None) + + self.__operation = operation + self.__key_modified['operation'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_callback(self): + """ + The method to get the callback + + Returns: + CallBack: An instance of CallBack + """ + + return self.__callback + + def set_callback(self, callback): + """ + The method to set the value to callback + + Parameters: + callback (CallBack) : An instance of CallBack + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.call_back import CallBack + except Exception: + from .call_back import CallBack + + if callback is not None and not isinstance(callback, CallBack): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', None, None) + + self.__callback = callback + self.__key_modified['callback'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/call_back.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/call_back.py new file mode 100644 index 0000000..57aa396 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/call_back.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class CallBack(object): + def __init__(self): + """Creates an instance of CallBack""" + + self.__url = None + self.__method = None + self.__key_modified = dict() + + def get_url(self): + """ + The method to get the url + + Returns: + string: A string representing the url + """ + + return self.__url + + def set_url(self, url): + """ + The method to set the value to url + + Parameters: + url (string) : A string representing the url + """ + + if url is not None and not isinstance(url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: url EXPECTED TYPE: str', None, None) + + self.__url = url + self.__key_modified['url'] = 1 + + def get_method(self): + """ + The method to get the method + + Returns: + Choice: An instance of Choice + """ + + return self.__method + + def set_method(self, method): + """ + The method to set the value to method + + Parameters: + method (Choice) : An instance of Choice + """ + + if method is not None and not isinstance(method, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: method EXPECTED TYPE: Choice', None, None) + + self.__method = method + self.__key_modified['method'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/default_value.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/default_value.py new file mode 100644 index 0000000..0a4f50a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/default_value.py @@ -0,0 +1,121 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultValue(object): + def __init__(self): + """Creates an instance of DefaultValue""" + + self.__name = None + self.__module = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/field_mapping.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/field_mapping.py new file mode 100644 index 0000000..bfba0e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/field_mapping.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldMapping(object): + def __init__(self): + """Creates an instance of FieldMapping""" + + self.__api_name = None + self.__index = None + self.__format = None + self.__find_by = None + self.__default_value = None + self.__module = None + self.__parent_column_index = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_index(self): + """ + The method to get the index + + Returns: + int: An int representing the index + """ + + return self.__index + + def set_index(self, index): + """ + The method to set the value to index + + Parameters: + index (int) : An int representing the index + """ + + if index is not None and not isinstance(index, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: index EXPECTED TYPE: int', None, None) + + self.__index = index + self.__key_modified['index'] = 1 + + def get_format(self): + """ + The method to get the format + + Returns: + string: A string representing the format + """ + + return self.__format + + def set_format(self, format): + """ + The method to set the value to format + + Parameters: + format (string) : A string representing the format + """ + + if format is not None and not isinstance(format, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: str', None, None) + + self.__format = format + self.__key_modified['format'] = 1 + + def get_find_by(self): + """ + The method to get the find_by + + Returns: + string: A string representing the find_by + """ + + return self.__find_by + + def set_find_by(self, find_by): + """ + The method to set the value to find_by + + Parameters: + find_by (string) : A string representing the find_by + """ + + if find_by is not None and not isinstance(find_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: find_by EXPECTED TYPE: str', None, None) + + self.__find_by = find_by + self.__key_modified['find_by'] = 1 + + def get_default_value(self): + """ + The method to get the default_value + + Returns: + DefaultValue: An instance of DefaultValue + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (DefaultValue) : An instance of DefaultValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.default_value import DefaultValue + except Exception: + from .default_value import DefaultValue + + if default_value is not None and not isinstance(default_value, DefaultValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: DefaultValue', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_parent_column_index(self): + """ + The method to get the parent_column_index + + Returns: + int: An int representing the parent_column_index + """ + + return self.__parent_column_index + + def set_parent_column_index(self, parent_column_index): + """ + The method to set the value to parent_column_index + + Parameters: + parent_column_index (int) : An int representing the parent_column_index + """ + + if parent_column_index is not None and not isinstance(parent_column_index, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_column_index EXPECTED TYPE: int', None, None) + + self.__parent_column_index = parent_column_index + self.__key_modified['parent_column_index'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file.py new file mode 100644 index 0000000..154743d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class File(object): + def __init__(self): + """Creates an instance of File""" + + self.__status = None + self.__name = None + self.__added_count = None + self.__skipped_count = None + self.__updated_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_added_count(self): + """ + The method to get the added_count + + Returns: + int: An int representing the added_count + """ + + return self.__added_count + + def set_added_count(self, added_count): + """ + The method to set the value to added_count + + Parameters: + added_count (int) : An int representing the added_count + """ + + if added_count is not None and not isinstance(added_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: added_count EXPECTED TYPE: int', None, None) + + self.__added_count = added_count + self.__key_modified['added_count'] = 1 + + def get_skipped_count(self): + """ + The method to get the skipped_count + + Returns: + int: An int representing the skipped_count + """ + + return self.__skipped_count + + def set_skipped_count(self, skipped_count): + """ + The method to set the value to skipped_count + + Parameters: + skipped_count (int) : An int representing the skipped_count + """ + + if skipped_count is not None and not isinstance(skipped_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: skipped_count EXPECTED TYPE: int', None, None) + + self.__skipped_count = skipped_count + self.__key_modified['skipped_count'] = 1 + + def get_updated_count(self): + """ + The method to get the updated_count + + Returns: + int: An int representing the updated_count + """ + + return self.__updated_count + + def set_updated_count(self, updated_count): + """ + The method to set the value to updated_count + + Parameters: + updated_count (int) : An int representing the updated_count + """ + + if updated_count is not None and not isinstance(updated_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updated_count EXPECTED TYPE: int', None, None) + + self.__updated_count = updated_count + self.__key_modified['updated_count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['total_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file_body_wrapper.py new file mode 100644 index 0000000..90c5f3c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/request_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/request_wrapper.py new file mode 100644 index 0000000..22ca0a8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/request_wrapper.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class RequestWrapper(object): + def __init__(self): + """Creates an instance of RequestWrapper""" + + self.__character_encoding = None + self.__operation = None + self.__callback = None + self.__resource = None + self.__ignore_empty = None + self.__key_modified = dict() + + def get_character_encoding(self): + """ + The method to get the character_encoding + + Returns: + string: A string representing the character_encoding + """ + + return self.__character_encoding + + def set_character_encoding(self, character_encoding): + """ + The method to set the value to character_encoding + + Parameters: + character_encoding (string) : A string representing the character_encoding + """ + + if character_encoding is not None and not isinstance(character_encoding, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: character_encoding EXPECTED TYPE: str', None, None) + + self.__character_encoding = character_encoding + self.__key_modified['character_encoding'] = 1 + + def get_operation(self): + """ + The method to get the operation + + Returns: + Choice: An instance of Choice + """ + + return self.__operation + + def set_operation(self, operation): + """ + The method to set the value to operation + + Parameters: + operation (Choice) : An instance of Choice + """ + + if operation is not None and not isinstance(operation, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation EXPECTED TYPE: Choice', None, None) + + self.__operation = operation + self.__key_modified['operation'] = 1 + + def get_callback(self): + """ + The method to get the callback + + Returns: + CallBack: An instance of CallBack + """ + + return self.__callback + + def set_callback(self, callback): + """ + The method to set the value to callback + + Parameters: + callback (CallBack) : An instance of CallBack + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.call_back import CallBack + except Exception: + from .call_back import CallBack + + if callback is not None and not isinstance(callback, CallBack): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: callback EXPECTED TYPE: CallBack', None, None) + + self.__callback = callback + self.__key_modified['callback'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + list: An instance of list + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (list) : An instance of list + """ + + if resource is not None and not isinstance(resource, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: list', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_ignore_empty(self): + """ + The method to get the ignore_empty + + Returns: + bool: A bool representing the ignore_empty + """ + + return self.__ignore_empty + + def set_ignore_empty(self, ignore_empty): + """ + The method to set the value to ignore_empty + + Parameters: + ignore_empty (bool) : A bool representing the ignore_empty + """ + + if ignore_empty is not None and not isinstance(ignore_empty, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ignore_empty EXPECTED TYPE: bool', None, None) + + self.__ignore_empty = ignore_empty + self.__key_modified['ignore_empty'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/resource.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/resource.py new file mode 100644 index 0000000..a646a78 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/resource.py @@ -0,0 +1,309 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__status = None + self.__type = None + self.__module = None + self.__code = None + self.__file_id = None + self.__file_names = None + self.__ignore_empty = None + self.__find_by = None + self.__field_mappings = None + self.__file = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + string: A string representing the code + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (string) : A string representing the code + """ + + if code is not None and not isinstance(code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: str', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_file_id(self): + """ + The method to get the file_id + + Returns: + string: A string representing the file_id + """ + + return self.__file_id + + def set_file_id(self, file_id): + """ + The method to set the value to file_id + + Parameters: + file_id (string) : A string representing the file_id + """ + + if file_id is not None and not isinstance(file_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: str', None, None) + + self.__file_id = file_id + self.__key_modified['file_id'] = 1 + + def get_file_names(self): + """ + The method to get the file_names + + Returns: + list: An instance of list + """ + + return self.__file_names + + def set_file_names(self, file_names): + """ + The method to set the value to file_names + + Parameters: + file_names (list) : An instance of list + """ + + if file_names is not None and not isinstance(file_names, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_names EXPECTED TYPE: list', None, None) + + self.__file_names = file_names + self.__key_modified['file_names'] = 1 + + def get_ignore_empty(self): + """ + The method to get the ignore_empty + + Returns: + bool: A bool representing the ignore_empty + """ + + return self.__ignore_empty + + def set_ignore_empty(self, ignore_empty): + """ + The method to set the value to ignore_empty + + Parameters: + ignore_empty (bool) : A bool representing the ignore_empty + """ + + if ignore_empty is not None and not isinstance(ignore_empty, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ignore_empty EXPECTED TYPE: bool', None, None) + + self.__ignore_empty = ignore_empty + self.__key_modified['ignore_empty'] = 1 + + def get_find_by(self): + """ + The method to get the find_by + + Returns: + string: A string representing the find_by + """ + + return self.__find_by + + def set_find_by(self, find_by): + """ + The method to set the value to find_by + + Parameters: + find_by (string) : A string representing the find_by + """ + + if find_by is not None and not isinstance(find_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: find_by EXPECTED TYPE: str', None, None) + + self.__find_by = find_by + self.__key_modified['find_by'] = 1 + + def get_field_mappings(self): + """ + The method to get the field_mappings + + Returns: + list: An instance of list + """ + + return self.__field_mappings + + def set_field_mappings(self, field_mappings): + """ + The method to set the value to field_mappings + + Parameters: + field_mappings (list) : An instance of list + """ + + if field_mappings is not None and not isinstance(field_mappings, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_mappings EXPECTED TYPE: list', None, None) + + self.__field_mappings = field_mappings + self.__key_modified['field_mappings'] = 1 + + def get_file(self): + """ + The method to get the file + + Returns: + File: An instance of File + """ + + return self.__file + + def set_file(self, file): + """ + The method to set the value to file + + Parameters: + file (File) : An instance of File + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.file import File + except Exception: + from .file import File + + if file is not None and not isinstance(file, File): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: File', None, None) + + self.__file = file + self.__key_modified['file'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_wrapper.py new file mode 100644 index 0000000..1c2d2c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/response_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseWrapper(ABC): + def __init__(self): + """Creates an instance of ResponseWrapper""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/result.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/result.py new file mode 100644 index 0000000..d276229 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/result.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Result(object): + def __init__(self): + """Creates an instance of Result""" + + self.__download_url = None + self.__key_modified = dict() + + def get_download_url(self): + """ + The method to get the download_url + + Returns: + string: A string representing the download_url + """ + + return self.__download_url + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/bulk_write/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/success_response.py new file mode 100644 index 0000000..73f1b32 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/bulk_write/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.bulk_write.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/__init__.py new file mode 100644 index 0000000..d3bad25 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/__init__.py @@ -0,0 +1,13 @@ +from .business_hours import BusinessHours +from .action_wrapper import ActionWrapper +from .break_hours_custom_timing import BreakHoursCustomTiming +from .resources import Resources +from .body_wrapper import BodyWrapper +from .business_hours_operations import BusinessHoursOperations, CreateBusinessHoursHeader, UpdateBusinessHoursHeader, GetBusinessHoursHeader +from .features import Features +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_wrapper.py new file mode 100644 index 0000000..3d0a3bc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__business_hours = None + self.__key_modified = dict() + + def get_business_hours(self): + """ + The method to get the business_hours + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__business_hours + + def set_business_hours(self, business_hours): + """ + The method to set the value to business_hours + + Parameters: + business_hours (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if business_hours is not None and not isinstance(business_hours, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_hours EXPECTED TYPE: ActionResponse', None, None) + + self.__business_hours = business_hours + self.__key_modified['business_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/api_exception.py new file mode 100644 index 0000000..788e097 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.business_hours.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/body_wrapper.py new file mode 100644 index 0000000..3d6b156 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__business_hours = None + self.__key_modified = dict() + + def get_business_hours(self): + """ + The method to get the business_hours + + Returns: + BusinessHours: An instance of BusinessHours + """ + + return self.__business_hours + + def set_business_hours(self, business_hours): + """ + The method to set the value to business_hours + + Parameters: + business_hours (BusinessHours) : An instance of BusinessHours + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.business_hours import BusinessHours + except Exception: + from .business_hours import BusinessHours + + if business_hours is not None and not isinstance(business_hours, BusinessHours): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_hours EXPECTED TYPE: BusinessHours', None, None) + + self.__business_hours = business_hours + self.__key_modified['business_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/break_hours_custom_timing.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/break_hours_custom_timing.py new file mode 100644 index 0000000..a582f23 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/break_hours_custom_timing.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class BreakHoursCustomTiming(object): + def __init__(self): + """Creates an instance of BreakHoursCustomTiming""" + + self.__days = None + self.__business_timing = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + Choice: An instance of Choice + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (Choice) : An instance of Choice + """ + + if days is not None and not isinstance(days, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: Choice', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_business_timing(self): + """ + The method to get the business_timing + + Returns: + list: An instance of list + """ + + return self.__business_timing + + def set_business_timing(self, business_timing): + """ + The method to set the value to business_timing + + Parameters: + business_timing (list) : An instance of list + """ + + if business_timing is not None and not isinstance(business_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_timing EXPECTED TYPE: list', None, None) + + self.__business_timing = business_timing + self.__key_modified['business_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours.py new file mode 100644 index 0000000..e20a61d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class BusinessHours(object): + def __init__(self): + """Creates an instance of BusinessHours""" + + self.__week_starts_on = None + self.__type = None + self.__id = None + self.__business_days = None + self.__same_as_everyday = None + self.__daily_timing = None + self.__custom_timing = None + self.__key_modified = dict() + + def get_week_starts_on(self): + """ + The method to get the week_starts_on + + Returns: + Choice: An instance of Choice + """ + + return self.__week_starts_on + + def set_week_starts_on(self, week_starts_on): + """ + The method to set the value to week_starts_on + + Parameters: + week_starts_on (Choice) : An instance of Choice + """ + + if week_starts_on is not None and not isinstance(week_starts_on, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: week_starts_on EXPECTED TYPE: Choice', None, None) + + self.__week_starts_on = week_starts_on + self.__key_modified['week_starts_on'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_business_days(self): + """ + The method to get the business_days + + Returns: + list: An instance of list + """ + + return self.__business_days + + def set_business_days(self, business_days): + """ + The method to set the value to business_days + + Parameters: + business_days (list) : An instance of list + """ + + if business_days is not None and not isinstance(business_days, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_days EXPECTED TYPE: list', None, None) + + self.__business_days = business_days + self.__key_modified['business_days'] = 1 + + def get_same_as_everyday(self): + """ + The method to get the same_as_everyday + + Returns: + bool: A bool representing the same_as_everyday + """ + + return self.__same_as_everyday + + def set_same_as_everyday(self, same_as_everyday): + """ + The method to set the value to same_as_everyday + + Parameters: + same_as_everyday (bool) : A bool representing the same_as_everyday + """ + + if same_as_everyday is not None and not isinstance(same_as_everyday, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: same_as_everyday EXPECTED TYPE: bool', None, None) + + self.__same_as_everyday = same_as_everyday + self.__key_modified['same_as_everyday'] = 1 + + def get_daily_timing(self): + """ + The method to get the daily_timing + + Returns: + list: An instance of list + """ + + return self.__daily_timing + + def set_daily_timing(self, daily_timing): + """ + The method to set the value to daily_timing + + Parameters: + daily_timing (list) : An instance of list + """ + + if daily_timing is not None and not isinstance(daily_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: daily_timing EXPECTED TYPE: list', None, None) + + self.__daily_timing = daily_timing + self.__key_modified['daily_timing'] = 1 + + def get_custom_timing(self): + """ + The method to get the custom_timing + + Returns: + list: An instance of list + """ + + return self.__custom_timing + + def set_custom_timing(self, custom_timing): + """ + The method to set the value to custom_timing + + Parameters: + custom_timing (list) : An instance of list + """ + + if custom_timing is not None and not isinstance(custom_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_timing EXPECTED TYPE: list', None, None) + + self.__custom_timing = custom_timing + self.__key_modified['custom_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours_operations.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours_operations.py new file mode 100644 index 0000000..60b65dd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/business_hours_operations.py @@ -0,0 +1,136 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class BusinessHoursOperations(object): + def __init__(self, x_crm_org=None): + """ + Creates an instance of BusinessHoursOperations with the given parameters + + Parameters: + x_crm_org (string) : A string representing the x_crm_org + """ + + if x_crm_org is not None and not isinstance(x_crm_org, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_crm_org EXPECTED TYPE: str', None, None) + + self.__x_crm_org = x_crm_org + + + def create_business_hours(self, request): + """ + The method to create business hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.BusinessHours.CreateBusinessHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_business_hours(self, request): + """ + The method to update business hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours' + 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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.BusinessHours.UpdateBusinessHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_business_hours(self): + """ + The method to get business hours + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.BusinessHours.GetBusinessHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class CreateBusinessHoursHeader(object): + pass + + +class UpdateBusinessHoursHeader(object): + pass + + +class GetBusinessHoursHeader(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/features.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/features.py new file mode 100644 index 0000000..8a67822 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/features.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Features(object): + def __init__(self): + """Creates an instance of Features""" + + self.__name = None + self.__resources = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/resources.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/resources.py new file mode 100644 index 0000000..7f5586c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/resources.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resources(object): + def __init__(self): + """Creates an instance of Resources""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_wrapper.py new file mode 100644 index 0000000..d3adda7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__business_hours = None + self.__key_modified = dict() + + def get_business_hours(self): + """ + The method to get the business_hours + + Returns: + BusinessHours: An instance of BusinessHours + """ + + return self.__business_hours + + def set_business_hours(self, business_hours): + """ + The method to set the value to business_hours + + Parameters: + business_hours (BusinessHours) : An instance of BusinessHours + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.business_hours.business_hours import BusinessHours + except Exception: + from .business_hours import BusinessHours + + if business_hours is not None and not isinstance(business_hours, BusinessHours): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_hours EXPECTED TYPE: BusinessHours', None, None) + + self.__business_hours = business_hours + self.__key_modified['business_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/business_hours/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/business_hours/success_response.py new file mode 100644 index 0000000..3bcdee5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/business_hours/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.business_hours.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/__init__.py new file mode 100644 index 0000000..3e9e266 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/__init__.py @@ -0,0 +1,10 @@ +from .summary import Summary +from .api_exception import APIException +from .execution_detail import ExecutionDetail +from .unenroll_property import UnenrollProperty +from .module import Module +from .cadences import Cadences +from .user import User +from .execute_every import ExecuteEvery +from .custom_view import CustomView +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/api_exception.py new file mode 100644 index 0000000..bf32b2d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__details = None + self.__code = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/cadences.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/cadences.py new file mode 100644 index 0000000..d445b6c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/cadences.py @@ -0,0 +1,429 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Cadences(object): + def __init__(self): + """Creates an instance of Cadences""" + + self.__summary = None + self.__created_time = None + self.__module = None + self.__active = None + self.__execution_details = None + self.__published = None + self.__type = None + self.__created_by = None + self.__modified_time = None + self.__name = None + self.__modified_by = None + self.__id = None + self.__custom_view = None + self.__status = None + self.__key_modified = dict() + + def get_summary(self): + """ + The method to get the summary + + Returns: + Summary: An instance of Summary + """ + + return self.__summary + + def set_summary(self, summary): + """ + The method to set the value to summary + + Parameters: + summary (Summary) : An instance of Summary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.summary import Summary + except Exception: + from .summary import Summary + + if summary is not None and not isinstance(summary, Summary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: summary EXPECTED TYPE: Summary', None, None) + + self.__summary = summary + self.__key_modified['summary'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_execution_details(self): + """ + The method to get the execution_details + + Returns: + ExecutionDetail: An instance of ExecutionDetail + """ + + return self.__execution_details + + def set_execution_details(self, execution_details): + """ + The method to set the value to execution_details + + Parameters: + execution_details (ExecutionDetail) : An instance of ExecutionDetail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.execution_detail import ExecutionDetail + except Exception: + from .execution_detail import ExecutionDetail + + if execution_details is not None and not isinstance(execution_details, ExecutionDetail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execution_details EXPECTED TYPE: ExecutionDetail', None, None) + + self.__execution_details = execution_details + self.__key_modified['execution_details'] = 1 + + def get_published(self): + """ + The method to get the published + + Returns: + bool: A bool representing the published + """ + + return self.__published + + def set_published(self, published): + """ + The method to set the value to published + + Parameters: + published (bool) : A bool representing the published + """ + + if published is not None and not isinstance(published, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: published EXPECTED TYPE: bool', None, None) + + self.__published = published + self.__key_modified['published'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + string: A string representing the modified_time + """ + + return self.__modified_time + + def set_modified_time(self, modified_time): + """ + The method to set the value to modified_time + + Parameters: + modified_time (string) : A string representing the modified_time + """ + + if modified_time is not None and not isinstance(modified_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: str', None, None) + + self.__modified_time = modified_time + self.__key_modified['modified_time'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_custom_view(self): + """ + The method to get the custom_view + + Returns: + CustomView: An instance of CustomView + """ + + return self.__custom_view + + def set_custom_view(self, custom_view): + """ + The method to set the value to custom_view + + Parameters: + custom_view (CustomView) : An instance of CustomView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.custom_view import CustomView + except Exception: + from .custom_view import CustomView + + if custom_view is not None and not isinstance(custom_view, CustomView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_view EXPECTED TYPE: CustomView', None, None) + + self.__custom_view = custom_view + self.__key_modified['custom_view'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/custom_view.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/custom_view.py new file mode 100644 index 0000000..42b74d8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/custom_view.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CustomView(object): + def __init__(self): + """Creates an instance of CustomView""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/execute_every.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/execute_every.py new file mode 100644 index 0000000..934e499 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/execute_every.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExecuteEvery(object): + def __init__(self): + """Creates an instance of ExecuteEvery""" + + self.__unit = None + self.__period = None + self.__key_modified = dict() + + def get_unit(self): + """ + The method to get the unit + + Returns: + int: An int representing the unit + """ + + return self.__unit + + def set_unit(self, unit): + """ + The method to set the value to unit + + Parameters: + unit (int) : An int representing the unit + """ + + if unit is not None and not isinstance(unit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unit EXPECTED TYPE: int', None, None) + + self.__unit = unit + self.__key_modified['unit'] = 1 + + def get_period(self): + """ + The method to get the period + + Returns: + string: A string representing the period + """ + + return self.__period + + def set_period(self, period): + """ + The method to set the value to period + + Parameters: + period (string) : A string representing the period + """ + + if period is not None and not isinstance(period, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: period EXPECTED TYPE: str', None, None) + + self.__period = period + self.__key_modified['period'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/execution_detail.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/execution_detail.py new file mode 100644 index 0000000..af635d8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/execution_detail.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExecutionDetail(object): + def __init__(self): + """Creates an instance of ExecutionDetail""" + + self.__unenroll_properties = None + self.__end_date = None + self.__automatic_unenroll = None + self.__type = None + self.__execute_every = None + self.__key_modified = dict() + + def get_unenroll_properties(self): + """ + The method to get the unenroll_properties + + Returns: + UnenrollProperty: An instance of UnenrollProperty + """ + + return self.__unenroll_properties + + def set_unenroll_properties(self, unenroll_properties): + """ + The method to set the value to unenroll_properties + + Parameters: + unenroll_properties (UnenrollProperty) : An instance of UnenrollProperty + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.unenroll_property import UnenrollProperty + except Exception: + from .unenroll_property import UnenrollProperty + + if unenroll_properties is not None and not isinstance(unenroll_properties, UnenrollProperty): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unenroll_properties EXPECTED TYPE: UnenrollProperty', None, None) + + self.__unenroll_properties = unenroll_properties + self.__key_modified['unenroll_properties'] = 1 + + def get_end_date(self): + """ + The method to get the end_date + + Returns: + string: A string representing the end_date + """ + + return self.__end_date + + def set_end_date(self, end_date): + """ + The method to set the value to end_date + + Parameters: + end_date (string) : A string representing the end_date + """ + + if end_date is not None and not isinstance(end_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: end_date EXPECTED TYPE: str', None, None) + + self.__end_date = end_date + self.__key_modified['end_date'] = 1 + + def get_automatic_unenroll(self): + """ + The method to get the automatic_unenroll + + Returns: + bool: A bool representing the automatic_unenroll + """ + + return self.__automatic_unenroll + + def set_automatic_unenroll(self, automatic_unenroll): + """ + The method to set the value to automatic_unenroll + + Parameters: + automatic_unenroll (bool) : A bool representing the automatic_unenroll + """ + + if automatic_unenroll is not None and not isinstance(automatic_unenroll, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: automatic_unenroll EXPECTED TYPE: bool', None, None) + + self.__automatic_unenroll = automatic_unenroll + self.__key_modified['automatic_unenroll'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_execute_every(self): + """ + The method to get the execute_every + + Returns: + ExecuteEvery: An instance of ExecuteEvery + """ + + return self.__execute_every + + def set_execute_every(self, execute_every): + """ + The method to set the value to execute_every + + Parameters: + execute_every (ExecuteEvery) : An instance of ExecuteEvery + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences.execute_every import ExecuteEvery + except Exception: + from .execute_every import ExecuteEvery + + if execute_every is not None and not isinstance(execute_every, ExecuteEvery): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execute_every EXPECTED TYPE: ExecuteEvery', None, None) + + self.__execute_every = execute_every + self.__key_modified['execute_every'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/info.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/module.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/summary.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/summary.py new file mode 100644 index 0000000..d5b7b8d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/summary.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Summary(object): + def __init__(self): + """Creates an instance of Summary""" + + self.__task_follow_up_count = None + self.__call_follow_up_count = None + self.__email_follow_up_count = None + self.__key_modified = dict() + + def get_task_follow_up_count(self): + """ + The method to get the task_follow_up_count + + Returns: + int: An int representing the task_follow_up_count + """ + + return self.__task_follow_up_count + + def set_task_follow_up_count(self, task_follow_up_count): + """ + The method to set the value to task_follow_up_count + + Parameters: + task_follow_up_count (int) : An int representing the task_follow_up_count + """ + + if task_follow_up_count is not None and not isinstance(task_follow_up_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: task_follow_up_count EXPECTED TYPE: int', None, None) + + self.__task_follow_up_count = task_follow_up_count + self.__key_modified['task_follow_up_count'] = 1 + + def get_call_follow_up_count(self): + """ + The method to get the call_follow_up_count + + Returns: + int: An int representing the call_follow_up_count + """ + + return self.__call_follow_up_count + + def set_call_follow_up_count(self, call_follow_up_count): + """ + The method to set the value to call_follow_up_count + + Parameters: + call_follow_up_count (int) : An int representing the call_follow_up_count + """ + + if call_follow_up_count is not None and not isinstance(call_follow_up_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call_follow_up_count EXPECTED TYPE: int', None, None) + + self.__call_follow_up_count = call_follow_up_count + self.__key_modified['call_follow_up_count'] = 1 + + def get_email_follow_up_count(self): + """ + The method to get the email_follow_up_count + + Returns: + int: An int representing the email_follow_up_count + """ + + return self.__email_follow_up_count + + def set_email_follow_up_count(self, email_follow_up_count): + """ + The method to set the value to email_follow_up_count + + Parameters: + email_follow_up_count (int) : An int representing the email_follow_up_count + """ + + if email_follow_up_count is not None and not isinstance(email_follow_up_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_follow_up_count EXPECTED TYPE: int', None, None) + + self.__email_follow_up_count = email_follow_up_count + self.__key_modified['email_follow_up_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/unenroll_property.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/unenroll_property.py new file mode 100644 index 0000000..91b96df --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/unenroll_property.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UnenrollProperty(object): + def __init__(self): + """Creates an instance of UnenrollProperty""" + + self.__end_date = None + self.__type = None + self.__key_modified = dict() + + def get_end_date(self): + """ + The method to get the end_date + + Returns: + string: A string representing the end_date + """ + + return self.__end_date + + def set_end_date(self, end_date): + """ + The method to set the value to end_date + + Parameters: + end_date (string) : A string representing the end_date + """ + + if end_date is not None and not isinstance(end_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: end_date EXPECTED TYPE: str', None, None) + + self.__end_date = end_date + self.__key_modified['end_date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences/user.py b/zohocrmsdk/src/com/zoho/crm/api/cadences/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/__init__.py new file mode 100644 index 0000000..34894c3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/__init__.py @@ -0,0 +1,19 @@ +from .template import Template +from .action_wrapper import ActionWrapper +from .cadences_analytics_get import CadencesAnalyticsGet +from .module import Module +from .body_wrapper import BodyWrapper +from .cadence import Cadence +from .analytics import Analytics +from .api_exception import APIException +from .analytics_task import AnalyticsTask +from .action_response import ActionResponse +from .parent_follow_up import ParentFollowUp +from .analytics_call import AnalyticsCall +from .success_response import SuccessResponse +from .action import Action +from .action_handler import ActionHandler +from .details import Details +from .cadences_execution_operations import CadencesExecutionOperations +from .analytics_alert import AnalyticsAlert +from .user import User diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action.py new file mode 100644 index 0000000..ffa6c11 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Action(object): + def __init__(self): + """Creates an instance of Action""" + + self.__details = None + self.__type = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + Details: An instance of Details + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Details) : An instance of Details + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.details import Details + except Exception: + from .details import Details + + if details is not None and not isinstance(details, Details): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Details', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_wrapper.py new file mode 100644 index 0000000..6309c25 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics.py new file mode 100644 index 0000000..ccedfa6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Analytics(object): + def __init__(self): + """Creates an instance of Analytics""" + + self.__analytics = None + self.__parent_follow_up = None + self.__action = None + self.__id = None + self.__key_modified = dict() + + def get_analytics(self): + """ + The method to get the analytics + + Returns: + dict: An instance of dict + """ + + return self.__analytics + + def set_analytics(self, analytics): + """ + The method to set the value to analytics + + Parameters: + analytics (dict) : An instance of dict + """ + + if analytics is not None and not isinstance(analytics, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics EXPECTED TYPE: dict', None, None) + + self.__analytics = analytics + self.__key_modified['analytics'] = 1 + + def get_parent_follow_up(self): + """ + The method to get the parent_follow_up + + Returns: + ParentFollowUp: An instance of ParentFollowUp + """ + + return self.__parent_follow_up + + def set_parent_follow_up(self, parent_follow_up): + """ + The method to set the value to parent_follow_up + + Parameters: + parent_follow_up (ParentFollowUp) : An instance of ParentFollowUp + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.parent_follow_up import ParentFollowUp + except Exception: + from .parent_follow_up import ParentFollowUp + + if parent_follow_up is not None and not isinstance(parent_follow_up, ParentFollowUp): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_follow_up EXPECTED TYPE: ParentFollowUp', None, None) + + self.__parent_follow_up = parent_follow_up + self.__key_modified['parent_follow_up'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + Action: An instance of Action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (Action) : An instance of Action + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action import Action + except Exception: + from .action import Action + + if action is not None and not isinstance(action, Action): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: Action', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_alert.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_alert.py new file mode 100644 index 0000000..0c96e31 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_alert.py @@ -0,0 +1,274 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsAlert(object): + def __init__(self): + """Creates an instance of AnalyticsAlert""" + + self.__email_count = None + self.__cliked_email_count = None + self.__bounced_email_count = None + self.__replied_email_count = None + self.__email_spam_count = None + self.__sent_email_count = None + self.__unsent_email_count = None + self.__opened_email_count = None + self.__unsubscribed_email_count = None + self.__key_modified = dict() + + def get_email_count(self): + """ + The method to get the email_count + + Returns: + int: An int representing the email_count + """ + + return self.__email_count + + def set_email_count(self, email_count): + """ + The method to set the value to email_count + + Parameters: + email_count (int) : An int representing the email_count + """ + + if email_count is not None and not isinstance(email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_count EXPECTED TYPE: int', None, None) + + self.__email_count = email_count + self.__key_modified['email_count'] = 1 + + def get_cliked_email_count(self): + """ + The method to get the cliked_email_count + + Returns: + int: An int representing the cliked_email_count + """ + + return self.__cliked_email_count + + def set_cliked_email_count(self, cliked_email_count): + """ + The method to set the value to cliked_email_count + + Parameters: + cliked_email_count (int) : An int representing the cliked_email_count + """ + + if cliked_email_count is not None and not isinstance(cliked_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cliked_email_count EXPECTED TYPE: int', None, None) + + self.__cliked_email_count = cliked_email_count + self.__key_modified['cliked_email_count'] = 1 + + def get_bounced_email_count(self): + """ + The method to get the bounced_email_count + + Returns: + int: An int representing the bounced_email_count + """ + + return self.__bounced_email_count + + def set_bounced_email_count(self, bounced_email_count): + """ + The method to set the value to bounced_email_count + + Parameters: + bounced_email_count (int) : An int representing the bounced_email_count + """ + + if bounced_email_count is not None and not isinstance(bounced_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced_email_count EXPECTED TYPE: int', None, None) + + self.__bounced_email_count = bounced_email_count + self.__key_modified['bounced_email_count'] = 1 + + def get_replied_email_count(self): + """ + The method to get the replied_email_count + + Returns: + int: An int representing the replied_email_count + """ + + return self.__replied_email_count + + def set_replied_email_count(self, replied_email_count): + """ + The method to set the value to replied_email_count + + Parameters: + replied_email_count (int) : An int representing the replied_email_count + """ + + if replied_email_count is not None and not isinstance(replied_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replied_email_count EXPECTED TYPE: int', None, None) + + self.__replied_email_count = replied_email_count + self.__key_modified['replied_email_count'] = 1 + + def get_email_spam_count(self): + """ + The method to get the email_spam_count + + Returns: + int: An int representing the email_spam_count + """ + + return self.__email_spam_count + + def set_email_spam_count(self, email_spam_count): + """ + The method to set the value to email_spam_count + + Parameters: + email_spam_count (int) : An int representing the email_spam_count + """ + + if email_spam_count is not None and not isinstance(email_spam_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_spam_count EXPECTED TYPE: int', None, None) + + self.__email_spam_count = email_spam_count + self.__key_modified['email_spam_count'] = 1 + + def get_sent_email_count(self): + """ + The method to get the sent_email_count + + Returns: + int: An int representing the sent_email_count + """ + + return self.__sent_email_count + + def set_sent_email_count(self, sent_email_count): + """ + The method to set the value to sent_email_count + + Parameters: + sent_email_count (int) : An int representing the sent_email_count + """ + + if sent_email_count is not None and not isinstance(sent_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent_email_count EXPECTED TYPE: int', None, None) + + self.__sent_email_count = sent_email_count + self.__key_modified['sent_email_count'] = 1 + + def get_unsent_email_count(self): + """ + The method to get the unsent_email_count + + Returns: + int: An int representing the unsent_email_count + """ + + return self.__unsent_email_count + + def set_unsent_email_count(self, unsent_email_count): + """ + The method to set the value to unsent_email_count + + Parameters: + unsent_email_count (int) : An int representing the unsent_email_count + """ + + if unsent_email_count is not None and not isinstance(unsent_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsent_email_count EXPECTED TYPE: int', None, None) + + self.__unsent_email_count = unsent_email_count + self.__key_modified['unsent_email_count'] = 1 + + def get_opened_email_count(self): + """ + The method to get the opened_email_count + + Returns: + int: An int representing the opened_email_count + """ + + return self.__opened_email_count + + def set_opened_email_count(self, opened_email_count): + """ + The method to set the value to opened_email_count + + Parameters: + opened_email_count (int) : An int representing the opened_email_count + """ + + if opened_email_count is not None and not isinstance(opened_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: opened_email_count EXPECTED TYPE: int', None, None) + + self.__opened_email_count = opened_email_count + self.__key_modified['opened_email_count'] = 1 + + def get_unsubscribed_email_count(self): + """ + The method to get the unsubscribed_email_count + + Returns: + int: An int representing the unsubscribed_email_count + """ + + return self.__unsubscribed_email_count + + def set_unsubscribed_email_count(self, unsubscribed_email_count): + """ + The method to set the value to unsubscribed_email_count + + Parameters: + unsubscribed_email_count (int) : An int representing the unsubscribed_email_count + """ + + if unsubscribed_email_count is not None and not isinstance(unsubscribed_email_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribed_email_count EXPECTED TYPE: int', None, None) + + self.__unsubscribed_email_count = unsubscribed_email_count + self.__key_modified['unsubscribed_email_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_call.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_call.py new file mode 100644 index 0000000..a313ddc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_call.py @@ -0,0 +1,249 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsCall(object): + def __init__(self): + """Creates an instance of AnalyticsCall""" + + self.__created_calls_count = None + self.__cancelled_calls_count = None + self.__failed_calls_count = None + self.__completed_calls_count = None + self.__scheduled_calls_count = None + self.__calls_count = None + self.__overdue_calls_count = None + self.__missed_calls_count = None + self.__key_modified = dict() + + def get_created_calls_count(self): + """ + The method to get the created_calls_count + + Returns: + int: An int representing the created_calls_count + """ + + return self.__created_calls_count + + def set_created_calls_count(self, created_calls_count): + """ + The method to set the value to created_calls_count + + Parameters: + created_calls_count (int) : An int representing the created_calls_count + """ + + if created_calls_count is not None and not isinstance(created_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_calls_count EXPECTED TYPE: int', None, None) + + self.__created_calls_count = created_calls_count + self.__key_modified['created_calls_count'] = 1 + + def get_cancelled_calls_count(self): + """ + The method to get the cancelled_calls_count + + Returns: + int: An int representing the cancelled_calls_count + """ + + return self.__cancelled_calls_count + + def set_cancelled_calls_count(self, cancelled_calls_count): + """ + The method to set the value to cancelled_calls_count + + Parameters: + cancelled_calls_count (int) : An int representing the cancelled_calls_count + """ + + if cancelled_calls_count is not None and not isinstance(cancelled_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cancelled_calls_count EXPECTED TYPE: int', None, None) + + self.__cancelled_calls_count = cancelled_calls_count + self.__key_modified['cancelled_calls_count'] = 1 + + def get_failed_calls_count(self): + """ + The method to get the failed_calls_count + + Returns: + int: An int representing the failed_calls_count + """ + + return self.__failed_calls_count + + def set_failed_calls_count(self, failed_calls_count): + """ + The method to set the value to failed_calls_count + + Parameters: + failed_calls_count (int) : An int representing the failed_calls_count + """ + + if failed_calls_count is not None and not isinstance(failed_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_calls_count EXPECTED TYPE: int', None, None) + + self.__failed_calls_count = failed_calls_count + self.__key_modified['failed_calls_count'] = 1 + + def get_completed_calls_count(self): + """ + The method to get the completed_calls_count + + Returns: + int: An int representing the completed_calls_count + """ + + return self.__completed_calls_count + + def set_completed_calls_count(self, completed_calls_count): + """ + The method to set the value to completed_calls_count + + Parameters: + completed_calls_count (int) : An int representing the completed_calls_count + """ + + if completed_calls_count is not None and not isinstance(completed_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: completed_calls_count EXPECTED TYPE: int', None, None) + + self.__completed_calls_count = completed_calls_count + self.__key_modified['completed_calls_count'] = 1 + + def get_scheduled_calls_count(self): + """ + The method to get the scheduled_calls_count + + Returns: + int: An int representing the scheduled_calls_count + """ + + return self.__scheduled_calls_count + + def set_scheduled_calls_count(self, scheduled_calls_count): + """ + The method to set the value to scheduled_calls_count + + Parameters: + scheduled_calls_count (int) : An int representing the scheduled_calls_count + """ + + if scheduled_calls_count is not None and not isinstance(scheduled_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduled_calls_count EXPECTED TYPE: int', None, None) + + self.__scheduled_calls_count = scheduled_calls_count + self.__key_modified['scheduled_calls_count'] = 1 + + def get_calls_count(self): + """ + The method to get the calls_count + + Returns: + int: An int representing the calls_count + """ + + return self.__calls_count + + def set_calls_count(self, calls_count): + """ + The method to set the value to calls_count + + Parameters: + calls_count (int) : An int representing the calls_count + """ + + if calls_count is not None and not isinstance(calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: calls_count EXPECTED TYPE: int', None, None) + + self.__calls_count = calls_count + self.__key_modified['calls_count'] = 1 + + def get_overdue_calls_count(self): + """ + The method to get the overdue_calls_count + + Returns: + int: An int representing the overdue_calls_count + """ + + return self.__overdue_calls_count + + def set_overdue_calls_count(self, overdue_calls_count): + """ + The method to set the value to overdue_calls_count + + Parameters: + overdue_calls_count (int) : An int representing the overdue_calls_count + """ + + if overdue_calls_count is not None and not isinstance(overdue_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: overdue_calls_count EXPECTED TYPE: int', None, None) + + self.__overdue_calls_count = overdue_calls_count + self.__key_modified['overdue_calls_count'] = 1 + + def get_missed_calls_count(self): + """ + The method to get the missed_calls_count + + Returns: + int: An int representing the missed_calls_count + """ + + return self.__missed_calls_count + + def set_missed_calls_count(self, missed_calls_count): + """ + The method to set the value to missed_calls_count + + Parameters: + missed_calls_count (int) : An int representing the missed_calls_count + """ + + if missed_calls_count is not None and not isinstance(missed_calls_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: missed_calls_count EXPECTED TYPE: int', None, None) + + self.__missed_calls_count = missed_calls_count + self.__key_modified['missed_calls_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_task.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_task.py new file mode 100644 index 0000000..5580b94 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/analytics_task.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsTask(object): + def __init__(self): + """Creates an instance of AnalyticsTask""" + + self.__open_tasks_count = None + self.__failed_tasks_count = None + self.__subject = None + self.__completed_tasks_count = None + self.__created_tasks_count = None + self.__tasks_count = None + self.__key_modified = dict() + + def get_open_tasks_count(self): + """ + The method to get the open_tasks_count + + Returns: + int: An int representing the open_tasks_count + """ + + return self.__open_tasks_count + + def set_open_tasks_count(self, open_tasks_count): + """ + The method to set the value to open_tasks_count + + Parameters: + open_tasks_count (int) : An int representing the open_tasks_count + """ + + if open_tasks_count is not None and not isinstance(open_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: open_tasks_count EXPECTED TYPE: int', None, None) + + self.__open_tasks_count = open_tasks_count + self.__key_modified['open_tasks_count'] = 1 + + def get_failed_tasks_count(self): + """ + The method to get the failed_tasks_count + + Returns: + int: An int representing the failed_tasks_count + """ + + return self.__failed_tasks_count + + def set_failed_tasks_count(self, failed_tasks_count): + """ + The method to set the value to failed_tasks_count + + Parameters: + failed_tasks_count (int) : An int representing the failed_tasks_count + """ + + if failed_tasks_count is not None and not isinstance(failed_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_tasks_count EXPECTED TYPE: int', None, None) + + self.__failed_tasks_count = failed_tasks_count + self.__key_modified['failed_tasks_count'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_completed_tasks_count(self): + """ + The method to get the completed_tasks_count + + Returns: + int: An int representing the completed_tasks_count + """ + + return self.__completed_tasks_count + + def set_completed_tasks_count(self, completed_tasks_count): + """ + The method to set the value to completed_tasks_count + + Parameters: + completed_tasks_count (int) : An int representing the completed_tasks_count + """ + + if completed_tasks_count is not None and not isinstance(completed_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: completed_tasks_count EXPECTED TYPE: int', None, None) + + self.__completed_tasks_count = completed_tasks_count + self.__key_modified['completed_tasks_count'] = 1 + + def get_created_tasks_count(self): + """ + The method to get the created_tasks_count + + Returns: + int: An int representing the created_tasks_count + """ + + return self.__created_tasks_count + + def set_created_tasks_count(self, created_tasks_count): + """ + The method to set the value to created_tasks_count + + Parameters: + created_tasks_count (int) : An int representing the created_tasks_count + """ + + if created_tasks_count is not None and not isinstance(created_tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_tasks_count EXPECTED TYPE: int', None, None) + + self.__created_tasks_count = created_tasks_count + self.__key_modified['created_tasks_count'] = 1 + + def get_tasks_count(self): + """ + The method to get the tasks_count + + Returns: + int: An int representing the tasks_count + """ + + return self.__tasks_count + + def set_tasks_count(self, tasks_count): + """ + The method to set the value to tasks_count + + Parameters: + tasks_count (int) : An int representing the tasks_count + """ + + if tasks_count is not None and not isinstance(tasks_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tasks_count EXPECTED TYPE: int', None, None) + + self.__tasks_count = tasks_count + self.__key_modified['tasks_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/api_exception.py new file mode 100644 index 0000000..5b00143 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__details = None + self.__code = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/body_wrapper.py new file mode 100644 index 0000000..2c91d7c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/body_wrapper.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__cadences_ids = None + self.__ids = None + self.__key_modified = dict() + + def get_cadences_ids(self): + """ + The method to get the cadences_ids + + Returns: + list: An instance of list + """ + + return self.__cadences_ids + + def set_cadences_ids(self, cadences_ids): + """ + The method to set the value to cadences_ids + + Parameters: + cadences_ids (list) : An instance of list + """ + + if cadences_ids is not None and not isinstance(cadences_ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cadences_ids EXPECTED TYPE: list', None, None) + + self.__cadences_ids = cadences_ids + self.__key_modified['cadences_ids'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadence.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadence.py new file mode 100644 index 0000000..98734b5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadence.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Cadence(object): + def __init__(self): + """Creates an instance of Cadence""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_analytics_get.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_analytics_get.py new file mode 100644 index 0000000..7e59bba --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_analytics_get.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CadencesAnalyticsGet(object): + def __init__(self): + """Creates an instance of CadencesAnalyticsGet""" + + self.__module = None + self.__name = None + self.__follow_ups = None + self.__id = None + self.__created_by = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_follow_ups(self): + """ + The method to get the follow_ups + + Returns: + list: An instance of list + """ + + return self.__follow_ups + + def set_follow_ups(self, follow_ups): + """ + The method to set the value to follow_ups + + Parameters: + follow_ups (list) : An instance of list + """ + + if follow_ups is not None and not isinstance(follow_ups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: follow_ups EXPECTED TYPE: list', None, None) + + self.__follow_ups = follow_ups + self.__key_modified['follow_ups'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_execution_operations.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_execution_operations.py new file mode 100644 index 0000000..a4d93e1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/cadences_execution_operations.py @@ -0,0 +1,96 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CadencesExecutionOperations(object): + def __init__(self): + """Creates an instance of CadencesExecutionOperations""" + pass + + def enrol_cadences(self, module, request): + """ + The method to enrol cadences + + Parameters: + module (string) : A string representing the module + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/enrol_in_cadences' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def unenrol_cadences(self, module, request): + """ + The method to unenrol cadences + + Parameters: + module (string) : A string representing the module + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/unenrol_from_cadences' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/details.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/details.py new file mode 100644 index 0000000..1098293 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/details.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Details(object): + def __init__(self): + """Creates an instance of Details""" + + self.__name = None + self.__template = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_template(self): + """ + The method to get the template + + Returns: + Template: An instance of Template + """ + + return self.__template + + def set_template(self, template): + """ + The method to set the value to template + + Parameters: + template (Template) : An instance of Template + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.template import Template + except Exception: + from .template import Template + + if template is not None and not isinstance(template, Template): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: Template', None, None) + + self.__template = template + self.__key_modified['template'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/module.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/parent_follow_up.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/parent_follow_up.py new file mode 100644 index 0000000..bf47cc4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/parent_follow_up.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ParentFollowUp(object): + def __init__(self): + """Creates an instance of ParentFollowUp""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/success_response.py new file mode 100644 index 0000000..e961867 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cadences_execution.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/template.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/template.py new file mode 100644 index 0000000..5310677 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Template(object): + def __init__(self): + """Creates an instance of Template""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/user.py b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cadences_execution/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/__init__.py new file mode 100644 index 0000000..5fdcd31 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/__init__.py @@ -0,0 +1,8 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .cancel_meetings_operations import CancelMeetingsOperations +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .notify import Notify diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_wrapper.py new file mode 100644 index 0000000..4414c02 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/api_exception.py new file mode 100644 index 0000000..938098f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/cancel_meetings_operations.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/cancel_meetings_operations.py new file mode 100644 index 0000000..3f43c62 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/cancel_meetings_operations.py @@ -0,0 +1,60 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CancelMeetingsOperations(object): + def __init__(self, event): + """ + Creates an instance of CancelMeetingsOperations with the given parameters + + Parameters: + event (int) : An int representing the event + """ + + if not isinstance(event, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: event EXPECTED TYPE: int', None, None) + + self.__event = event + + + def cancel_meetings(self, request): + """ + The method to cancel meetings + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Events/' + api_path = api_path + str(self.__event) + api_path = api_path + '/actions/cancel' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/notify.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/notify.py new file mode 100644 index 0000000..b8d53be --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/notify.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Notify(object): + def __init__(self): + """Creates an instance of Notify""" + + self.__send_cancelling_mail = None + self.__key_modified = dict() + + def get_send_cancelling_mail(self): + """ + The method to get the send_cancelling_mail + + Returns: + bool: A bool representing the send_cancelling_mail + """ + + return self.__send_cancelling_mail + + def set_send_cancelling_mail(self, send_cancelling_mail): + """ + The method to set the value to send_cancelling_mail + + Parameters: + send_cancelling_mail (bool) : A bool representing the send_cancelling_mail + """ + + if send_cancelling_mail is not None and not isinstance(send_cancelling_mail, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: send_cancelling_mail EXPECTED TYPE: bool', None, None) + + self.__send_cancelling_mail = send_cancelling_mail + self.__key_modified['send_cancelling_mail'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/success_response.py new file mode 100644 index 0000000..9401e98 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/cancel_meetings/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/__init__.py new file mode 100644 index 0000000..55b6d7c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/__init__.py @@ -0,0 +1,11 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .mass_wrapper import MassWrapper +from .related_modules import RelatedModules +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .change_owner_operations import ChangeOwnerOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_wrapper.py new file mode 100644 index 0000000..f140f8e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/api_exception.py new file mode 100644 index 0000000..292749a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/body_wrapper.py new file mode 100644 index 0000000..a59913a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/body_wrapper.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__owner = None + self.__notify = None + self.__related_modules = None + self.__key_modified = dict() + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/change_owner_operations.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/change_owner_operations.py new file mode 100644 index 0000000..e188e76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/change_owner_operations.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class ChangeOwnerOperations(object): + def __init__(self, module): + """ + Creates an instance of ChangeOwnerOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def single_update(self, id, request): + """ + The method to single update + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def mass_update(self, request): + """ + The method to mass update + + Parameters: + request (MassWrapper) : An instance of MassWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.mass_wrapper import MassWrapper + except Exception: + from .mass_wrapper import MassWrapper + + if request is not None and not isinstance(request, MassWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MassWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/error_details.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/mass_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/mass_wrapper.py new file mode 100644 index 0000000..306153b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/mass_wrapper.py @@ -0,0 +1,157 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.body_wrapper import BodyWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .body_wrapper import BodyWrapper + + +class MassWrapper(BodyWrapper): + def __init__(self): + """Creates an instance of MassWrapper""" + super().__init__() + + self.__ids = None + self.__owner = None + self.__notify = None + self.__related_modules = None + self.__key_modified = dict() + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.change_owner.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/owner.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/owner.py new file mode 100644 index 0000000..ce08ac7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/owner.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/related_modules.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/related_modules.py new file mode 100644 index 0000000..bfec35e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/related_modules.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedModules(object): + def __init__(self): + """Creates an instance of RelatedModules""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/change_owner/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/change_owner/success_response.py new file mode 100644 index 0000000..f51a807 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/change_owner/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.change_owner.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/__init__.py new file mode 100644 index 0000000..21063f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .contact_roles_operations import ContactRolesOperations, DeleteContactRolesParam +from .contact_role import ContactRole diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_wrapper.py new file mode 100644 index 0000000..190af05 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__contact_roles = None + self.__key_modified = dict() + + def get_contact_roles(self): + """ + The method to get the contact_roles + + Returns: + list: An instance of list + """ + + return self.__contact_roles + + def set_contact_roles(self, contact_roles): + """ + The method to set the value to contact_roles + + Parameters: + contact_roles (list) : An instance of list + """ + + if contact_roles is not None and not isinstance(contact_roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_roles EXPECTED TYPE: list', None, None) + + self.__contact_roles = contact_roles + self.__key_modified['contact_roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/api_exception.py new file mode 100644 index 0000000..64e5910 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/body_wrapper.py new file mode 100644 index 0000000..528e254 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__contact_roles = None + self.__key_modified = dict() + + def get_contact_roles(self): + """ + The method to get the contact_roles + + Returns: + list: An instance of list + """ + + return self.__contact_roles + + def set_contact_roles(self, contact_roles): + """ + The method to set the value to contact_roles + + Parameters: + contact_roles (list) : An instance of list + """ + + if contact_roles is not None and not isinstance(contact_roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_roles EXPECTED TYPE: list', None, None) + + self.__contact_roles = contact_roles + self.__key_modified['contact_roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_role.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_role.py new file mode 100644 index 0000000..35994d1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_role.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ContactRole(object): + def __init__(self): + """Creates an instance of ContactRole""" + + self.__id = None + self.__name = None + self.__sequence_number = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_roles_operations.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_roles_operations.py new file mode 100644 index 0000000..b05120f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/contact_roles_operations.py @@ -0,0 +1,251 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class ContactRolesOperations(object): + def __init__(self): + """Creates an instance of ContactRolesOperations""" + pass + + def get_roles(self): + """ + The method to get roles + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Contacts/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_roles(self, request): + """ + The method to create roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Contacts/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_roles(self, request): + """ + The method to update roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Contacts/roles' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_contact_roles(self, param_instance=None): + """ + The method to delete contact roles + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Contacts/roles' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_role(self, id): + """ + The method to get role + + 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/v7/Contacts/roles/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_contact_role(self, id, request): + """ + The method to update contact role + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/Contacts/roles/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_contact_role(self, id): + """ + The method to delete contact role + + 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/v7/Contacts/roles/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class DeleteContactRolesParam(object): + ids = Param('ids', 'com.zoho.crm.api.ContactRoles.DeleteContactRolesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_wrapper.py new file mode 100644 index 0000000..4938416 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__contact_roles = None + self.__key_modified = dict() + + def get_contact_roles(self): + """ + The method to get the contact_roles + + Returns: + list: An instance of list + """ + + return self.__contact_roles + + def set_contact_roles(self, contact_roles): + """ + The method to set the value to contact_roles + + Parameters: + contact_roles (list) : An instance of list + """ + + if contact_roles is not None and not isinstance(contact_roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_roles EXPECTED TYPE: list', None, None) + + self.__contact_roles = contact_roles + self.__key_modified['contact_roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/contact_roles/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/success_response.py new file mode 100644 index 0000000..ba84af0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/contact_roles/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.contact_roles.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/__init__.py new file mode 100644 index 0000000..f4f47db --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/__init__.py @@ -0,0 +1,8 @@ +from .preference_field_match import PreferenceFieldMatch +from .api_exception import APIException +from .response_handler import ResponseHandler +from .field import Field +from .conversion_option_operations import ConversionOptionOperations +from .response_wrapper import ResponseWrapper +from .preference_field_matched_value import PreferenceFieldMatchedValue +from .conversion_options import ConversionOptions diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/api_exception.py new file mode 100644 index 0000000..9866456 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_option_operations.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_option_operations.py new file mode 100644 index 0000000..6a6b2a8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_option_operations.py @@ -0,0 +1,49 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + + +class ConversionOptionOperations(object): + def __init__(self, lead_id): + """ + Creates an instance of ConversionOptionOperations with the given parameters + + Parameters: + lead_id (int) : An int representing the lead_id + """ + + if not isinstance(lead_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lead_id EXPECTED TYPE: int', None, None) + + self.__lead_id = lead_id + + + def lead_conversion_options(self): + """ + The method to lead conversion options + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Leads/' + api_path = api_path + str(self.__lead_id) + api_path = api_path + '/__conversion_options' + 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.set_module_api_name("Leads") + Utility.get_fields("Leads,Contacts,Deals,Accounts", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_options.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_options.py new file mode 100644 index 0000000..505ff9d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/conversion_options.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConversionOptions(object): + def __init__(self): + """Creates an instance of ConversionOptions""" + + self.__module_preference = None + self.__contacts = None + self.__deals = None + self.__accounts = None + self.__preference_field_matched_value = None + self.__modules_with_multiple_layouts = None + self.__key_modified = dict() + + def get_module_preference(self): + """ + The method to get the module_preference + + Returns: + Modules: An instance of Modules + """ + + return self.__module_preference + + def set_module_preference(self, module_preference): + """ + The method to set the value to module_preference + + Parameters: + module_preference (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import Modules + except Exception: + from ..modules import Modules + + if module_preference is not None and not isinstance(module_preference, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_preference EXPECTED TYPE: Modules', None, None) + + self.__module_preference = module_preference + self.__key_modified['module_preference'] = 1 + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + list: An instance of list + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (list) : An instance of list + """ + + if contacts is not None and not isinstance(contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: list', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + list: An instance of list + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (list) : An instance of list + """ + + if deals is not None and not isinstance(deals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: list', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + list: An instance of list + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (list) : An instance of list + """ + + if accounts is not None and not isinstance(accounts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: list', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_preference_field_matched_value(self): + """ + The method to get the preference_field_matched_value + + Returns: + PreferenceFieldMatchedValue: An instance of PreferenceFieldMatchedValue + """ + + return self.__preference_field_matched_value + + def set_preference_field_matched_value(self, preference_field_matched_value): + """ + The method to set the value to preference_field_matched_value + + Parameters: + preference_field_matched_value (PreferenceFieldMatchedValue) : An instance of PreferenceFieldMatchedValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.preference_field_matched_value import PreferenceFieldMatchedValue + except Exception: + from .preference_field_matched_value import PreferenceFieldMatchedValue + + if preference_field_matched_value is not None and not isinstance(preference_field_matched_value, PreferenceFieldMatchedValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preference_field_matched_value EXPECTED TYPE: PreferenceFieldMatchedValue', None, None) + + self.__preference_field_matched_value = preference_field_matched_value + self.__key_modified['preference_field_matched_value'] = 1 + + def get_modules_with_multiple_layouts(self): + """ + The method to get the modules_with_multiple_layouts + + Returns: + list: An instance of list + """ + + return self.__modules_with_multiple_layouts + + def set_modules_with_multiple_layouts(self, modules_with_multiple_layouts): + """ + The method to set the value to modules_with_multiple_layouts + + Parameters: + modules_with_multiple_layouts (list) : An instance of list + """ + + if modules_with_multiple_layouts is not None and not isinstance(modules_with_multiple_layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules_with_multiple_layouts EXPECTED TYPE: list', None, None) + + self.__modules_with_multiple_layouts = modules_with_multiple_layouts + self.__key_modified['modules_with_multiple_layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/field.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_match.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_match.py new file mode 100644 index 0000000..10638e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_match.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PreferenceFieldMatch(object): + def __init__(self): + """Creates an instance of PreferenceFieldMatch""" + + self.__field = None + self.__matched_lead_value = None + self.__key_modified = dict() + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_matched_lead_value(self): + """ + The method to get the matched_lead_value + + Returns: + string: A string representing the matched_lead_value + """ + + return self.__matched_lead_value + + def set_matched_lead_value(self, matched_lead_value): + """ + The method to set the value to matched_lead_value + + Parameters: + matched_lead_value (string) : A string representing the matched_lead_value + """ + + if matched_lead_value is not None and not isinstance(matched_lead_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: matched_lead_value EXPECTED TYPE: str', None, None) + + self.__matched_lead_value = matched_lead_value + self.__key_modified['matched_lead_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_matched_value.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_matched_value.py new file mode 100644 index 0000000..593eed9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/preference_field_matched_value.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PreferenceFieldMatchedValue(object): + def __init__(self): + """Creates an instance of PreferenceFieldMatchedValue""" + + self.__contacts = None + self.__accounts = None + self.__deals = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + list: An instance of list + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (list) : An instance of list + """ + + if contacts is not None and not isinstance(contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: list', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + list: An instance of list + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (list) : An instance of list + """ + + if accounts is not None and not isinstance(accounts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: list', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + list: An instance of list + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (list) : An instance of list + """ + + if deals is not None and not isinstance(deals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: list', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_wrapper.py new file mode 100644 index 0000000..ba127ce --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/conversion_option/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__conversionoptions = None + self.__key_modified = dict() + + def get_conversionoptions(self): + """ + The method to get the conversionoptions + + Returns: + ConversionOptions: An instance of ConversionOptions + """ + + return self.__conversionoptions + + def set_conversionoptions(self, conversionoptions): + """ + The method to set the value to conversionoptions + + Parameters: + conversionoptions (ConversionOptions) : An instance of ConversionOptions + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.conversion_option.conversion_options import ConversionOptions + except Exception: + from .conversion_options import ConversionOptions + + if conversionoptions is not None and not isinstance(conversionoptions, ConversionOptions): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: conversionoptions EXPECTED TYPE: ConversionOptions', None, None) + + self.__conversionoptions = conversionoptions + self.__key_modified['__conversion_options'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/__init__.py new file mode 100644 index 0000000..e2f0f29 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .carry_over_tags import CarryOverTags +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .convert_lead_operations import ConvertLeadOperations +from .lead_converter import LeadConverter +from .move_attachments_to import MoveAttachmentsTo diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_wrapper.py new file mode 100644 index 0000000..8c0be4f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/api_exception.py new file mode 100644 index 0000000..1406dcd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/carry_over_tags.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/carry_over_tags.py new file mode 100644 index 0000000..3835cdb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/carry_over_tags.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CarryOverTags(object): + def __init__(self): + """Creates an instance of CarryOverTags""" + + self.__contacts = None + self.__accounts = None + self.__deals = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + list: An instance of list + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (list) : An instance of list + """ + + if contacts is not None and not isinstance(contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: list', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + list: An instance of list + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (list) : An instance of list + """ + + if accounts is not None and not isinstance(accounts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: list', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + list: An instance of list + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (list) : An instance of list + """ + + if deals is not None and not isinstance(deals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: list', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/convert_lead_operations.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/convert_lead_operations.py new file mode 100644 index 0000000..b85883d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/convert_lead_operations.py @@ -0,0 +1,63 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + + +class ConvertLeadOperations(object): + def __init__(self, lead_id): + """ + Creates an instance of ConvertLeadOperations with the given parameters + + Parameters: + lead_id (int) : An int representing the lead_id + """ + + if not isinstance(lead_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lead_id EXPECTED TYPE: int', None, None) + + self.__lead_id = lead_id + + + def convert_lead(self, request): + """ + The method to convert lead + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Leads/' + api_path = api_path + str(self.__lead_id) + api_path = api_path + '/actions/convert' + 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.set_module_api_name("Deals") + Utility.get_fields("Deals", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/lead_converter.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/lead_converter.py new file mode 100644 index 0000000..d51199f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/lead_converter.py @@ -0,0 +1,329 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class LeadConverter(object): + def __init__(self): + """Creates an instance of LeadConverter""" + + self.__overwrite = None + self.__notify_lead_owner = None + self.__notify_new_entity_owner = None + self.__move_attachments_to = None + self.__accounts = None + self.__contacts = None + self.__assign_to = None + self.__deals = None + self.__add_to_existing_record = None + self.__carry_over_tags = None + self.__key_modified = dict() + + def get_overwrite(self): + """ + The method to get the overwrite + + Returns: + bool: A bool representing the overwrite + """ + + return self.__overwrite + + def set_overwrite(self, overwrite): + """ + The method to set the value to overwrite + + Parameters: + overwrite (bool) : A bool representing the overwrite + """ + + if overwrite is not None and not isinstance(overwrite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: overwrite EXPECTED TYPE: bool', None, None) + + self.__overwrite = overwrite + self.__key_modified['overwrite'] = 1 + + def get_notify_lead_owner(self): + """ + The method to get the notify_lead_owner + + Returns: + bool: A bool representing the notify_lead_owner + """ + + return self.__notify_lead_owner + + def set_notify_lead_owner(self, notify_lead_owner): + """ + The method to set the value to notify_lead_owner + + Parameters: + notify_lead_owner (bool) : A bool representing the notify_lead_owner + """ + + if notify_lead_owner is not None and not isinstance(notify_lead_owner, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_lead_owner EXPECTED TYPE: bool', None, None) + + self.__notify_lead_owner = notify_lead_owner + self.__key_modified['notify_lead_owner'] = 1 + + def get_notify_new_entity_owner(self): + """ + The method to get the notify_new_entity_owner + + Returns: + bool: A bool representing the notify_new_entity_owner + """ + + return self.__notify_new_entity_owner + + def set_notify_new_entity_owner(self, notify_new_entity_owner): + """ + The method to set the value to notify_new_entity_owner + + Parameters: + notify_new_entity_owner (bool) : A bool representing the notify_new_entity_owner + """ + + if notify_new_entity_owner is not None and not isinstance(notify_new_entity_owner, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_new_entity_owner EXPECTED TYPE: bool', None, None) + + self.__notify_new_entity_owner = notify_new_entity_owner + self.__key_modified['notify_new_entity_owner'] = 1 + + def get_move_attachments_to(self): + """ + The method to get the move_attachments_to + + Returns: + MoveAttachmentsTo: An instance of MoveAttachmentsTo + """ + + return self.__move_attachments_to + + def set_move_attachments_to(self, move_attachments_to): + """ + The method to set the value to move_attachments_to + + Parameters: + move_attachments_to (MoveAttachmentsTo) : An instance of MoveAttachmentsTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.move_attachments_to import MoveAttachmentsTo + except Exception: + from .move_attachments_to import MoveAttachmentsTo + + if move_attachments_to is not None and not isinstance(move_attachments_to, MoveAttachmentsTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_attachments_to EXPECTED TYPE: MoveAttachmentsTo', None, None) + + self.__move_attachments_to = move_attachments_to + self.__key_modified['move_attachments_to'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + Record: An instance of Record + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if accounts is not None and not isinstance(accounts, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: Record', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + Record: An instance of Record + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if contacts is not None and not isinstance(contacts, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: Record', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_assign_to(self): + """ + The method to get the assign_to + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__assign_to + + def set_assign_to(self, assign_to): + """ + The method to set the value to assign_to + + Parameters: + assign_to (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if assign_to is not None and not isinstance(assign_to, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assign_to EXPECTED TYPE: MinifiedUser', None, None) + + self.__assign_to = assign_to + self.__key_modified['assign_to'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + Record: An instance of Record + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if deals is not None and not isinstance(deals, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: Record', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_add_to_existing_record(self): + """ + The method to get the add_to_existing_record + + Returns: + Choice: An instance of Choice + """ + + return self.__add_to_existing_record + + def set_add_to_existing_record(self, add_to_existing_record): + """ + The method to set the value to add_to_existing_record + + Parameters: + add_to_existing_record (Choice) : An instance of Choice + """ + + if add_to_existing_record is not None and not isinstance(add_to_existing_record, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: add_to_existing_record EXPECTED TYPE: Choice', None, None) + + self.__add_to_existing_record = add_to_existing_record + self.__key_modified['add_to_existing_record'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + CarryOverTags: An instance of CarryOverTags + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (CarryOverTags) : An instance of CarryOverTags + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.carry_over_tags import CarryOverTags + except Exception: + from .carry_over_tags import CarryOverTags + + if carry_over_tags is not None and not isinstance(carry_over_tags, CarryOverTags): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: CarryOverTags', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/move_attachments_to.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/move_attachments_to.py new file mode 100644 index 0000000..8bd9065 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/move_attachments_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MoveAttachmentsTo(object): + def __init__(self): + """Creates an instance of MoveAttachmentsTo""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/convert_lead/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/success_response.py new file mode 100644 index 0000000..40b6b37 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/convert_lead/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.convert_lead.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/coql/__init__.py new file mode 100644 index 0000000..3b3a9e7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/__init__.py @@ -0,0 +1,8 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .details_wrapper import DetailsWrapper +from .clause_details import ClauseDetails +from .parse_error_details import ParseErrorDetails +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .coql_operations import CoqlOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/coql/api_exception.py new file mode 100644 index 0000000..6fc6964 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/coql/body_wrapper.py new file mode 100644 index 0000000..5fc1dcc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__select_query = None + self.__key_modified = dict() + + def get_select_query(self): + """ + The method to get the select_query + + Returns: + string: A string representing the select_query + """ + + return self.__select_query + + def set_select_query(self, select_query): + """ + The method to set the value to select_query + + Parameters: + select_query (string) : A string representing the select_query + """ + + if select_query is not None and not isinstance(select_query, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: select_query EXPECTED TYPE: str', None, None) + + self.__select_query = select_query + self.__key_modified['select_query'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/clause_details.py b/zohocrmsdk/src/com/zoho/crm/api/coql/clause_details.py new file mode 100644 index 0000000..b465f0d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/clause_details.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.details_wrapper import DetailsWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .details_wrapper import DetailsWrapper + + +class ClauseDetails(DetailsWrapper): + def __init__(self): + """Creates an instance of ClauseDetails""" + super().__init__() + + self.__clause = None + self.__key_modified = dict() + + def get_clause(self): + """ + The method to get the clause + + Returns: + string: A string representing the clause + """ + + return self.__clause + + def set_clause(self, clause): + """ + The method to set the value to clause + + Parameters: + clause (string) : A string representing the clause + """ + + if clause is not None and not isinstance(clause, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: clause EXPECTED TYPE: str', None, None) + + self.__clause = clause + self.__key_modified['clause'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/coql_operations.py b/zohocrmsdk/src/com/zoho/crm/api/coql/coql_operations.py new file mode 100644 index 0000000..0f916bc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/coql_operations.py @@ -0,0 +1,48 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CoqlOperations(object): + def __init__(self): + """Creates an instance of CoqlOperations""" + pass + + def get_records(self, request): + """ + The method to get records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.coql.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/coql' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.coql.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/details_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/coql/details_wrapper.py new file mode 100644 index 0000000..80f6b69 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/details_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DetailsWrapper(ABC): + def __init__(self): + """Creates an instance of DetailsWrapper""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/parse_error_details.py b/zohocrmsdk/src/com/zoho/crm/api/coql/parse_error_details.py new file mode 100644 index 0000000..115a08a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/parse_error_details.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.details_wrapper import DetailsWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .details_wrapper import DetailsWrapper + + +class ParseErrorDetails(DetailsWrapper): + def __init__(self): + """Creates an instance of ParseErrorDetails""" + super().__init__() + + self.__line = None + self.__column = None + self.__near = None + self.__key_modified = dict() + + def get_line(self): + """ + The method to get the line + + Returns: + int: An int representing the line + """ + + return self.__line + + def set_line(self, line): + """ + The method to set the value to line + + Parameters: + line (int) : An int representing the line + """ + + if line is not None and not isinstance(line, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: line EXPECTED TYPE: int', None, None) + + self.__line = line + self.__key_modified['line'] = 1 + + def get_column(self): + """ + The method to get the column + + Returns: + int: An int representing the column + """ + + return self.__column + + def set_column(self, column): + """ + The method to set the value to column + + Parameters: + column (int) : An int representing the column + """ + + if column is not None and not isinstance(column, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: int', None, None) + + self.__column = column + self.__key_modified['column'] = 1 + + def get_near(self): + """ + The method to get the near + + Returns: + string: A string representing the near + """ + + return self.__near + + def set_near(self, near): + """ + The method to set the value to near + + Parameters: + near (string) : A string representing the near + """ + + if near is not None and not isinstance(near, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: near EXPECTED TYPE: str', None, None) + + self.__near = near + self.__key_modified['near'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/coql/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/coql/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/coql/response_wrapper.py new file mode 100644 index 0000000..39fc48c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/coql/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.coql.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Info + except Exception: + from ..record import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/__init__.py new file mode 100644 index 0000000..5e1b01e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/__init__.py @@ -0,0 +1,16 @@ +from .base_currency import BaseCurrency +from .action_wrapper import ActionWrapper +from .base_currency_action_response import BaseCurrencyActionResponse +from .base_currency_wrapper import BaseCurrencyWrapper +from .currencies_operations import CurrenciesOperations +from .format import Format +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .base_currency_action_wrapper import BaseCurrencyActionWrapper +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .currency import Currency +from .action_handler import ActionHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/action_wrapper.py new file mode 100644 index 0000000..e3038a6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__currencies = None + self.__key_modified = dict() + + def get_currencies(self): + """ + The method to get the currencies + + Returns: + list: An instance of list + """ + + return self.__currencies + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/api_exception.py new file mode 100644 index 0000000..4680b76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_action_response import BaseCurrencyActionResponse + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .base_currency_action_response import BaseCurrencyActionResponse + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(BaseCurrencyActionResponse, ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency.py new file mode 100644 index 0000000..2b4dbac --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency.py @@ -0,0 +1,393 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BaseCurrency(object): + def __init__(self): + """Creates an instance of BaseCurrency""" + + self.__iso_code = None + self.__symbol = None + self.__created_time = None + self.__is_active = None + self.__exchange_rate = None + self.__format = None + self.__created_by = None + self.__prefix_symbol = None + self.__is_base = None + self.__modified_time = None + self.__name = None + self.__modified_by = None + self.__id = None + self.__key_modified = dict() + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_symbol(self): + """ + The method to get the symbol + + Returns: + string: A string representing the symbol + """ + + return self.__symbol + + def set_symbol(self, symbol): + """ + The method to set the value to symbol + + Parameters: + symbol (string) : A string representing the symbol + """ + + if symbol is not None and not isinstance(symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: str', None, None) + + self.__symbol = symbol + self.__key_modified['symbol'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_is_active(self): + """ + The method to get the is_active + + Returns: + bool: A bool representing the is_active + """ + + return self.__is_active + + def set_is_active(self, is_active): + """ + The method to set the value to is_active + + Parameters: + is_active (bool) : A bool representing the is_active + """ + + if is_active is not None and not isinstance(is_active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_active EXPECTED TYPE: bool', None, None) + + self.__is_active = is_active + self.__key_modified['is_active'] = 1 + + def get_exchange_rate(self): + """ + The method to get the exchange_rate + + Returns: + string: A string representing the exchange_rate + """ + + return self.__exchange_rate + + def set_exchange_rate(self, exchange_rate): + """ + The method to set the value to exchange_rate + + Parameters: + exchange_rate (string) : A string representing the exchange_rate + """ + + if exchange_rate is not None and not isinstance(exchange_rate, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exchange_rate EXPECTED TYPE: str', None, None) + + self.__exchange_rate = exchange_rate + self.__key_modified['exchange_rate'] = 1 + + def get_format(self): + """ + The method to get the format + + Returns: + Format: An instance of Format + """ + + return self.__format + + def set_format(self, format): + """ + The method to set the value to format + + Parameters: + format (Format) : An instance of Format + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.format import Format + except Exception: + from .format import Format + + if format is not None and not isinstance(format, Format): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: Format', None, None) + + self.__format = format + self.__key_modified['format'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_prefix_symbol(self): + """ + The method to get the prefix_symbol + + Returns: + bool: A bool representing the prefix_symbol + """ + + return self.__prefix_symbol + + def set_prefix_symbol(self, prefix_symbol): + """ + The method to set the value to prefix_symbol + + Parameters: + prefix_symbol (bool) : A bool representing the prefix_symbol + """ + + if prefix_symbol is not None and not isinstance(prefix_symbol, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix_symbol EXPECTED TYPE: bool', None, None) + + self.__prefix_symbol = prefix_symbol + self.__key_modified['prefix_symbol'] = 1 + + def get_is_base(self): + """ + The method to get the is_base + + Returns: + bool: A bool representing the is_base + """ + + return self.__is_base + + def set_is_base(self, is_base): + """ + The method to set the value to is_base + + Parameters: + is_base (bool) : A bool representing the is_base + """ + + if is_base is not None and not isinstance(is_base, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_base EXPECTED TYPE: bool', None, None) + + self.__is_base = is_base + self.__key_modified['is_base'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_response.py new file mode 100644 index 0000000..f29b04b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class BaseCurrencyActionResponse(ABC): + def __init__(self): + """Creates an instance of BaseCurrencyActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.py new file mode 100644 index 0000000..bbe934e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class BaseCurrencyActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of BaseCurrencyActionWrapper""" + super().__init__() + + self.__base_currency = None + self.__key_modified = dict() + + def get_base_currency(self): + """ + The method to get the base_currency + + Returns: + BaseCurrencyActionResponse: An instance of BaseCurrencyActionResponse + """ + + return self.__base_currency + + def set_base_currency(self, base_currency): + """ + The method to set the value to base_currency + + Parameters: + base_currency (BaseCurrencyActionResponse) : An instance of BaseCurrencyActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_action_response import BaseCurrencyActionResponse + except Exception: + from .base_currency_action_response import BaseCurrencyActionResponse + + if base_currency is not None and not isinstance(base_currency, BaseCurrencyActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: base_currency EXPECTED TYPE: BaseCurrencyActionResponse', None, None) + + self.__base_currency = base_currency + self.__key_modified['base_currency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_wrapper.py new file mode 100644 index 0000000..a48ddfc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/base_currency_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BaseCurrencyWrapper(object): + def __init__(self): + """Creates an instance of BaseCurrencyWrapper""" + + self.__base_currency = None + self.__key_modified = dict() + + def get_base_currency(self): + """ + The method to get the base_currency + + Returns: + BaseCurrency: An instance of BaseCurrency + """ + + return self.__base_currency + + def set_base_currency(self, base_currency): + """ + The method to set the value to base_currency + + Parameters: + base_currency (BaseCurrency) : An instance of BaseCurrency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency import BaseCurrency + except Exception: + from .base_currency import BaseCurrency + + if base_currency is not None and not isinstance(base_currency, BaseCurrency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: base_currency EXPECTED TYPE: BaseCurrency', None, None) + + self.__base_currency = base_currency + self.__key_modified['base_currency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/body_wrapper.py new file mode 100644 index 0000000..3809faa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__currencies = None + self.__key_modified = dict() + + def get_currencies(self): + """ + The method to get the currencies + + Returns: + list: An instance of list + """ + + return self.__currencies + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/currencies_operations.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/currencies_operations.py new file mode 100644 index 0000000..5bad4ed --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/currencies_operations.py @@ -0,0 +1,254 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class CurrenciesOperations(object): + def __init__(self): + """Creates an instance of CurrenciesOperations""" + pass + + def get_currencies(self): + """ + The method to get currencies + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def add_currencies(self, request): + """ + The method to add currencies + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/org/currencies' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_currencies(self, request): + """ + The method to update currencies + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/org/currencies' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_currency(self, id): + """ + The method to get currency + + 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/v7/org/currencies/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_currency(self, id, request): + """ + The method to update currency + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/org/currencies/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def enable_base_currency(self, request): + """ + The method to enable base currency + + Parameters: + request (BaseCurrencyWrapper) : An instance of BaseCurrencyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_wrapper import BaseCurrencyWrapper + except Exception: + from .base_currency_wrapper import BaseCurrencyWrapper + + if request is not None and not isinstance(request, BaseCurrencyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BaseCurrencyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies/actions/enable' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_base_currency(self, request): + """ + The method to update base currency + + Parameters: + request (BaseCurrencyWrapper) : An instance of BaseCurrencyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_wrapper import BaseCurrencyWrapper + except Exception: + from .base_currency_wrapper import BaseCurrencyWrapper + + if request is not None and not isinstance(request, BaseCurrencyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BaseCurrencyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/currencies/actions/enable' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/currency.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/currency.py new file mode 100644 index 0000000..e0cd45f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/currency.py @@ -0,0 +1,393 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__iso_code = None + self.__symbol = None + self.__created_time = None + self.__is_active = None + self.__exchange_rate = None + self.__format = None + self.__created_by = None + self.__prefix_symbol = None + self.__is_base = None + self.__modified_time = None + self.__name = None + self.__modified_by = None + self.__id = None + self.__key_modified = dict() + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_symbol(self): + """ + The method to get the symbol + + Returns: + string: A string representing the symbol + """ + + return self.__symbol + + def set_symbol(self, symbol): + """ + The method to set the value to symbol + + Parameters: + symbol (string) : A string representing the symbol + """ + + if symbol is not None and not isinstance(symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: symbol EXPECTED TYPE: str', None, None) + + self.__symbol = symbol + self.__key_modified['symbol'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_is_active(self): + """ + The method to get the is_active + + Returns: + bool: A bool representing the is_active + """ + + return self.__is_active + + def set_is_active(self, is_active): + """ + The method to set the value to is_active + + Parameters: + is_active (bool) : A bool representing the is_active + """ + + if is_active is not None and not isinstance(is_active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_active EXPECTED TYPE: bool', None, None) + + self.__is_active = is_active + self.__key_modified['is_active'] = 1 + + def get_exchange_rate(self): + """ + The method to get the exchange_rate + + Returns: + string: A string representing the exchange_rate + """ + + return self.__exchange_rate + + def set_exchange_rate(self, exchange_rate): + """ + The method to set the value to exchange_rate + + Parameters: + exchange_rate (string) : A string representing the exchange_rate + """ + + if exchange_rate is not None and not isinstance(exchange_rate, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exchange_rate EXPECTED TYPE: str', None, None) + + self.__exchange_rate = exchange_rate + self.__key_modified['exchange_rate'] = 1 + + def get_format(self): + """ + The method to get the format + + Returns: + Format: An instance of Format + """ + + return self.__format + + def set_format(self, format): + """ + The method to set the value to format + + Parameters: + format (Format) : An instance of Format + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.currencies.format import Format + except Exception: + from .format import Format + + if format is not None and not isinstance(format, Format): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: format EXPECTED TYPE: Format', None, None) + + self.__format = format + self.__key_modified['format'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_prefix_symbol(self): + """ + The method to get the prefix_symbol + + Returns: + bool: A bool representing the prefix_symbol + """ + + return self.__prefix_symbol + + def set_prefix_symbol(self, prefix_symbol): + """ + The method to set the value to prefix_symbol + + Parameters: + prefix_symbol (bool) : A bool representing the prefix_symbol + """ + + if prefix_symbol is not None and not isinstance(prefix_symbol, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix_symbol EXPECTED TYPE: bool', None, None) + + self.__prefix_symbol = prefix_symbol + self.__key_modified['prefix_symbol'] = 1 + + def get_is_base(self): + """ + The method to get the is_base + + Returns: + bool: A bool representing the is_base + """ + + return self.__is_base + + def set_is_base(self, is_base): + """ + The method to set the value to is_base + + Parameters: + is_base (bool) : A bool representing the is_base + """ + + if is_base is not None and not isinstance(is_base, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_base EXPECTED TYPE: bool', None, None) + + self.__is_base = is_base + self.__key_modified['is_base'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/error_details.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/format.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/format.py new file mode 100644 index 0000000..18cacb1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/format.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Format(object): + def __init__(self): + """Creates an instance of Format""" + + self.__decimal_separator = None + self.__thousand_separator = None + self.__decimal_places = None + self.__key_modified = dict() + + def get_decimal_separator(self): + """ + The method to get the decimal_separator + + Returns: + Choice: An instance of Choice + """ + + return self.__decimal_separator + + def set_decimal_separator(self, decimal_separator): + """ + The method to set the value to decimal_separator + + Parameters: + decimal_separator (Choice) : An instance of Choice + """ + + if decimal_separator is not None and not isinstance(decimal_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_separator EXPECTED TYPE: Choice', None, None) + + self.__decimal_separator = decimal_separator + self.__key_modified['decimal_separator'] = 1 + + def get_thousand_separator(self): + """ + The method to get the thousand_separator + + Returns: + Choice: An instance of Choice + """ + + return self.__thousand_separator + + def set_thousand_separator(self, thousand_separator): + """ + The method to set the value to thousand_separator + + Parameters: + thousand_separator (Choice) : An instance of Choice + """ + + if thousand_separator is not None and not isinstance(thousand_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: thousand_separator EXPECTED TYPE: Choice', None, None) + + self.__thousand_separator = thousand_separator + self.__key_modified['thousand_separator'] = 1 + + def get_decimal_places(self): + """ + The method to get the decimal_places + + Returns: + Choice: An instance of Choice + """ + + return self.__decimal_places + + def set_decimal_places(self, decimal_places): + """ + The method to set the value to decimal_places + + Parameters: + decimal_places (Choice) : An instance of Choice + """ + + if decimal_places is not None and not isinstance(decimal_places, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_places EXPECTED TYPE: Choice', None, None) + + self.__decimal_places = decimal_places + self.__key_modified['decimal_places'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/response_wrapper.py new file mode 100644 index 0000000..e1e2585 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__currencies = None + self.__key_modified = dict() + + def get_currencies(self): + """ + The method to get the currencies + + Returns: + list: An instance of list + """ + + return self.__currencies + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/currencies/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/currencies/success_response.py new file mode 100644 index 0000000..1fa8f30 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/currencies/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.currencies.base_currency_action_response import BaseCurrencyActionResponse + from zohocrmsdk.src.com.zoho.crm.api.currencies.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .base_currency_action_response import BaseCurrencyActionResponse + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse, BaseCurrencyActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/__init__.py new file mode 100644 index 0000000..8e47589 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/__init__.py @@ -0,0 +1,20 @@ +from .action_wrapper import ActionWrapper +from .owner import Owner +from .custom_views_operations import CustomViewsOperations, GetCustomViewsParam, GetCustomViewParam, ChangeSortOrderOfCustomViewsParam, ChangeSortOrderOfCustomViewParam +from .criteria import Criteria +from .pin_fields import PinFields +from .body_wrapper import BodyWrapper +from .sort_by import SortBy +from .shared_to import SharedTo +from .custom_views import CustomViews +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .field import Field +from .success_response import SuccessResponse +from .translation import Translation +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .pin_unpin_fields import PinUnpinFields +from .fields import Fields +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_wrapper.py new file mode 100644 index 0000000..bbde710 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__custom_views = None + self.__key_modified = dict() + + def get_custom_views(self): + """ + The method to get the custom_views + + Returns: + list: An instance of list + """ + + return self.__custom_views + + def set_custom_views(self, custom_views): + """ + The method to set the value to custom_views + + Parameters: + custom_views (list) : An instance of list + """ + + if custom_views is not None and not isinstance(custom_views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_views EXPECTED TYPE: list', None, None) + + self.__custom_views = custom_views + self.__key_modified['custom_views'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/api_exception.py new file mode 100644 index 0000000..426459d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/body_wrapper.py new file mode 100644 index 0000000..dcece8e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__custom_views = None + self.__key_modified = dict() + + def get_custom_views(self): + """ + The method to get the custom_views + + Returns: + list: An instance of list + """ + + return self.__custom_views + + def set_custom_views(self, custom_views): + """ + The method to set the value to custom_views + + Parameters: + custom_views (list) : An instance of list + """ + + if custom_views is not None and not isinstance(custom_views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_views EXPECTED TYPE: list', None, None) + + self.__custom_views = custom_views + self.__key_modified['custom_views'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/criteria.py new file mode 100644 index 0000000..212613b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views.py new file mode 100644 index 0000000..820967a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views.py @@ -0,0 +1,630 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class CustomViews(object): + def __init__(self): + """Creates an instance of CustomViews""" + + self.__display_value = None + self.__system_name = None + self.__category = None + self.__created_time = None + self.__modified_time = None + self.__last_accessed_time = None + self.__name = None + self.__created_by = None + self.__modified_by = None + self.__module = None + self.__criteria = None + self.__default = None + self.__system_defined = None + self.__locked = None + self.__favorite = None + self.__offline = None + self.__access_type = None + self.__shared_to = None + self.__fields = None + self.__sort_by = None + self.__sort_order = None + self.__id = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_system_name(self): + """ + The method to get the system_name + + Returns: + string: A string representing the system_name + """ + + return self.__system_name + + def set_system_name(self, system_name): + """ + The method to set the value to system_name + + Parameters: + system_name (string) : A string representing the system_name + """ + + if system_name is not None and not isinstance(system_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_name EXPECTED TYPE: str', None, None) + + self.__system_name = system_name + self.__key_modified['system_name'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_last_accessed_time(self): + """ + The method to get the last_accessed_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_accessed_time + + def set_last_accessed_time(self, last_accessed_time): + """ + The method to set the value to last_accessed_time + + Parameters: + last_accessed_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_accessed_time is not None and not isinstance(last_accessed_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_accessed_time EXPECTED TYPE: datetime', None, None) + + self.__last_accessed_time = last_accessed_time + self.__key_modified['last_accessed_time'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Owner: An instance of Owner + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.owner import Owner + except Exception: + from .owner import Owner + + if module is not None and not isinstance(module, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Owner', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_system_defined(self): + """ + The method to get the system_defined + + Returns: + bool: A bool representing the system_defined + """ + + return self.__system_defined + + def set_system_defined(self, system_defined): + """ + The method to set the value to system_defined + + Parameters: + system_defined (bool) : A bool representing the system_defined + """ + + if system_defined is not None and not isinstance(system_defined, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: bool', None, None) + + self.__system_defined = system_defined + self.__key_modified['system_defined'] = 1 + + def get_locked(self): + """ + The method to get the locked + + Returns: + bool: A bool representing the locked + """ + + return self.__locked + + def set_locked(self, locked): + """ + The method to set the value to locked + + Parameters: + locked (bool) : A bool representing the locked + """ + + if locked is not None and not isinstance(locked, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked EXPECTED TYPE: bool', None, None) + + self.__locked = locked + self.__key_modified['locked'] = 1 + + def get_favorite(self): + """ + The method to get the favorite + + Returns: + int: An int representing the favorite + """ + + return self.__favorite + + def set_favorite(self, favorite): + """ + The method to set the value to favorite + + Parameters: + favorite (int) : An int representing the favorite + """ + + if favorite is not None and not isinstance(favorite, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: int', None, None) + + self.__favorite = favorite + self.__key_modified['favorite'] = 1 + + def get_offline(self): + """ + The method to get the offline + + Returns: + bool: A bool representing the offline + """ + + return self.__offline + + def set_offline(self, offline): + """ + The method to set the value to offline + + Parameters: + offline (bool) : A bool representing the offline + """ + + if offline is not None and not isinstance(offline, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: offline EXPECTED TYPE: bool', None, None) + + self.__offline = offline + self.__key_modified['offline'] = 1 + + def get_access_type(self): + """ + The method to get the access_type + + Returns: + Choice: An instance of Choice + """ + + return self.__access_type + + def set_access_type(self, access_type): + """ + The method to set the value to access_type + + Parameters: + access_type (Choice) : An instance of Choice + """ + + if access_type is not None and not isinstance(access_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: access_type EXPECTED TYPE: Choice', None, None) + + self.__access_type = access_type + self.__key_modified['access_type'] = 1 + + def get_shared_to(self): + """ + The method to get the shared_to + + Returns: + list: An instance of list + """ + + return self.__shared_to + + def set_shared_to(self, shared_to): + """ + The method to set the value to shared_to + + Parameters: + shared_to (list) : An instance of list + """ + + if shared_to is not None and not isinstance(shared_to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_to EXPECTED TYPE: list', None, None) + + self.__shared_to = shared_to + self.__key_modified['shared_to'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + SortBy: An instance of SortBy + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (SortBy) : An instance of SortBy + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.sort_by import SortBy + except Exception: + from .sort_by import SortBy + + if sort_by is not None and not isinstance(sort_by, SortBy): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: SortBy', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + Choice: An instance of Choice + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (Choice) : An instance of Choice + """ + + if sort_order is not None and not isinstance(sort_order, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: Choice', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views_operations.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views_operations.py new file mode 100644 index 0000000..155ffb1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/custom_views_operations.py @@ -0,0 +1,206 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class CustomViewsOperations(object): + def __init__(self): + """Creates an instance of CustomViewsOperations""" + pass + + def get_custom_views(self, param_instance=None): + """ + The method to get custom views + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/custom_views' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_custom_view(self, id, param_instance=None): + """ + The method to get custom view + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/custom_views/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def change_sort_order_of_custom_views(self, request, param_instance=None): + """ + The method to change sort order of custom views + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/custom_views/actions/change_sort' + 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.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def change_sort_order_of_custom_view(self, id, request, param_instance=None): + """ + The method to change sort order of custom view + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + 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/v7/settings/custom_views/' + api_path = api_path + str(id) + api_path = api_path + '/actions/change_sort' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetCustomViewsParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam') + page = Param('page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam') + per_page = Param('per_page', 'com.zoho.crm.api.CustomViews.GetCustomViewsParam') + + +class GetCustomViewParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.GetCustomViewParam') + + +class ChangeSortOrderOfCustomViewsParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.ChangeSortOrderOfCustomViewsParam') + + +class ChangeSortOrderOfCustomViewParam(object): + module = Param('module', 'com.zoho.crm.api.CustomViews.ChangeSortOrderOfCustomViewParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/field.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/fields.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/fields.py new file mode 100644 index 0000000..1e98459 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/fields.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__id = None + self.__api_name = None + self.__pin = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_pin(self): + """ + The method to get the pin + + Returns: + bool: A bool representing the pin + """ + + return self.__pin + + def set_pin(self, pin): + """ + The method to set the value to pin + + Parameters: + pin (bool) : A bool representing the pin + """ + + if pin is not None and not isinstance(pin, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pin EXPECTED TYPE: bool', None, None) + + self.__pin = pin + self.__key_modified['_pin'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/info.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/info.py new file mode 100644 index 0000000..27e8842 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/info.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__default = None + self.__translation = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_default(self): + """ + The method to get the default + + Returns: + int: An int representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (int) : An int representing the default + """ + + if default is not None and not isinstance(default, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: int', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_translation(self): + """ + The method to get the translation + + Returns: + Translation: An instance of Translation + """ + + return self.__translation + + def set_translation(self, translation): + """ + The method to set the value to translation + + Parameters: + translation (Translation) : An instance of Translation + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.translation import Translation + except Exception: + from .translation import Translation + + if translation is not None and not isinstance(translation, Translation): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: translation EXPECTED TYPE: Translation', None, None) + + self.__translation = translation + self.__key_modified['translation'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/owner.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/owner.py new file mode 100644 index 0000000..1c09994 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/owner.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_fields.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_fields.py new file mode 100644 index 0000000..3aa23b1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_fields.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PinFields(object): + def __init__(self): + """Creates an instance of PinFields""" + + self.__api_name = None + self.__pin = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_pin(self): + """ + The method to get the pin + + Returns: + bool: A bool representing the pin + """ + + return self.__pin + + def set_pin(self, pin): + """ + The method to set the value to pin + + Parameters: + pin (bool) : A bool representing the pin + """ + + if pin is not None and not isinstance(pin, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pin EXPECTED TYPE: bool', None, None) + + self.__pin = pin + self.__key_modified['_pin'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_unpin_fields.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_unpin_fields.py new file mode 100644 index 0000000..7ea41d3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/pin_unpin_fields.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PinUnpinFields(object): + def __init__(self): + """Creates an instance of PinUnpinFields""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_wrapper.py new file mode 100644 index 0000000..08ca6cc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__custom_views = None + self.__info = None + self.__key_modified = dict() + + def get_custom_views(self): + """ + The method to get the custom_views + + Returns: + list: An instance of list + """ + + return self.__custom_views + + def set_custom_views(self, custom_views): + """ + The method to set the value to custom_views + + Parameters: + custom_views (list) : An instance of list + """ + + if custom_views is not None and not isinstance(custom_views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_views EXPECTED TYPE: list', None, None) + + self.__custom_views = custom_views + self.__key_modified['custom_views'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/shared_to.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/shared_to.py new file mode 100644 index 0000000..fb69629 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/shared_to.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SharedTo(object): + def __init__(self): + """Creates an instance of SharedTo""" + + self.__type = None + self.__name = None + self.__id = None + self.__subordinates = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/sort_by.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/sort_by.py new file mode 100644 index 0000000..4bed7d8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/sort_by.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SortBy(object): + def __init__(self): + """Creates an instance of SortBy""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/success_response.py new file mode 100644 index 0000000..c5a3ce0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.custom_views.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/custom_views/translation.py b/zohocrmsdk/src/com/zoho/crm/api/custom_views/translation.py new file mode 100644 index 0000000..1812c5c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/custom_views/translation.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Translation(object): + def __init__(self): + """Creates an instance of Translation""" + + self.__public_views = None + self.__other_users_views = None + self.__shared_with_me = None + self.__created_by_me = None + self.__key_modified = dict() + + def get_public_views(self): + """ + The method to get the public_views + + Returns: + string: A string representing the public_views + """ + + return self.__public_views + + def set_public_views(self, public_views): + """ + The method to set the value to public_views + + Parameters: + public_views (string) : A string representing the public_views + """ + + if public_views is not None and not isinstance(public_views, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: public_views EXPECTED TYPE: str', None, None) + + self.__public_views = public_views + self.__key_modified['public_views'] = 1 + + def get_other_users_views(self): + """ + The method to get the other_users_views + + Returns: + string: A string representing the other_users_views + """ + + return self.__other_users_views + + def set_other_users_views(self, other_users_views): + """ + The method to set the value to other_users_views + + Parameters: + other_users_views (string) : A string representing the other_users_views + """ + + if other_users_views is not None and not isinstance(other_users_views, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_users_views EXPECTED TYPE: str', None, None) + + self.__other_users_views = other_users_views + self.__key_modified['other_users_views'] = 1 + + def get_shared_with_me(self): + """ + The method to get the shared_with_me + + Returns: + string: A string representing the shared_with_me + """ + + return self.__shared_with_me + + def set_shared_with_me(self, shared_with_me): + """ + The method to set the value to shared_with_me + + Parameters: + shared_with_me (string) : A string representing the shared_with_me + """ + + if shared_with_me is not None and not isinstance(shared_with_me, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_with_me EXPECTED TYPE: str', None, None) + + self.__shared_with_me = shared_with_me + self.__key_modified['shared_with_me'] = 1 + + def get_created_by_me(self): + """ + The method to get the created_by_me + + Returns: + string: A string representing the created_by_me + """ + + return self.__created_by_me + + def set_created_by_me(self, created_by_me): + """ + The method to set the value to created_by_me + + Parameters: + created_by_me (string) : A string representing the created_by_me + """ + + if created_by_me is not None and not isinstance(created_by_me, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by_me EXPECTED TYPE: str', None, None) + + self.__created_by_me = created_by_me + self.__key_modified['created_by_me'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/dc/__init__.py new file mode 100755 index 0000000..01b5c13 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/__init__.py @@ -0,0 +1,8 @@ +from .au_data_center import AUDataCenter +from .cn_data_center import CNDataCenter +from .data_center import DataCenter +from .eu_data_center import EUDataCenter +from .in_data_center import INDataCenter +from .us_data_center import USDataCenter +from .jp_data_center import JPDataCenter +from .ca_data_center import CADataCenter diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/au_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/au_data_center.py new file mode 100755 index 0000000..d6e0cca --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/au_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class AUDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in AU Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in AU domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://www.zohoapis.com.au", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in AU domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://sandbox.zohoapis.com.au", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in AU domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://developer.zohoapis.com.au", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.com.au/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.com.au" diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/ca_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/ca_data_center.py new file mode 100644 index 0000000..24b8865 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/ca_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class CADataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in CA Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in CA domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.ca", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in CA domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.ca", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in CA domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.ca", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.ca/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.ca" diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/cn_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/cn_data_center.py new file mode 100755 index 0000000..3de78e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/cn_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class CNDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in CN Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in CN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.com.cn", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in CN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.com.cn", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in CN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.com.cn", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.com.cn/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.com.cn" diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/data_center.py new file mode 100755 index 0000000..3f0baae --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/data_center.py @@ -0,0 +1,98 @@ +from abc import abstractmethod, ABC + + +class DataCenter(ABC): + + """ + This class represents the properties of Zoho CRM DataCenter + """ + + @abstractmethod + def get_iam_url(self): + + """ + The method to get the accounts URL. + :return: A str representing the accounts URL. + """ + + pass + + @abstractmethod + def get_file_upload_url(self): + """ + The method to get the File Upload URL + :return: A str representing the File Upload URL + """ + + pass + + class Environment(object): + + def __init__(self, url, accounts_url, file_upload_url): + + """ + Creates an Environment class instance with the specified parameters. + :param url: A str representing the Zoho CRM API URL. + :param accounts_url: A str representing the accounts URL. + :param file_upload_url : A str representing the File Upload URL + """ + + self.url = url + self.accounts_url = accounts_url + self.file_upload_url = file_upload_url + return + + @staticmethod + def get(config): + + try: + from zohocrmsdk.src.com.zoho.crm.api.dc import USDataCenter, JPDataCenter, INDataCenter, EUDataCenter, CNDataCenter, AUDataCenter + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + except Exception: + from ..dc import USDataCenter, JPDataCenter, INDataCenter, EUDataCenter, CNDataCenter, AUDataCenter + from ..exception import SDKException + from ..util import Constants + + if config in Constants.US_DATACENTER: + if Constants.SANDBOX in config: + return USDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return USDataCenter.DEVELOPER() + return USDataCenter.PRODUCTION() + + elif config in Constants.JP_DATACENTER: + if Constants.SANDBOX in config: + return JPDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return JPDataCenter.DEVELOPER() + return JPDataCenter.PRODUCTION() + + elif config in Constants.IN_DATACENTER: + if Constants.SANDBOX in config: + return INDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return INDataCenter.DEVELOPER() + return INDataCenter.PRODUCTION() + + elif config in Constants.EU_DATACENTER: + if Constants.SANDBOX in config: + return EUDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return EUDataCenter.DEVELOPER() + return EUDataCenter.PRODUCTION() + + elif config in Constants.CN_DATACENTER: + if Constants.SANDBOX in config: + return CNDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return CNDataCenter.DEVELOPER() + return CNDataCenter.PRODUCTION() + + elif config in Constants.AU_DATACENTER: + if Constants.SANDBOX in config: + return AUDataCenter.SANDBOX() + if Constants.DEVELOPER in config: + return AUDataCenter.DEVELOPER() + return AUDataCenter.PRODUCTION() + return None diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/eu_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/eu_data_center.py new file mode 100755 index 0000000..c2bdc17 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/eu_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class EUDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in EU Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in EU domain + :return: An instance of Environments + """ + + return DataCenter.Environment("https://www.zohoapis.eu", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in EU domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.eu", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in EU domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.eu", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.eu/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.eu" diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/in_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/in_data_center.py new file mode 100755 index 0000000..3945bc4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/in_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class INDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in IN Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in IN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.in", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in IN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.in", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in IN domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.in", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.in/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.in" diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/jp_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/jp_data_center.py new file mode 100644 index 0000000..17fe5c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/jp_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class JPDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in Japan Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in Japan domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://www.zohoapis.jp", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in Japan domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://sandbox.zohoapis.jp", cls(). get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in Japan domain + :return: A Environment class instance. + """ + + return DataCenter.Environment("https://developer.zohoapis.jp", cls(). get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.jp/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.jp" diff --git a/zohocrmsdk/src/com/zoho/crm/api/dc/us_data_center.py b/zohocrmsdk/src/com/zoho/crm/api/dc/us_data_center.py new file mode 100755 index 0000000..df99e2a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/dc/us_data_center.py @@ -0,0 +1,47 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter +except Exception as e: + from .data_center import DataCenter + + +class USDataCenter(DataCenter): + + """ + This class represents the properties of Zoho CRM in US Domain. + """ + + @classmethod + def PRODUCTION(cls): + + """ + This method represents the Zoho CRM Production environment in US domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://www.zohoapis.com", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def SANDBOX(cls): + + """ + This method represents the Zoho CRM Sandbox environment in US domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://sandbox.zohoapis.com", cls().get_iam_url(), cls().get_file_upload_url()) + + @classmethod + def DEVELOPER(cls): + + """ + This method represents the Zoho CRM Developer environment in US domain + :return: An instance of Environment + """ + + return DataCenter.Environment("https://developer.zohoapis.com", cls().get_iam_url(), cls().get_file_upload_url()) + + def get_iam_url(self): + return "https://accounts.zoho.com/oauth/v2/token" + + def get_file_upload_url(self): + return "https://content.zohoapis.com" diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/__init__.py new file mode 100644 index 0000000..69756f5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/__init__.py @@ -0,0 +1,13 @@ +from .action_wrapper import ActionWrapper +from .deal_contact_roles_operations import DealContactRolesOperations, GetAssociatedContactRolesParam +from .data import Data +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .contact_role import ContactRole +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_wrapper.py new file mode 100644 index 0000000..89e74a1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/api_exception.py new file mode 100644 index 0000000..e060fec --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/contact_role.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/contact_role.py new file mode 100644 index 0000000..b93d5af --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/contact_role.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ContactRole(object): + def __init__(self): + """Creates an instance of ContactRole""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/data.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/data.py new file mode 100644 index 0000000..a6b6e58 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/data.py @@ -0,0 +1,218 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..record import Record + + +class Data(Record): + def __init__(self): + """Creates an instance of Data""" + super().__init__() + + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_contact_role(self): + """ + The method to get the contact_role + + Returns: + ContactRole: An instance of ContactRole + """ + + return self.get_key_value('Contact_Role') + + def set_contact_role(self, contact_role): + """ + The method to set the value to contact_role + + Parameters: + contact_role (ContactRole) : An instance of ContactRole + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.contact_role import ContactRole + except Exception: + from .contact_role import ContactRole + + if contact_role is not None and not isinstance(contact_role, ContactRole): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_role EXPECTED TYPE: ContactRole', None, None) + + self.add_key_value('Contact_Role', contact_role) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/deal_contact_roles_operations.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/deal_contact_roles_operations.py new file mode 100644 index 0000000..46a549f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/deal_contact_roles_operations.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + + +class DealContactRolesOperations(object): + def __init__(self): + """Creates an instance of DealContactRolesOperations""" + pass + + def get_associated_contact_roles(self, deal, param_instance=None): + """ + The method to get associated contact roles + + Parameters: + deal (int) : An int representing the deal + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal EXPECTED TYPE: int', None, None) + + 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/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles' + 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.set_param(param_instance) + handler_instance.set_module_api_name("Contacts") + Utility.get_fields("Contacts", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associated_contact_roles_specific_to_contact(self, contact, deal): + """ + The method to get associated contact roles specific to contact + + Parameters: + contact (int) : An int representing the contact + deal (int) : An int representing the deal + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(contact, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact EXPECTED TYPE: int', None, None) + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles/' + api_path = api_path + str(contact) + 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.set_module_api_name("Contacts") + Utility.get_fields("Contacts", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def associate_contact_role_to_deal(self, contact, deal, request): + """ + The method to associate contact role to deal + + Parameters: + contact (int) : An int representing the contact + deal (int) : An int representing the deal + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(contact, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact EXPECTED TYPE: int', None, None) + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal 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/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles/' + api_path = api_path + str(contact) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_contact_role_realation(self, contact, deal): + """ + The method to delete contact role realation + + Parameters: + contact (int) : An int representing the contact + deal (int) : An int representing the deal + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(contact, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact EXPECTED TYPE: int', None, None) + + if not isinstance(deal, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Deals/' + api_path = api_path + str(deal) + api_path = api_path + '/Contact_Roles/' + api_path = api_path + str(contact) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAssociatedContactRolesParam(object): + ids = Param('ids', 'com.zoho.crm.api.DealContactRoles.GetAssociatedContactRolesParam') + fields = Param('fields', 'com.zoho.crm.api.DealContactRoles.GetAssociatedContactRolesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/error_details.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/info.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/info.py new file mode 100644 index 0000000..c52501d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/info.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__page = None + self.__per_page = None + self.__more_records = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__next_page_token = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + string: A string representing the page_token_expiry + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (string) : A string representing the page_token_expiry + """ + + if page_token_expiry is not None and not isinstance(page_token_expiry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: str', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_wrapper.py new file mode 100644 index 0000000..dbab61d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/success_response.py new file mode 100644 index 0000000..06790e8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/deal_contact_roles/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/definition/__init__.py new file mode 100644 index 0000000..0154832 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .property import Property +from .response_wrapper import ResponseWrapper +from .minified_property1 import MinifiedProperty1 +from .definition import Definition +from .minified_property import MinifiedProperty diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/definition/api_exception.py new file mode 100644 index 0000000..a68a663 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/definition.py b/zohocrmsdk/src/com/zoho/crm/api/definition/definition.py new file mode 100644 index 0000000..f5ce7fa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/definition.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Definition(object): + def __init__(self): + """Creates an instance of Definition""" + + self.__root_element_name = None + self.__extradetails = None + self.__properties = None + self.__key_modified = dict() + + def get_root_element_name(self): + """ + The method to get the root_element_name + + Returns: + string: A string representing the root_element_name + """ + + return self.__root_element_name + + def set_root_element_name(self, root_element_name): + """ + The method to set the value to root_element_name + + Parameters: + root_element_name (string) : A string representing the root_element_name + """ + + if root_element_name is not None and not isinstance(root_element_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: root_element_name EXPECTED TYPE: str', None, None) + + self.__root_element_name = root_element_name + self.__key_modified['root_element_name'] = 1 + + def get_extradetails(self): + """ + The method to get the extradetails + + Returns: + dict: An instance of dict + """ + + return self.__extradetails + + def set_extradetails(self, extradetails): + """ + The method to set the value to extradetails + + Parameters: + extradetails (dict) : An instance of dict + """ + + if extradetails is not None and not isinstance(extradetails, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: extradetails EXPECTED TYPE: dict', None, None) + + self.__extradetails = extradetails + self.__key_modified['extraDetails'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property.py b/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property.py new file mode 100644 index 0000000..1328aa1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedProperty(object): + def __init__(self): + """Creates an instance of MinifiedProperty""" + + self.__read_only = None + self.__api_name = None + self.__data_type = None + self.__length = None + self.__required = None + self.__properties = None + self.__key_modified = dict() + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property1.py b/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property1.py new file mode 100644 index 0000000..0b965d3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/minified_property1.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedProperty1(object): + def __init__(self): + """Creates an instance of MinifiedProperty1""" + + self.__read_only = None + self.__api_name = None + self.__data_type = None + self.__length = None + self.__required = None + self.__key_modified = dict() + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/property.py b/zohocrmsdk/src/com/zoho/crm/api/definition/property.py new file mode 100644 index 0000000..830e2d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/property.py @@ -0,0 +1,349 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Property(object): + def __init__(self): + """Creates an instance of Property""" + + self.__display_label = None + self.__allowed_values = None + self.__ui_type = None + self.__regex = None + self.__read_only = None + self.__api_name = None + self.__field_label = None + self.__data_type = None + self.__length = None + self.__available_in_user_layout = None + self.__required = None + self.__properties = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_allowed_values(self): + """ + The method to get the allowed_values + + Returns: + list: An instance of list + """ + + return self.__allowed_values + + def set_allowed_values(self, allowed_values): + """ + The method to set the value to allowed_values + + Parameters: + allowed_values (list) : An instance of list + """ + + if allowed_values is not None and not isinstance(allowed_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_values EXPECTED TYPE: list', None, None) + + self.__allowed_values = allowed_values + self.__key_modified['allowed_values'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_regex(self): + """ + The method to get the regex + + Returns: + string: A string representing the regex + """ + + return self.__regex + + def set_regex(self, regex): + """ + The method to set the value to regex + + Parameters: + regex (string) : A string representing the regex + """ + + if regex is not None and not isinstance(regex, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: regex EXPECTED TYPE: str', None, None) + + self.__regex = regex + self.__key_modified['regex'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/definition/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/definition/response_wrapper.py new file mode 100644 index 0000000..d553333 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/definition/response_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__definition = None + self.__key_modified = dict() + + def get_definition(self): + """ + The method to get the definition + + Returns: + Definition: An instance of Definition + """ + + return self.__definition + + def set_definition(self, definition): + """ + The method to set the value to definition + + Parameters: + definition (Definition) : An instance of Definition + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.definition.definition import Definition + except Exception: + from .definition import Definition + + if definition is not None and not isinstance(definition, Definition): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: definition EXPECTED TYPE: Definition', None, None) + + self.__definition = definition + self.__key_modified['definition'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/digest/__init__.py new file mode 100644 index 0000000..8d9e1b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/__init__.py @@ -0,0 +1,9 @@ +from .action_wrapper import ActionWrapper +from .dependee import Dependee +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .digest_operations import DigestOperations +from .digest import Digest +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/digest/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/digest/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/digest/action_wrapper.py new file mode 100644 index 0000000..e5eccf1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.digest.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__digest = None + self.__key_modified = dict() + + def get_digest(self): + """ + The method to get the digest + + Returns: + list: An instance of list + """ + + return self.__digest + + def set_digest(self, digest): + """ + The method to set the value to digest + + Parameters: + digest (list) : An instance of list + """ + + if digest is not None and not isinstance(digest, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: digest EXPECTED TYPE: list', None, None) + + self.__digest = digest + self.__key_modified['__digest'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/digest/api_exception.py new file mode 100644 index 0000000..b138c88 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.digest.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.digest.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/digest/body_wrapper.py new file mode 100644 index 0000000..dd0946e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__digest = None + self.__key_modified = dict() + + def get_digest(self): + """ + The method to get the digest + + Returns: + list: An instance of list + """ + + return self.__digest + + def set_digest(self, digest): + """ + The method to set the value to digest + + Parameters: + digest (list) : An instance of list + """ + + if digest is not None and not isinstance(digest, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: digest EXPECTED TYPE: list', None, None) + + self.__digest = digest + self.__key_modified['__digest'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/dependee.py b/zohocrmsdk/src/com/zoho/crm/api/digest/dependee.py new file mode 100644 index 0000000..fb318b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/dependee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Dependee(object): + def __init__(self): + """Creates an instance of Dependee""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/digest.py b/zohocrmsdk/src/com/zoho/crm/api/digest/digest.py new file mode 100644 index 0000000..e95fea4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/digest.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Digest(object): + def __init__(self): + """Creates an instance of Digest""" + + self.__record_id = None + self.__type = None + self.__module = None + self.__key_modified = dict() + + def get_record_id(self): + """ + The method to get the record_id + + Returns: + int: An int representing the record_id + """ + + return self.__record_id + + def set_record_id(self, record_id): + """ + The method to set the value to record_id + + Parameters: + record_id (int) : An int representing the record_id + """ + + if record_id is not None and not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + self.__record_id = record_id + self.__key_modified['record_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/digest_operations.py b/zohocrmsdk/src/com/zoho/crm/api/digest/digest_operations.py new file mode 100644 index 0000000..c2e315f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/digest_operations.py @@ -0,0 +1,49 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class DigestOperations(object): + def __init__(self): + """Creates an instance of DigestOperations""" + pass + + def create_digest(self, request): + """ + The method to create digest + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.digest.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/__digest' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.digest.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/digest/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/digest/success_response.py new file mode 100644 index 0000000..43854d9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/digest/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.digest.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_attachments/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/__init__.py new file mode 100644 index 0000000..17e29ed --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .file_body_wrapper import FileBodyWrapper +from .download_attachments_operations import DownloadAttachmentsOperations, GetDownloadAttachmentsDetailsParam diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_attachments/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/api_exception.py new file mode 100644 index 0000000..b6eeb88 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_attachments/download_attachments_operations.py b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/download_attachments_operations.py new file mode 100644 index 0000000..1fb5252 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/download_attachments_operations.py @@ -0,0 +1,68 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class DownloadAttachmentsOperations(object): + def __init__(self): + """Creates an instance of DownloadAttachmentsOperations""" + pass + + def get_download_attachments_details(self, record_id, module, param_instance=None): + """ + The method to get download attachments details + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Emails/actions/download_attachments' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.download_attachments.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'multipart/form-data') + + +class GetDownloadAttachmentsDetailsParam(object): + user_id = Param('user_id', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') + message_id = Param('message_id', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') + id = Param('id', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') + name = Param('name', 'com.zoho.crm.api.DownloadAttachments.GetDownloadAttachmentsDetailsParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_attachments/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/file_body_wrapper.py new file mode 100644 index 0000000..3165063 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_attachments/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_attachments/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/__init__.py new file mode 100644 index 0000000..d55d89e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .file_body_wrapper import FileBodyWrapper +from .download_inline_images_operations import DownloadInlineImagesOperations, GetDownloadInlineImagesParam diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/api_exception.py new file mode 100644 index 0000000..c3419a0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_inline_images.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/download_inline_images_operations.py b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/download_inline_images_operations.py new file mode 100644 index 0000000..3714630 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/download_inline_images_operations.py @@ -0,0 +1,67 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class DownloadInlineImagesOperations(object): + def __init__(self): + """Creates an instance of DownloadInlineImagesOperations""" + pass + + def get_download_inline_images(self, record_id, module, param_instance=None): + """ + The method to get download inline images + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/Emails/actions/download_inline_images' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.download_inline_images.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'multipart/form-data') + + +class GetDownloadInlineImagesParam(object): + user_id = Param('user_id', 'com.zoho.crm.api.DownloadInlineImages.GetDownloadInlineImagesParam') + message_id = Param('message_id', 'com.zoho.crm.api.DownloadInlineImages.GetDownloadInlineImagesParam') + id = Param('id', 'com.zoho.crm.api.DownloadInlineImages.GetDownloadInlineImagesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/file_body_wrapper.py new file mode 100644 index 0000000..ab10ebf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.download_inline_images.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/download_inline_images/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/__init__.py new file mode 100644 index 0000000..bd57cb3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .mapped_field import MappedField +from .duplicate_check_preference import DuplicateCheckPreference +from .mapped_module import MappedModule +from .body_wrapper import BodyWrapper +from .duplicate_check_preference_operations import DuplicateCheckPreferenceOperations, GetDuplicateCheckPreferenceParam, CreateDuplicateCheckPreferenceParam, UpdateDuplicateCheckPreferenceParam, DeleteDuplicateCheckPreferenceParam +from .field_mappings import FieldMappings +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .expected_fields import ExpectedFields +from .current_field import CurrentField +from .type_configuration import TypeConfiguration +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_wrapper.py new file mode 100644 index 0000000..aa07144 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__duplicate_check_preference = None + self.__key_modified = dict() + + def get_duplicate_check_preference(self): + """ + The method to get the duplicate_check_preference + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__duplicate_check_preference + + def set_duplicate_check_preference(self, duplicate_check_preference): + """ + The method to set the value to duplicate_check_preference + + Parameters: + duplicate_check_preference (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if duplicate_check_preference is not None and not isinstance(duplicate_check_preference, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_preference EXPECTED TYPE: ActionResponse', None, None) + + self.__duplicate_check_preference = duplicate_check_preference + self.__key_modified['duplicate_check_preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/api_exception.py new file mode 100644 index 0000000..22dbdd1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/body_wrapper.py new file mode 100644 index 0000000..9fd9733 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__duplicate_check_preference = None + self.__key_modified = dict() + + def get_duplicate_check_preference(self): + """ + The method to get the duplicate_check_preference + + Returns: + DuplicateCheckPreference: An instance of DuplicateCheckPreference + """ + + return self.__duplicate_check_preference + + def set_duplicate_check_preference(self, duplicate_check_preference): + """ + The method to set the value to duplicate_check_preference + + Parameters: + duplicate_check_preference (DuplicateCheckPreference) : An instance of DuplicateCheckPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.duplicate_check_preference import DuplicateCheckPreference + except Exception: + from .duplicate_check_preference import DuplicateCheckPreference + + if duplicate_check_preference is not None and not isinstance(duplicate_check_preference, DuplicateCheckPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_preference EXPECTED TYPE: DuplicateCheckPreference', None, None) + + self.__duplicate_check_preference = duplicate_check_preference + self.__key_modified['duplicate_check_preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/current_field.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/current_field.py new file mode 100644 index 0000000..580794d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/current_field.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CurrentField(object): + def __init__(self): + """Creates an instance of CurrentField""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference.py new file mode 100644 index 0000000..95b9b53 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class DuplicateCheckPreference(object): + def __init__(self): + """Creates an instance of DuplicateCheckPreference""" + + self.__type = None + self.__type_configurations = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_type_configurations(self): + """ + The method to get the type_configurations + + Returns: + list: An instance of list + """ + + return self.__type_configurations + + def set_type_configurations(self, type_configurations): + """ + The method to set the value to type_configurations + + Parameters: + type_configurations (list) : An instance of list + """ + + if type_configurations is not None and not isinstance(type_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type_configurations EXPECTED TYPE: list', None, None) + + self.__type_configurations = type_configurations + self.__key_modified['type_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference_operations.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference_operations.py new file mode 100644 index 0000000..17ee055 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/duplicate_check_preference_operations.py @@ -0,0 +1,164 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class DuplicateCheckPreferenceOperations(object): + def __init__(self, module=None): + """ + Creates an instance of DuplicateCheckPreferenceOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def get_duplicate_check_preference(self): + """ + The method to get duplicate check preference + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/duplicate_check_preference' + 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.DuplicateCheckPreference.GetDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_duplicate_check_preference(self, request): + """ + The method to create duplicate check preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/duplicate_check_preference' + 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('module', 'com.zoho.crm.api.DuplicateCheckPreference.CreateDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_duplicate_check_preference(self, request): + """ + The method to update duplicate check preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/duplicate_check_preference' + 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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.DuplicateCheckPreference.UpdateDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_duplicate_check_preference(self): + """ + The method to delete duplicate check preference + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/duplicate_check_preference' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.DuplicateCheckPreference.DeleteDuplicateCheckPreferenceParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetDuplicateCheckPreferenceParam(object): + pass + + +class CreateDuplicateCheckPreferenceParam(object): + pass + + +class UpdateDuplicateCheckPreferenceParam(object): + pass + + +class DeleteDuplicateCheckPreferenceParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/expected_fields.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/expected_fields.py new file mode 100644 index 0000000..eed098e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/expected_fields.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExpectedFields(object): + def __init__(self): + """Creates an instance of ExpectedFields""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/field_mappings.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/field_mappings.py new file mode 100644 index 0000000..504d770 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/field_mappings.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldMappings(object): + def __init__(self): + """Creates an instance of FieldMappings""" + + self.__current_field = None + self.__mapped_field = None + self.__key_modified = dict() + + def get_current_field(self): + """ + The method to get the current_field + + Returns: + CurrentField: An instance of CurrentField + """ + + return self.__current_field + + def set_current_field(self, current_field): + """ + The method to set the value to current_field + + Parameters: + current_field (CurrentField) : An instance of CurrentField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.current_field import CurrentField + except Exception: + from .current_field import CurrentField + + if current_field is not None and not isinstance(current_field, CurrentField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: current_field EXPECTED TYPE: CurrentField', None, None) + + self.__current_field = current_field + self.__key_modified['current_field'] = 1 + + def get_mapped_field(self): + """ + The method to get the mapped_field + + Returns: + MappedField: An instance of MappedField + """ + + return self.__mapped_field + + def set_mapped_field(self, mapped_field): + """ + The method to set the value to mapped_field + + Parameters: + mapped_field (MappedField) : An instance of MappedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.mapped_field import MappedField + except Exception: + from .mapped_field import MappedField + + if mapped_field is not None and not isinstance(mapped_field, MappedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mapped_field EXPECTED TYPE: MappedField', None, None) + + self.__mapped_field = mapped_field + self.__key_modified['mapped_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_field.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_field.py new file mode 100644 index 0000000..e51666b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_field.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MappedField(object): + def __init__(self): + """Creates an instance of MappedField""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_module.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_module.py new file mode 100644 index 0000000..96b59e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/mapped_module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MappedModule(object): + def __init__(self): + """Creates an instance of MappedModule""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_wrapper.py new file mode 100644 index 0000000..ce81bb3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__duplicate_check_preference = None + self.__key_modified = dict() + + def get_duplicate_check_preference(self): + """ + The method to get the duplicate_check_preference + + Returns: + DuplicateCheckPreference: An instance of DuplicateCheckPreference + """ + + return self.__duplicate_check_preference + + def set_duplicate_check_preference(self, duplicate_check_preference): + """ + The method to set the value to duplicate_check_preference + + Parameters: + duplicate_check_preference (DuplicateCheckPreference) : An instance of DuplicateCheckPreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.duplicate_check_preference import DuplicateCheckPreference + except Exception: + from .duplicate_check_preference import DuplicateCheckPreference + + if duplicate_check_preference is not None and not isinstance(duplicate_check_preference, DuplicateCheckPreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_preference EXPECTED TYPE: DuplicateCheckPreference', None, None) + + self.__duplicate_check_preference = duplicate_check_preference + self.__key_modified['duplicate_check_preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/success_response.py new file mode 100644 index 0000000..f351f55 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/type_configuration.py b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/type_configuration.py new file mode 100644 index 0000000..572c9cd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/duplicate_check_preference/type_configuration.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TypeConfiguration(object): + def __init__(self): + """Creates an instance of TypeConfiguration""" + + self.__field_mappings = None + self.__mapped_module = None + self.__key_modified = dict() + + def get_field_mappings(self): + """ + The method to get the field_mappings + + Returns: + list: An instance of list + """ + + return self.__field_mappings + + def set_field_mappings(self, field_mappings): + """ + The method to set the value to field_mappings + + Parameters: + field_mappings (list) : An instance of list + """ + + if field_mappings is not None and not isinstance(field_mappings, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_mappings EXPECTED TYPE: list', None, None) + + self.__field_mappings = field_mappings + self.__key_modified['field_mappings'] = 1 + + def get_mapped_module(self): + """ + The method to get the mapped_module + + Returns: + MappedModule: An instance of MappedModule + """ + + return self.__mapped_module + + def set_mapped_module(self, mapped_module): + """ + The method to set the value to mapped_module + + Parameters: + mapped_module (MappedModule) : An instance of MappedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.mapped_module import MappedModule + except Exception: + from .mapped_module import MappedModule + + if mapped_module is not None and not isinstance(mapped_module, MappedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mapped_module EXPECTED TYPE: MappedModule', None, None) + + self.__mapped_module = mapped_module + self.__key_modified['mapped_module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/__init__.py new file mode 100644 index 0000000..97e9a5a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/__init__.py @@ -0,0 +1,6 @@ +from .data_map import DataMap +from .data import Data +from .signature import Signature +from .features_available import FeaturesAvailable +from .from_address import FromAddress +from .user import User diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data.py new file mode 100644 index 0000000..fa0a817 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Data(object): + def __init__(self): + """Creates an instance of Data""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data_map.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data_map.py new file mode 100644 index 0000000..b43c7b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/data_map.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataMap(object): + def __init__(self): + """Creates an instance of DataMap""" + + self.__user = None + self.__features_available = None + self.__from_address = None + self.__relay_domains = None + self.__mergefieldsdata = None + self.__key_modified = dict() + + def get_user(self): + """ + The method to get the user + + Returns: + User: An instance of User + """ + + return self.__user + + def set_user(self, user): + """ + The method to set the value to user + + Parameters: + user (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.user import User + except Exception: + from .user import User + + if user is not None and not isinstance(user, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: User', None, None) + + self.__user = user + self.__key_modified['user'] = 1 + + def get_features_available(self): + """ + The method to get the features_available + + Returns: + FeaturesAvailable: An instance of FeaturesAvailable + """ + + return self.__features_available + + def set_features_available(self, features_available): + """ + The method to set the value to features_available + + Parameters: + features_available (FeaturesAvailable) : An instance of FeaturesAvailable + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.features_available import FeaturesAvailable + except Exception: + from .features_available import FeaturesAvailable + + if features_available is not None and not isinstance(features_available, FeaturesAvailable): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: features_available EXPECTED TYPE: FeaturesAvailable', None, None) + + self.__features_available = features_available + self.__key_modified['features_available'] = 1 + + def get_from_address(self): + """ + The method to get the from_address + + Returns: + list: An instance of list + """ + + return self.__from_address + + def set_from_address(self, from_address): + """ + The method to set the value to from_address + + Parameters: + from_address (list) : An instance of list + """ + + if from_address is not None and not isinstance(from_address, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_address EXPECTED TYPE: list', None, None) + + self.__from_address = from_address + self.__key_modified['from_address'] = 1 + + def get_relay_domains(self): + """ + The method to get the relay_domains + + Returns: + list: An instance of list + """ + + return self.__relay_domains + + def set_relay_domains(self, relay_domains): + """ + The method to set the value to relay_domains + + Parameters: + relay_domains (list) : An instance of list + """ + + if relay_domains is not None and not isinstance(relay_domains, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: relay_domains EXPECTED TYPE: list', None, None) + + self.__relay_domains = relay_domains + self.__key_modified['relay_domains'] = 1 + + def get_mergefieldsdata(self): + """ + The method to get the mergefieldsdata + + Returns: + string: A string representing the mergefieldsdata + """ + + return self.__mergefieldsdata + + def set_mergefieldsdata(self, mergefieldsdata): + """ + The method to set the value to mergefieldsdata + + Parameters: + mergefieldsdata (string) : A string representing the mergefieldsdata + """ + + if mergefieldsdata is not None and not isinstance(mergefieldsdata, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mergefieldsdata EXPECTED TYPE: str', None, None) + + self.__mergefieldsdata = mergefieldsdata + self.__key_modified['mergeFieldsData'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/features_available.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/features_available.py new file mode 100644 index 0000000..0e27355 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/features_available.py @@ -0,0 +1,449 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class FeaturesAvailable(object): + def __init__(self): + """Creates an instance of FeaturesAvailable""" + + self.__zsurvey_enabled = None + self.__inline_compose_window = None + self.__schedule_mail = None + self.__email_cloud_picker = None + self.__form_integration_enabled = None + self.__isprivacyenabled = None + self.__auto_suggestion = None + self.__unsubscribe_link = None + self.__best_time_to_contact = None + self.__attach_teamdrive = None + self.__islivedeskenabled = None + self.__subject_line_suggestion = None + self.__email_preference = None + self.__attachment = None + self.__mandateunsublink = None + self.__old_compose_revert = None + self.__key_modified = dict() + + def get_zsurvey_enabled(self): + """ + The method to get the zsurvey_enabled + + Returns: + Choice: An instance of Choice + """ + + return self.__zsurvey_enabled + + def set_zsurvey_enabled(self, zsurvey_enabled): + """ + The method to set the value to zsurvey_enabled + + Parameters: + zsurvey_enabled (Choice) : An instance of Choice + """ + + if zsurvey_enabled is not None and not isinstance(zsurvey_enabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zsurvey_enabled EXPECTED TYPE: Choice', None, None) + + self.__zsurvey_enabled = zsurvey_enabled + self.__key_modified['zsurvey_enabled'] = 1 + + def get_inline_compose_window(self): + """ + The method to get the inline_compose_window + + Returns: + Choice: An instance of Choice + """ + + return self.__inline_compose_window + + def set_inline_compose_window(self, inline_compose_window): + """ + The method to set the value to inline_compose_window + + Parameters: + inline_compose_window (Choice) : An instance of Choice + """ + + if inline_compose_window is not None and not isinstance(inline_compose_window, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inline_compose_window EXPECTED TYPE: Choice', None, None) + + self.__inline_compose_window = inline_compose_window + self.__key_modified['inline_compose_window'] = 1 + + def get_schedule_mail(self): + """ + The method to get the schedule_mail + + Returns: + Choice: An instance of Choice + """ + + return self.__schedule_mail + + def set_schedule_mail(self, schedule_mail): + """ + The method to set the value to schedule_mail + + Parameters: + schedule_mail (Choice) : An instance of Choice + """ + + if schedule_mail is not None and not isinstance(schedule_mail, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: schedule_mail EXPECTED TYPE: Choice', None, None) + + self.__schedule_mail = schedule_mail + self.__key_modified['Schedule_Mail'] = 1 + + def get_email_cloud_picker(self): + """ + The method to get the email_cloud_picker + + Returns: + Choice: An instance of Choice + """ + + return self.__email_cloud_picker + + def set_email_cloud_picker(self, email_cloud_picker): + """ + The method to set the value to email_cloud_picker + + Parameters: + email_cloud_picker (Choice) : An instance of Choice + """ + + if email_cloud_picker is not None and not isinstance(email_cloud_picker, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_cloud_picker EXPECTED TYPE: Choice', None, None) + + self.__email_cloud_picker = email_cloud_picker + self.__key_modified['EMAIL_CLOUD_PICKER'] = 1 + + def get_form_integration_enabled(self): + """ + The method to get the form_integration_enabled + + Returns: + Choice: An instance of Choice + """ + + return self.__form_integration_enabled + + def set_form_integration_enabled(self, form_integration_enabled): + """ + The method to set the value to form_integration_enabled + + Parameters: + form_integration_enabled (Choice) : An instance of Choice + """ + + if form_integration_enabled is not None and not isinstance(form_integration_enabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_integration_enabled EXPECTED TYPE: Choice', None, None) + + self.__form_integration_enabled = form_integration_enabled + self.__key_modified['form_integration_enabled'] = 1 + + def get_isprivacyenabled(self): + """ + The method to get the isprivacyenabled + + Returns: + Choice: An instance of Choice + """ + + return self.__isprivacyenabled + + def set_isprivacyenabled(self, isprivacyenabled): + """ + The method to set the value to isprivacyenabled + + Parameters: + isprivacyenabled (Choice) : An instance of Choice + """ + + if isprivacyenabled is not None and not isinstance(isprivacyenabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isprivacyenabled EXPECTED TYPE: Choice', None, None) + + self.__isprivacyenabled = isprivacyenabled + self.__key_modified['isPrivacyEnabled'] = 1 + + def get_auto_suggestion(self): + """ + The method to get the auto_suggestion + + Returns: + Choice: An instance of Choice + """ + + return self.__auto_suggestion + + def set_auto_suggestion(self, auto_suggestion): + """ + The method to set the value to auto_suggestion + + Parameters: + auto_suggestion (Choice) : An instance of Choice + """ + + if auto_suggestion is not None and not isinstance(auto_suggestion, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_suggestion EXPECTED TYPE: Choice', None, None) + + self.__auto_suggestion = auto_suggestion + self.__key_modified['auto_suggestion'] = 1 + + def get_unsubscribe_link(self): + """ + The method to get the unsubscribe_link + + Returns: + Choice: An instance of Choice + """ + + return self.__unsubscribe_link + + def set_unsubscribe_link(self, unsubscribe_link): + """ + The method to set the value to unsubscribe_link + + Parameters: + unsubscribe_link (Choice) : An instance of Choice + """ + + if unsubscribe_link is not None and not isinstance(unsubscribe_link, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_link EXPECTED TYPE: Choice', None, None) + + self.__unsubscribe_link = unsubscribe_link + self.__key_modified['UNSUBSCRIBE_LINK'] = 1 + + def get_best_time_to_contact(self): + """ + The method to get the best_time_to_contact + + Returns: + Choice: An instance of Choice + """ + + return self.__best_time_to_contact + + def set_best_time_to_contact(self, best_time_to_contact): + """ + The method to set the value to best_time_to_contact + + Parameters: + best_time_to_contact (Choice) : An instance of Choice + """ + + if best_time_to_contact is not None and not isinstance(best_time_to_contact, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: best_time_to_contact EXPECTED TYPE: Choice', None, None) + + self.__best_time_to_contact = best_time_to_contact + self.__key_modified['best_time_to_contact'] = 1 + + def get_attach_teamdrive(self): + """ + The method to get the attach_teamdrive + + Returns: + Choice: An instance of Choice + """ + + return self.__attach_teamdrive + + def set_attach_teamdrive(self, attach_teamdrive): + """ + The method to set the value to attach_teamdrive + + Parameters: + attach_teamdrive (Choice) : An instance of Choice + """ + + if attach_teamdrive is not None and not isinstance(attach_teamdrive, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attach_teamdrive EXPECTED TYPE: Choice', None, None) + + self.__attach_teamdrive = attach_teamdrive + self.__key_modified['attach_teamdrive'] = 1 + + def get_islivedeskenabled(self): + """ + The method to get the islivedeskenabled + + Returns: + Choice: An instance of Choice + """ + + return self.__islivedeskenabled + + def set_islivedeskenabled(self, islivedeskenabled): + """ + The method to set the value to islivedeskenabled + + Parameters: + islivedeskenabled (Choice) : An instance of Choice + """ + + if islivedeskenabled is not None and not isinstance(islivedeskenabled, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: islivedeskenabled EXPECTED TYPE: Choice', None, None) + + self.__islivedeskenabled = islivedeskenabled + self.__key_modified['isLiveDeskEnabled'] = 1 + + def get_subject_line_suggestion(self): + """ + The method to get the subject_line_suggestion + + Returns: + bool: A bool representing the subject_line_suggestion + """ + + return self.__subject_line_suggestion + + def set_subject_line_suggestion(self, subject_line_suggestion): + """ + The method to set the value to subject_line_suggestion + + Parameters: + subject_line_suggestion (bool) : A bool representing the subject_line_suggestion + """ + + if subject_line_suggestion is not None and not isinstance(subject_line_suggestion, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject_line_suggestion EXPECTED TYPE: bool', None, None) + + self.__subject_line_suggestion = subject_line_suggestion + self.__key_modified['subject_line_suggestion'] = 1 + + def get_email_preference(self): + """ + The method to get the email_preference + + Returns: + bool: A bool representing the email_preference + """ + + return self.__email_preference + + def set_email_preference(self, email_preference): + """ + The method to set the value to email_preference + + Parameters: + email_preference (bool) : A bool representing the email_preference + """ + + if email_preference is not None and not isinstance(email_preference, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_preference EXPECTED TYPE: bool', None, None) + + self.__email_preference = email_preference + self.__key_modified['EMAIL_PREFERENCE'] = 1 + + def get_attachment(self): + """ + The method to get the attachment + + Returns: + bool: A bool representing the attachment + """ + + return self.__attachment + + def set_attachment(self, attachment): + """ + The method to set the value to attachment + + Parameters: + attachment (bool) : A bool representing the attachment + """ + + if attachment is not None and not isinstance(attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment EXPECTED TYPE: bool', None, None) + + self.__attachment = attachment + self.__key_modified['ATTACHMENT'] = 1 + + def get_mandateunsublink(self): + """ + The method to get the mandateunsublink + + Returns: + bool: A bool representing the mandateunsublink + """ + + return self.__mandateunsublink + + def set_mandateunsublink(self, mandateunsublink): + """ + The method to set the value to mandateunsublink + + Parameters: + mandateunsublink (bool) : A bool representing the mandateunsublink + """ + + if mandateunsublink is not None and not isinstance(mandateunsublink, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mandateunsublink EXPECTED TYPE: bool', None, None) + + self.__mandateunsublink = mandateunsublink + self.__key_modified['mandateUnsubLink'] = 1 + + def get_old_compose_revert(self): + """ + The method to get the old_compose_revert + + Returns: + bool: A bool representing the old_compose_revert + """ + + return self.__old_compose_revert + + def set_old_compose_revert(self, old_compose_revert): + """ + The method to set the value to old_compose_revert + + Parameters: + old_compose_revert (bool) : A bool representing the old_compose_revert + """ + + if old_compose_revert is not None and not isinstance(old_compose_revert, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: old_compose_revert EXPECTED TYPE: bool', None, None) + + self.__old_compose_revert = old_compose_revert + self.__key_modified['OLD_COMPOSE_REVERT'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/from_address.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/from_address.py new file mode 100644 index 0000000..7e068e1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/from_address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class FromAddress(object): + def __init__(self): + """Creates an instance of FromAddress""" + + self.__user_name = None + self.__type = None + self.__email = None + self.__id = None + self.__default = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + Choice: An instance of Choice + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (Choice) : An instance of Choice + """ + + if default is not None and not isinstance(default, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: Choice', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/signature.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/signature.py new file mode 100644 index 0000000..96f9877 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/signature.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Signature(object): + def __init__(self): + """Creates an instance of Signature""" + + self.__mode = None + self.__sign = None + self.__key_modified = dict() + + def get_mode(self): + """ + The method to get the mode + + Returns: + int: An int representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (int) : An int representing the mode + """ + + if mode is not None and not isinstance(mode, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: int', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_sign(self): + """ + The method to get the sign + + Returns: + string: A string representing the sign + """ + + return self.__sign + + def set_sign(self, sign): + """ + The method to set the value to sign + + Parameters: + sign (string) : A string representing the sign + """ + + if sign is not None and not isinstance(sign, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign EXPECTED TYPE: str', None, None) + + self.__sign = sign + self.__key_modified['sign'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/user.py b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/user.py new file mode 100644 index 0000000..11289ec --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_compose_meta/user.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__full_name = None + self.__email = None + self.__zuid = None + self.__zgid = None + self.__signature = None + self.__key_modified = dict() + + def get_full_name(self): + """ + The method to get the full_name + + Returns: + string: A string representing the full_name + """ + + return self.__full_name + + def set_full_name(self, full_name): + """ + The method to set the value to full_name + + Parameters: + full_name (string) : A string representing the full_name + """ + + if full_name is not None and not isinstance(full_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: full_name EXPECTED TYPE: str', None, None) + + self.__full_name = full_name + self.__key_modified['full_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def get_zgid(self): + """ + The method to get the zgid + + Returns: + string: A string representing the zgid + """ + + return self.__zgid + + def set_zgid(self, zgid): + """ + The method to set the value to zgid + + Parameters: + zgid (string) : A string representing the zgid + """ + + if zgid is not None and not isinstance(zgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zgid EXPECTED TYPE: str', None, None) + + self.__zgid = zgid + self.__key_modified['zgid'] = 1 + + def get_signature(self): + """ + The method to get the signature + + Returns: + Signature: An instance of Signature + """ + + return self.__signature + + def set_signature(self, signature): + """ + The method to set the value to signature + + Parameters: + signature (Signature) : An instance of Signature + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.signature import Signature + except Exception: + from .signature import Signature + + if signature is not None and not isinstance(signature, Signature): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signature EXPECTED TYPE: Signature', None, None) + + self.__signature = signature + self.__key_modified['signature'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/__init__.py new file mode 100644 index 0000000..c0a31b2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/__init__.py @@ -0,0 +1,13 @@ +from .template import Template +from .action_wrapper import ActionWrapper +from .schedule_details import ScheduleDetails +from .attachments import Attachments +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .email_drafts import EmailDrafts +from .inventory_details import InventoryDetails +from .response_wrapper import ResponseWrapper +from .to import To +from .inventory_template import InventoryTemplate diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_wrapper.py new file mode 100644 index 0000000..8c78729 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__emaildrafts = None + self.__key_modified = dict() + + def get_emaildrafts(self): + """ + The method to get the emaildrafts + + Returns: + list: An instance of list + """ + + return self.__emaildrafts + + def set_emaildrafts(self, emaildrafts): + """ + The method to set the value to emaildrafts + + Parameters: + emaildrafts (list) : An instance of list + """ + + if emaildrafts is not None and not isinstance(emaildrafts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emaildrafts EXPECTED TYPE: list', None, None) + + self.__emaildrafts = emaildrafts + self.__key_modified['__email_drafts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/api_exception.py new file mode 100644 index 0000000..5b34510 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class APIException(ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/attachments.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/attachments.py new file mode 100644 index 0000000..9979bce --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/attachments.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachments(object): + def __init__(self): + """Creates an instance of Attachments""" + + self.__service_name = None + self.__file_size = None + self.__id = None + self.__file_name = None + self.__key_modified = dict() + + def get_service_name(self): + """ + The method to get the service_name + + Returns: + string: A string representing the service_name + """ + + return self.__service_name + + def set_service_name(self, service_name): + """ + The method to set the value to service_name + + Parameters: + service_name (string) : A string representing the service_name + """ + + if service_name is not None and not isinstance(service_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_name EXPECTED TYPE: str', None, None) + + self.__service_name = service_name + self.__key_modified['service_name'] = 1 + + def get_file_size(self): + """ + The method to get the file_size + + Returns: + string: A string representing the file_size + """ + + return self.__file_size + + def set_file_size(self, file_size): + """ + The method to set the value to file_size + + Parameters: + file_size (string) : A string representing the file_size + """ + + if file_size is not None and not isinstance(file_size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_size EXPECTED TYPE: str', None, None) + + self.__file_size = file_size + self.__key_modified['file_size'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/body_wrapper.py new file mode 100644 index 0000000..3d1b65f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__emaildrafts = None + self.__key_modified = dict() + + def get_emaildrafts(self): + """ + The method to get the emaildrafts + + Returns: + list: An instance of list + """ + + return self.__emaildrafts + + def set_emaildrafts(self, emaildrafts): + """ + The method to set the value to emaildrafts + + Parameters: + emaildrafts (list) : An instance of list + """ + + if emaildrafts is not None and not isinstance(emaildrafts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emaildrafts EXPECTED TYPE: list', None, None) + + self.__emaildrafts = emaildrafts + self.__key_modified['__email_drafts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/email_drafts.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/email_drafts.py new file mode 100644 index 0000000..a9edb5e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/email_drafts.py @@ -0,0 +1,493 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailDrafts(object): + def __init__(self): + """Creates an instance of EmailDrafts""" + + self.__id = None + self.__modified_time = None + self.__created_time = None + self.__from_1 = None + self.__to = None + self.__reply_to = None + self.__cc = None + self.__bcc = None + self.__template = None + self.__inventory_details = None + self.__attachments = None + self.__schedule_details = None + self.__rich_text = None + self.__email_opt_out = None + self.__subject = None + self.__content = None + self.__summary = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_from(self): + """ + The method to get the from + + Returns: + string: A string representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (string) : A string representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: str', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_reply_to(self): + """ + The method to get the reply_to + + Returns: + string: A string representing the reply_to + """ + + return self.__reply_to + + def set_reply_to(self, reply_to): + """ + The method to set the value to reply_to + + Parameters: + reply_to (string) : A string representing the reply_to + """ + + if reply_to is not None and not isinstance(reply_to, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reply_to EXPECTED TYPE: str', None, None) + + self.__reply_to = reply_to + self.__key_modified['reply_to'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_bcc(self): + """ + The method to get the bcc + + Returns: + list: An instance of list + """ + + return self.__bcc + + def set_bcc(self, bcc): + """ + The method to set the value to bcc + + Parameters: + bcc (list) : An instance of list + """ + + if bcc is not None and not isinstance(bcc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc EXPECTED TYPE: list', None, None) + + self.__bcc = bcc + self.__key_modified['bcc'] = 1 + + def get_template(self): + """ + The method to get the template + + Returns: + Template: An instance of Template + """ + + return self.__template + + def set_template(self, template): + """ + The method to set the value to template + + Parameters: + template (Template) : An instance of Template + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.template import Template + except Exception: + from .template import Template + + if template is not None and not isinstance(template, Template): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: Template', None, None) + + self.__template = template + self.__key_modified['template'] = 1 + + def get_inventory_details(self): + """ + The method to get the inventory_details + + Returns: + InventoryDetails: An instance of InventoryDetails + """ + + return self.__inventory_details + + def set_inventory_details(self, inventory_details): + """ + The method to set the value to inventory_details + + Parameters: + inventory_details (InventoryDetails) : An instance of InventoryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.inventory_details import InventoryDetails + except Exception: + from .inventory_details import InventoryDetails + + if inventory_details is not None and not isinstance(inventory_details, InventoryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_details EXPECTED TYPE: InventoryDetails', None, None) + + self.__inventory_details = inventory_details + self.__key_modified['inventory_details'] = 1 + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_schedule_details(self): + """ + The method to get the schedule_details + + Returns: + ScheduleDetails: An instance of ScheduleDetails + """ + + return self.__schedule_details + + def set_schedule_details(self, schedule_details): + """ + The method to set the value to schedule_details + + Parameters: + schedule_details (ScheduleDetails) : An instance of ScheduleDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.schedule_details import ScheduleDetails + except Exception: + from .schedule_details import ScheduleDetails + + if schedule_details is not None and not isinstance(schedule_details, ScheduleDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: schedule_details EXPECTED TYPE: ScheduleDetails', None, None) + + self.__schedule_details = schedule_details + self.__key_modified['schedule_details'] = 1 + + def get_rich_text(self): + """ + The method to get the rich_text + + Returns: + bool: A bool representing the rich_text + """ + + return self.__rich_text + + def set_rich_text(self, rich_text): + """ + The method to set the value to rich_text + + Parameters: + rich_text (bool) : A bool representing the rich_text + """ + + if rich_text is not None and not isinstance(rich_text, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rich_text EXPECTED TYPE: bool', None, None) + + self.__rich_text = rich_text + self.__key_modified['rich_text'] = 1 + + def get_email_opt_out(self): + """ + The method to get the email_opt_out + + Returns: + bool: A bool representing the email_opt_out + """ + + return self.__email_opt_out + + def set_email_opt_out(self, email_opt_out): + """ + The method to set the value to email_opt_out + + Parameters: + email_opt_out (bool) : A bool representing the email_opt_out + """ + + if email_opt_out is not None and not isinstance(email_opt_out, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_opt_out EXPECTED TYPE: bool', None, None) + + self.__email_opt_out = email_opt_out + self.__key_modified['email_opt_out'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_summary(self): + """ + The method to get the summary + + Returns: + string: A string representing the summary + """ + + return self.__summary + + def set_summary(self, summary): + """ + The method to set the value to summary + + Parameters: + summary (string) : A string representing the summary + """ + + if summary is not None and not isinstance(summary, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: summary EXPECTED TYPE: str', None, None) + + self.__summary = summary + self.__key_modified['summary'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_details.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_details.py new file mode 100644 index 0000000..03f57f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_details.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryDetails(object): + def __init__(self): + """Creates an instance of InventoryDetails""" + + self.__inventory_template = None + self.__record = None + self.__paper_type = None + self.__view_type = None + self.__key_modified = dict() + + def get_inventory_template(self): + """ + The method to get the inventory_template + + Returns: + InventoryTemplate: An instance of InventoryTemplate + """ + + return self.__inventory_template + + def set_inventory_template(self, inventory_template): + """ + The method to set the value to inventory_template + + Parameters: + inventory_template (InventoryTemplate) : An instance of InventoryTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.inventory_template import InventoryTemplate + except Exception: + from .inventory_template import InventoryTemplate + + if inventory_template is not None and not isinstance(inventory_template, InventoryTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_template EXPECTED TYPE: InventoryTemplate', None, None) + + self.__inventory_template = inventory_template + self.__key_modified['inventory_template'] = 1 + + def get_record(self): + """ + The method to get the record + + Returns: + Record: An instance of Record + """ + + return self.__record + + def set_record(self, record): + """ + The method to set the value to record + + Parameters: + record (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if record is not None and not isinstance(record, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: Record', None, None) + + self.__record = record + self.__key_modified['record'] = 1 + + def get_paper_type(self): + """ + The method to get the paper_type + + Returns: + string: A string representing the paper_type + """ + + return self.__paper_type + + def set_paper_type(self, paper_type): + """ + The method to set the value to paper_type + + Parameters: + paper_type (string) : A string representing the paper_type + """ + + if paper_type is not None and not isinstance(paper_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paper_type EXPECTED TYPE: str', None, None) + + self.__paper_type = paper_type + self.__key_modified['paper_type'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + string: A string representing the view_type + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (string) : A string representing the view_type + """ + + if view_type is not None and not isinstance(view_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: str', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_template.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_template.py new file mode 100644 index 0000000..e8124fb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/inventory_template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryTemplate(object): + def __init__(self): + """Creates an instance of InventoryTemplate""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/response_wrapper.py new file mode 100644 index 0000000..3774947 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__emaildrafts = None + self.__key_modified = dict() + + def get_emaildrafts(self): + """ + The method to get the emaildrafts + + Returns: + list: An instance of list + """ + + return self.__emaildrafts + + def set_emaildrafts(self, emaildrafts): + """ + The method to set the value to emaildrafts + + Parameters: + emaildrafts (list) : An instance of list + """ + + if emaildrafts is not None and not isinstance(emaildrafts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emaildrafts EXPECTED TYPE: list', None, None) + + self.__emaildrafts = emaildrafts + self.__key_modified['__email_drafts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/schedule_details.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/schedule_details.py new file mode 100644 index 0000000..1765ce3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/schedule_details.py @@ -0,0 +1,123 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScheduleDetails(object): + def __init__(self): + """Creates an instance of ScheduleDetails""" + + self.__time = None + self.__timezone = None + self.__source = None + self.__key_modified = dict() + + def get_time(self): + """ + The method to get the time + + Returns: + datetime: An instance of datetime + """ + + return self.__time + + def set_time(self, time): + """ + The method to set the value to time + + Parameters: + time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if time is not None and not isinstance(time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time EXPECTED TYPE: datetime', None, None) + + self.__time = time + self.__key_modified['time'] = 1 + + def get_timezone(self): + """ + The method to get the timezone + + Returns: + string: An instance of string + """ + + return self.__timezone + + def set_timezone(self, timezone): + """ + The method to set the value to timezone + + Parameters: + timezone (string) : An instance of string + """ + + self.__timezone = timezone + self.__key_modified['timezone'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/success_response.py new file mode 100644 index 0000000..3c4cdca --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_drafts.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/template.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/template.py new file mode 100644 index 0000000..5310677 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Template(object): + def __init__(self): + """Creates an instance of Template""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_drafts/to.py b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/to.py new file mode 100644 index 0000000..dbe309e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_drafts/to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class To(object): + def __init__(self): + """Creates an instance of To""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/__init__.py new file mode 100644 index 0000000..ae0a2d3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/__init__.py @@ -0,0 +1,13 @@ +from .attachments import Attachments +from .user_details import UserDetails +from .criteria import Criteria +from .module import Module +from .email_related_records_operations import EmailRelatedRecordsOperations, GetEmailsRelatedRecordsParam, GetEmailsRelatedRecordParam +from .linked_record import LinkedRecord +from .api_exception import APIException +from .response_handler import ResponseHandler +from .field import Field +from .response_wrapper import ResponseWrapper +from .email import Email +from .info import Info +from .status import Status diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/api_exception.py new file mode 100644 index 0000000..192d6c7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/attachments.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/attachments.py new file mode 100644 index 0000000..8332cb3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/attachments.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachments(object): + def __init__(self): + """Creates an instance of Attachments""" + + self.__size = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_size(self): + """ + The method to get the size + + Returns: + string: A string representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (string) : A string representing the size + """ + + if size is not None and not isinstance(size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: str', None, None) + + self.__size = size + self.__key_modified['size'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/criteria.py new file mode 100644 index 0000000..a7a855e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/criteria.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + Choice: An instance of Choice + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (Choice) : An instance of Choice + """ + + if comparator is not None and not isinstance(comparator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Choice', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email.py new file mode 100644 index 0000000..7337825 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email.py @@ -0,0 +1,718 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Email(object): + def __init__(self): + """Creates an instance of Email""" + + self.__attachments = None + self.__thread_id = None + self.__cc = None + self.__summary = None + self.__owner = None + self.__read = None + self.__content = None + self.__sent = None + self.__subject = None + self.__activity_info = None + self.__intent = None + self.__sentiment_info = None + self.__message_id = None + self.__source = None + self.__linked_record = None + self.__sent_time = None + self.__emotion = None + self.__from_1 = None + self.__to = None + self.__time = None + self.__status = None + self.__has_attachment = None + self.__has_thread_attachment = None + self.__editable = None + self.__mail_format = None + self.__reply_to = None + self.__key_modified = dict() + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_thread_id(self): + """ + The method to get the thread_id + + Returns: + int: An int representing the thread_id + """ + + return self.__thread_id + + def set_thread_id(self, thread_id): + """ + The method to set the value to thread_id + + Parameters: + thread_id (int) : An int representing the thread_id + """ + + if thread_id is not None and not isinstance(thread_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: thread_id EXPECTED TYPE: int', None, None) + + self.__thread_id = thread_id + self.__key_modified['thread_id'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_summary(self): + """ + The method to get the summary + + Returns: + string: A string representing the summary + """ + + return self.__summary + + def set_summary(self, summary): + """ + The method to set the value to summary + + Parameters: + summary (string) : A string representing the summary + """ + + if summary is not None and not isinstance(summary, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: summary EXPECTED TYPE: str', None, None) + + self.__summary = summary + self.__key_modified['summary'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_read(self): + """ + The method to get the read + + Returns: + bool: A bool representing the read + """ + + return self.__read + + def set_read(self, read): + """ + The method to set the value to read + + Parameters: + read (bool) : A bool representing the read + """ + + if read is not None and not isinstance(read, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read EXPECTED TYPE: bool', None, None) + + self.__read = read + self.__key_modified['read'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_sent(self): + """ + The method to get the sent + + Returns: + bool: A bool representing the sent + """ + + return self.__sent + + def set_sent(self, sent): + """ + The method to set the value to sent + + Parameters: + sent (bool) : A bool representing the sent + """ + + if sent is not None and not isinstance(sent, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent EXPECTED TYPE: bool', None, None) + + self.__sent = sent + self.__key_modified['sent'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_activity_info(self): + """ + The method to get the activity_info + + Returns: + Object: A Object representing the activity_info + """ + + return self.__activity_info + + def set_activity_info(self, activity_info): + """ + The method to set the value to activity_info + + Parameters: + activity_info (Object) : A Object representing the activity_info + """ + + self.__activity_info = activity_info + self.__key_modified['activity_info'] = 1 + + def get_intent(self): + """ + The method to get the intent + + Returns: + Choice: An instance of Choice + """ + + return self.__intent + + def set_intent(self, intent): + """ + The method to set the value to intent + + Parameters: + intent (Choice) : An instance of Choice + """ + + if intent is not None and not isinstance(intent, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: intent EXPECTED TYPE: Choice', None, None) + + self.__intent = intent + self.__key_modified['intent'] = 1 + + def get_sentiment_info(self): + """ + The method to get the sentiment_info + + Returns: + Choice: An instance of Choice + """ + + return self.__sentiment_info + + def set_sentiment_info(self, sentiment_info): + """ + The method to set the value to sentiment_info + + Parameters: + sentiment_info (Choice) : An instance of Choice + """ + + if sentiment_info is not None and not isinstance(sentiment_info, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sentiment_info EXPECTED TYPE: Choice', None, None) + + self.__sentiment_info = sentiment_info + self.__key_modified['sentiment_info'] = 1 + + def get_message_id(self): + """ + The method to get the message_id + + Returns: + string: A string representing the message_id + """ + + return self.__message_id + + def set_message_id(self, message_id): + """ + The method to set the value to message_id + + Parameters: + message_id (string) : A string representing the message_id + """ + + if message_id is not None and not isinstance(message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message_id EXPECTED TYPE: str', None, None) + + self.__message_id = message_id + self.__key_modified['message_id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def get_sent_time(self): + """ + The method to get the sent_time + + Returns: + string: A string representing the sent_time + """ + + return self.__sent_time + + def set_sent_time(self, sent_time): + """ + The method to set the value to sent_time + + Parameters: + sent_time (string) : A string representing the sent_time + """ + + if sent_time is not None and not isinstance(sent_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent_time EXPECTED TYPE: str', None, None) + + self.__sent_time = sent_time + self.__key_modified['sent_time'] = 1 + + def get_emotion(self): + """ + The method to get the emotion + + Returns: + string: A string representing the emotion + """ + + return self.__emotion + + def set_emotion(self, emotion): + """ + The method to set the value to emotion + + Parameters: + emotion (string) : A string representing the emotion + """ + + if emotion is not None and not isinstance(emotion, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emotion EXPECTED TYPE: str', None, None) + + self.__emotion = emotion + self.__key_modified['emotion'] = 1 + + def get_from(self): + """ + The method to get the from + + Returns: + UserDetails: An instance of UserDetails + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (UserDetails) : An instance of UserDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.user_details import UserDetails + except Exception: + from .user_details import UserDetails + + if from_1 is not None and not isinstance(from_1, UserDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: UserDetails', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_time(self): + """ + The method to get the time + + Returns: + datetime: An instance of datetime + """ + + return self.__time + + def set_time(self, time): + """ + The method to set the value to time + + Parameters: + time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if time is not None and not isinstance(time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time EXPECTED TYPE: datetime', None, None) + + self.__time = time + self.__key_modified['time'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + list: An instance of list + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (list) : An instance of list + """ + + if status is not None and not isinstance(status, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: list', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_has_attachment(self): + """ + The method to get the has_attachment + + Returns: + bool: A bool representing the has_attachment + """ + + return self.__has_attachment + + def set_has_attachment(self, has_attachment): + """ + The method to set the value to has_attachment + + Parameters: + has_attachment (bool) : A bool representing the has_attachment + """ + + if has_attachment is not None and not isinstance(has_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_attachment EXPECTED TYPE: bool', None, None) + + self.__has_attachment = has_attachment + self.__key_modified['has_attachment'] = 1 + + def get_has_thread_attachment(self): + """ + The method to get the has_thread_attachment + + Returns: + bool: A bool representing the has_thread_attachment + """ + + return self.__has_thread_attachment + + def set_has_thread_attachment(self, has_thread_attachment): + """ + The method to set the value to has_thread_attachment + + Parameters: + has_thread_attachment (bool) : A bool representing the has_thread_attachment + """ + + if has_thread_attachment is not None and not isinstance(has_thread_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_thread_attachment EXPECTED TYPE: bool', None, None) + + self.__has_thread_attachment = has_thread_attachment + self.__key_modified['has_thread_attachment'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['editable'] = 1 + + def get_mail_format(self): + """ + The method to get the mail_format + + Returns: + string: A string representing the mail_format + """ + + return self.__mail_format + + def set_mail_format(self, mail_format): + """ + The method to set the value to mail_format + + Parameters: + mail_format (string) : A string representing the mail_format + """ + + if mail_format is not None and not isinstance(mail_format, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_format EXPECTED TYPE: str', None, None) + + self.__mail_format = mail_format + self.__key_modified['mail_format'] = 1 + + def get_reply_to(self): + """ + The method to get the reply_to + + Returns: + UserDetails: An instance of UserDetails + """ + + return self.__reply_to + + def set_reply_to(self, reply_to): + """ + The method to set the value to reply_to + + Parameters: + reply_to (UserDetails) : An instance of UserDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.user_details import UserDetails + except Exception: + from .user_details import UserDetails + + if reply_to is not None and not isinstance(reply_to, UserDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reply_to EXPECTED TYPE: UserDetails', None, None) + + self.__reply_to = reply_to + self.__key_modified['reply_to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email_related_records_operations.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email_related_records_operations.py new file mode 100644 index 0000000..fbfe72f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/email_related_records_operations.py @@ -0,0 +1,125 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class EmailRelatedRecordsOperations(object): + def __init__(self, record_id, module_name, type=None, owner_id=None): + """ + Creates an instance of EmailRelatedRecordsOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module_name (string) : A string representing the module_name + type (string) : A string representing the type + owner_id (int) : An int representing the owner_id + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + if owner_id is not None and not isinstance(owner_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner_id EXPECTED TYPE: int', None, None) + + self.__record_id = record_id + self.__module_name = module_name + self.__type = type + self.__owner_id = owner_id + + + def get_emails_related_records(self, param_instance=None): + """ + The method to get emails related records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Emails' + 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('type', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam'), self.__type) + handler_instance.add_param(Param('owner_id', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam'), self.__owner_id) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_emails_related_record(self, message_id): + """ + The method to get emails related record + + Parameters: + message_id (string) : A string representing the message_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Emails/' + api_path = api_path + str(message_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('type', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordParam'), self.__type) + handler_instance.add_param(Param('owner_id', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordParam'), self.__owner_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetEmailsRelatedRecordsParam(object): + filter = Param('filter', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam') + index = Param('index', 'com.zoho.crm.api.EmailRelatedRecords.GetEmailsRelatedRecordsParam') + + +class GetEmailsRelatedRecordParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/field.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/field.py new file mode 100644 index 0000000..0ad50d5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/field.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/info.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/info.py new file mode 100644 index 0000000..18ef1f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/info.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__next_index = None + self.__prev_index = None + self.__per_page = None + self.__more_records = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_next_index(self): + """ + The method to get the next_index + + Returns: + string: A string representing the next_index + """ + + return self.__next_index + + def set_next_index(self, next_index): + """ + The method to set the value to next_index + + Parameters: + next_index (string) : A string representing the next_index + """ + + if next_index is not None and not isinstance(next_index, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_index EXPECTED TYPE: str', None, None) + + self.__next_index = next_index + self.__key_modified['next_index'] = 1 + + def get_prev_index(self): + """ + The method to get the prev_index + + Returns: + string: A string representing the prev_index + """ + + return self.__prev_index + + def set_prev_index(self, prev_index): + """ + The method to set the value to prev_index + + Parameters: + prev_index (string) : A string representing the prev_index + """ + + if prev_index is not None and not isinstance(prev_index, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prev_index EXPECTED TYPE: str', None, None) + + self.__prev_index = prev_index + self.__key_modified['prev_index'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/linked_record.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/linked_record.py new file mode 100644 index 0000000..bc620d4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/linked_record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedRecord(object): + def __init__(self): + """Creates an instance of LinkedRecord""" + + self.__id = None + self.__name = None + self.__module = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/module.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_wrapper.py new file mode 100644 index 0000000..18505db --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__emails = None + self.__info = None + self.__key_modified = dict() + + def get_emails(self): + """ + The method to get the emails + + Returns: + list: An instance of list + """ + + return self.__emails + + def set_emails(self, emails): + """ + The method to set the value to emails + + Parameters: + emails (list) : An instance of list + """ + + if emails is not None and not isinstance(emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emails EXPECTED TYPE: list', None, None) + + self.__emails = emails + self.__key_modified['Emails'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_related_records.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/status.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/status.py new file mode 100644 index 0000000..4b08153 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/status.py @@ -0,0 +1,255 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__first_open = None + self.__count = None + self.__type = None + self.__last_open = None + self.__bounced_time = None + self.__bounced_reason = None + self.__category = None + self.__sub_category = None + self.__key_modified = dict() + + def get_first_open(self): + """ + The method to get the first_open + + Returns: + datetime: An instance of datetime + """ + + return self.__first_open + + def set_first_open(self, first_open): + """ + The method to set the value to first_open + + Parameters: + first_open (datetime) : An instance of datetime + """ + + from datetime import datetime + + if first_open is not None and not isinstance(first_open, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_open EXPECTED TYPE: datetime', None, None) + + self.__first_open = first_open + self.__key_modified['first_open'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + string: A string representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (string) : A string representing the count + """ + + if count is not None and not isinstance(count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: str', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_last_open(self): + """ + The method to get the last_open + + Returns: + datetime: An instance of datetime + """ + + return self.__last_open + + def set_last_open(self, last_open): + """ + The method to set the value to last_open + + Parameters: + last_open (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_open is not None and not isinstance(last_open, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_open EXPECTED TYPE: datetime', None, None) + + self.__last_open = last_open + self.__key_modified['last_open'] = 1 + + def get_bounced_time(self): + """ + The method to get the bounced_time + + Returns: + datetime: An instance of datetime + """ + + return self.__bounced_time + + def set_bounced_time(self, bounced_time): + """ + The method to set the value to bounced_time + + Parameters: + bounced_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if bounced_time is not None and not isinstance(bounced_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced_time EXPECTED TYPE: datetime', None, None) + + self.__bounced_time = bounced_time + self.__key_modified['bounced_time'] = 1 + + def get_bounced_reason(self): + """ + The method to get the bounced_reason + + Returns: + string: A string representing the bounced_reason + """ + + return self.__bounced_reason + + def set_bounced_reason(self, bounced_reason): + """ + The method to set the value to bounced_reason + + Parameters: + bounced_reason (string) : A string representing the bounced_reason + """ + + if bounced_reason is not None and not isinstance(bounced_reason, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced_reason EXPECTED TYPE: str', None, None) + + self.__bounced_reason = bounced_reason + self.__key_modified['bounced_reason'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_sub_category(self): + """ + The method to get the sub_category + + Returns: + string: A string representing the sub_category + """ + + return self.__sub_category + + def set_sub_category(self, sub_category): + """ + The method to set the value to sub_category + + Parameters: + sub_category (string) : A string representing the sub_category + """ + + if sub_category is not None and not isinstance(sub_category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_category EXPECTED TYPE: str', None, None) + + self.__sub_category = sub_category + self.__key_modified['sub_category'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_related_records/user_details.py b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/user_details.py new file mode 100644 index 0000000..839c8d0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_related_records/user_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UserDetails(object): + def __init__(self): + """Creates an instance of UserDetails""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/__init__.py new file mode 100644 index 0000000..54b0ea7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .email_sharing_details_operations import EmailSharingDetailsOperations +from .share_from_user import ShareFromUser +from .response_wrapper import ResponseWrapper +from .email_sharings import EmailSharings diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/api_exception.py new file mode 100644 index 0000000..f343c9c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharing_details_operations.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharing_details_operations.py new file mode 100644 index 0000000..c30ecaf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharing_details_operations.py @@ -0,0 +1,54 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class EmailSharingDetailsOperations(object): + def __init__(self, record_id, module): + """ + Creates an instance of EmailSharingDetailsOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module (string) : A string representing the module + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module = module + + + def get_email_sharing_details(self): + """ + The method to get email sharing details + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/__emails_sharing_details' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharings.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharings.py new file mode 100644 index 0000000..cc3f69b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/email_sharings.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailSharings(object): + def __init__(self): + """Creates an instance of EmailSharings""" + + self.__share_from_users = None + self.__available_types = None + self.__key_modified = dict() + + def get_share_from_users(self): + """ + The method to get the share_from_users + + Returns: + list: An instance of list + """ + + return self.__share_from_users + + def set_share_from_users(self, share_from_users): + """ + The method to set the value to share_from_users + + Parameters: + share_from_users (list) : An instance of list + """ + + if share_from_users is not None and not isinstance(share_from_users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_from_users EXPECTED TYPE: list', None, None) + + self.__share_from_users = share_from_users + self.__key_modified['share_from_users'] = 1 + + def get_available_types(self): + """ + The method to get the available_types + + Returns: + list: An instance of list + """ + + return self.__available_types + + def set_available_types(self, available_types): + """ + The method to set the value to available_types + + Parameters: + available_types (list) : An instance of list + """ + + if available_types is not None and not isinstance(available_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_types EXPECTED TYPE: list', None, None) + + self.__available_types = available_types + self.__key_modified['available_types'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_wrapper.py new file mode 100644 index 0000000..0c10171 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__emailssharingdetails = None + self.__key_modified = dict() + + def get_emailssharingdetails(self): + """ + The method to get the emailssharingdetails + + Returns: + list: An instance of list + """ + + return self.__emailssharingdetails + + def set_emailssharingdetails(self, emailssharingdetails): + """ + The method to set the value to emailssharingdetails + + Parameters: + emailssharingdetails (list) : An instance of list + """ + + if emailssharingdetails is not None and not isinstance(emailssharingdetails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emailssharingdetails EXPECTED TYPE: list', None, None) + + self.__emailssharingdetails = emailssharingdetails + self.__key_modified['__emails_sharing_details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/share_from_user.py b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/share_from_user.py new file mode 100644 index 0000000..37ad1bb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_sharing_details/share_from_user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShareFromUser(object): + def __init__(self): + """Creates an instance of ShareFromUser""" + + self.__name = None + self.__type = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['_type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/__init__.py new file mode 100644 index 0000000..46a5983 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/__init__.py @@ -0,0 +1,8 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .attachment import Attachment +from .email_templates_operations import EmailTemplatesOperations, GetEmailTemplatesParam +from .response_wrapper import ResponseWrapper +from .last_version_statistics import LastVersionStatistics +from .email_template import EmailTemplate +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/api_exception.py new file mode 100644 index 0000000..d22e630 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/attachment.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/attachment.py new file mode 100644 index 0000000..f6a4a11 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/attachment.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachment(object): + def __init__(self): + """Creates an instance of Attachment""" + + self.__size = None + self.__file_name = None + self.__file_id = None + self.__id = None + self.__key_modified = dict() + + def get_size(self): + """ + The method to get the size + + Returns: + int: An int representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (int) : An int representing the size + """ + + if size is not None and not isinstance(size, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: int', None, None) + + self.__size = size + self.__key_modified['size'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_file_id(self): + """ + The method to get the file_id + + Returns: + string: A string representing the file_id + """ + + return self.__file_id + + def set_file_id(self, file_id): + """ + The method to set the value to file_id + + Parameters: + file_id (string) : A string representing the file_id + """ + + if file_id is not None and not isinstance(file_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id EXPECTED TYPE: str', None, None) + + self.__file_id = file_id + self.__key_modified['file_id'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_template.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_template.py new file mode 100644 index 0000000..b32b172 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_template.py @@ -0,0 +1,610 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import InventoryTemplates + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail import Template +except Exception: + from ..exception import SDKException + from ..inventory_templates import InventoryTemplates + from ..util import Constants + from ..send_mail import Template + + +class EmailTemplate(InventoryTemplates, Template): + def __init__(self): + """Creates an instance of EmailTemplate""" + super().__init__() + + self.__attachments = None + self.__subject = None + self.__associated = None + self.__consent_linked = None + self.__description = None + self.__last_version_statistics = None + self.__category = None + self.__created_time = None + self.__modified_time = None + self.__last_usage_time = None + self.__folder = None + self.__module = None + self.__created_by = None + self.__modified_by = None + self.__name = None + self.__id = None + self.__editor_mode = None + self.__favorite = None + self.__content = None + self.__active = None + self.__mail_content = None + self.__key_modified = dict() + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_associated(self): + """ + The method to get the associated + + Returns: + bool: A bool representing the associated + """ + + return self.__associated + + def set_associated(self, associated): + """ + The method to set the value to associated + + Parameters: + associated (bool) : A bool representing the associated + """ + + if associated is not None and not isinstance(associated, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated EXPECTED TYPE: bool', None, None) + + self.__associated = associated + self.__key_modified['associated'] = 1 + + def get_consent_linked(self): + """ + The method to get the consent_linked + + Returns: + bool: A bool representing the consent_linked + """ + + return self.__consent_linked + + def set_consent_linked(self, consent_linked): + """ + The method to set the value to consent_linked + + Parameters: + consent_linked (bool) : A bool representing the consent_linked + """ + + if consent_linked is not None and not isinstance(consent_linked, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_linked EXPECTED TYPE: bool', None, None) + + self.__consent_linked = consent_linked + self.__key_modified['consent_linked'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_last_version_statistics(self): + """ + The method to get the last_version_statistics + + Returns: + LastVersionStatistics: An instance of LastVersionStatistics + """ + + return self.__last_version_statistics + + def set_last_version_statistics(self, last_version_statistics): + """ + The method to set the value to last_version_statistics + + Parameters: + last_version_statistics (LastVersionStatistics) : An instance of LastVersionStatistics + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.last_version_statistics import LastVersionStatistics + except Exception: + from .last_version_statistics import LastVersionStatistics + + if last_version_statistics is not None and not isinstance(last_version_statistics, LastVersionStatistics): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_version_statistics EXPECTED TYPE: LastVersionStatistics', None, None) + + self.__last_version_statistics = last_version_statistics + self.__key_modified['last_version_statistics'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_last_usage_time(self): + """ + The method to get the last_usage_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_usage_time + + def set_last_usage_time(self, last_usage_time): + """ + The method to set the value to last_usage_time + + Parameters: + last_usage_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_usage_time is not None and not isinstance(last_usage_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_usage_time EXPECTED TYPE: datetime', None, None) + + self.__last_usage_time = last_usage_time + self.__key_modified['last_usage_time'] = 1 + + def get_folder(self): + """ + The method to get the folder + + Returns: + Folder: An instance of Folder + """ + + return self.__folder + + def set_folder(self, folder): + """ + The method to set the value to folder + + Parameters: + folder (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import Folder + except Exception: + from ..inventory_templates import Folder + + if folder is not None and not isinstance(folder, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: Folder', None, None) + + self.__folder = folder + self.__key_modified['folder'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import ModuleMap + except Exception: + from ..inventory_templates import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import User + except Exception: + from ..inventory_templates import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates import User + except Exception: + from ..inventory_templates import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_editor_mode(self): + """ + The method to get the editor_mode + + Returns: + string: A string representing the editor_mode + """ + + return self.__editor_mode + + def set_editor_mode(self, editor_mode): + """ + The method to set the value to editor_mode + + Parameters: + editor_mode (string) : A string representing the editor_mode + """ + + if editor_mode is not None and not isinstance(editor_mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editor_mode EXPECTED TYPE: str', None, None) + + self.__editor_mode = editor_mode + self.__key_modified['editor_mode'] = 1 + + def get_favorite(self): + """ + The method to get the favorite + + Returns: + bool: A bool representing the favorite + """ + + return self.__favorite + + def set_favorite(self, favorite): + """ + The method to set the value to favorite + + Parameters: + favorite (bool) : A bool representing the favorite + """ + + if favorite is not None and not isinstance(favorite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: bool', None, None) + + self.__favorite = favorite + self.__key_modified['favorite'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_mail_content(self): + """ + The method to get the mail_content + + Returns: + string: A string representing the mail_content + """ + + return self.__mail_content + + def set_mail_content(self, mail_content): + """ + The method to set the value to mail_content + + Parameters: + mail_content (string) : A string representing the mail_content + """ + + if mail_content is not None and not isinstance(mail_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_content EXPECTED TYPE: str', None, None) + + self.__mail_content = mail_content + self.__key_modified['mail_content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_templates_operations.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_templates_operations.py new file mode 100644 index 0000000..8e7b02f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/email_templates_operations.py @@ -0,0 +1,83 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class EmailTemplatesOperations(object): + def __init__(self): + """Creates an instance of EmailTemplatesOperations""" + pass + + def get_email_templates(self, param_instance=None): + """ + The method to get email templates + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/email_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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_email_template(self, template): + """ + The method to get email template + + Parameters: + template (int) : An int representing the template + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(template, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/email_templates/' + api_path = api_path + str(template) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetEmailTemplatesParam(object): + module = Param('module', 'com.zoho.crm.api.EmailTemplates.GetEmailTemplatesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/info.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/last_version_statistics.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/last_version_statistics.py new file mode 100644 index 0000000..a1d3a50 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/last_version_statistics.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LastVersionStatistics(object): + def __init__(self): + """Creates an instance of LastVersionStatistics""" + + self.__tracked = None + self.__delivered = None + self.__opened = None + self.__bounced = None + self.__sent = None + self.__clicked = None + self.__key_modified = dict() + + def get_tracked(self): + """ + The method to get the tracked + + Returns: + int: An int representing the tracked + """ + + return self.__tracked + + def set_tracked(self, tracked): + """ + The method to set the value to tracked + + Parameters: + tracked (int) : An int representing the tracked + """ + + if tracked is not None and not isinstance(tracked, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tracked EXPECTED TYPE: int', None, None) + + self.__tracked = tracked + self.__key_modified['tracked'] = 1 + + def get_delivered(self): + """ + The method to get the delivered + + Returns: + int: An int representing the delivered + """ + + return self.__delivered + + def set_delivered(self, delivered): + """ + The method to set the value to delivered + + Parameters: + delivered (int) : An int representing the delivered + """ + + if delivered is not None and not isinstance(delivered, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delivered EXPECTED TYPE: int', None, None) + + self.__delivered = delivered + self.__key_modified['delivered'] = 1 + + def get_opened(self): + """ + The method to get the opened + + Returns: + int: An int representing the opened + """ + + return self.__opened + + def set_opened(self, opened): + """ + The method to set the value to opened + + Parameters: + opened (int) : An int representing the opened + """ + + if opened is not None and not isinstance(opened, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: opened EXPECTED TYPE: int', None, None) + + self.__opened = opened + self.__key_modified['opened'] = 1 + + def get_bounced(self): + """ + The method to get the bounced + + Returns: + int: An int representing the bounced + """ + + return self.__bounced + + def set_bounced(self, bounced): + """ + The method to set the value to bounced + + Parameters: + bounced (int) : An int representing the bounced + """ + + if bounced is not None and not isinstance(bounced, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bounced EXPECTED TYPE: int', None, None) + + self.__bounced = bounced + self.__key_modified['bounced'] = 1 + + def get_sent(self): + """ + The method to get the sent + + Returns: + int: An int representing the sent + """ + + return self.__sent + + def set_sent(self, sent): + """ + The method to set the value to sent + + Parameters: + sent (int) : An int representing the sent + """ + + if sent is not None and not isinstance(sent, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sent EXPECTED TYPE: int', None, None) + + self.__sent = sent + self.__key_modified['sent'] = 1 + + def get_clicked(self): + """ + The method to get the clicked + + Returns: + int: An int representing the clicked + """ + + return self.__clicked + + def set_clicked(self, clicked): + """ + The method to set the value to clicked + + Parameters: + clicked (int) : An int representing the clicked + """ + + if clicked is not None and not isinstance(clicked, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: clicked EXPECTED TYPE: int', None, None) + + self.__clicked = clicked + self.__key_modified['clicked'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_wrapper.py new file mode 100644 index 0000000..d9a7e9c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/email_templates/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.email_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__email_templates = None + self.__info = None + self.__key_modified = dict() + + def get_email_templates(self): + """ + The method to get the email_templates + + Returns: + list: An instance of list + """ + + return self.__email_templates + + def set_email_templates(self, email_templates): + """ + The method to set the value to email_templates + + Parameters: + email_templates (list) : An instance of list + """ + + if email_templates is not None and not isinstance(email_templates, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_templates EXPECTED TYPE: list', None, None) + + self.__email_templates = email_templates + self.__key_modified['email_templates'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.email_templates.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/__init__.py new file mode 100644 index 0000000..73f395b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/__init__.py @@ -0,0 +1,9 @@ +from .entity_scores_operations import EntityScoresOperations, GetEntityScoreParam, GetEntityScoresParam, GetEntityScoresHeader +from .scoring_rule import ScoringRule +from .api_exception import APIException +from .entity_scores import EntityScores +from .response_handler import ResponseHandler +from .module import Module +from .response_wrapper import ResponseWrapper +from .entity import Entity +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/api_exception.py new file mode 100644 index 0000000..0c6e190 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity.py new file mode 100644 index 0000000..1261643 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Entity(object): + def __init__(self): + """Creates an instance of Entity""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores.py new file mode 100644 index 0000000..0dabdde --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores.py @@ -0,0 +1,334 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EntityScores(object): + def __init__(self): + """Creates an instance of EntityScores""" + + self.__entity = None + self.__positive_score = None + self.__touch_point_score = None + self.__score = None + self.__negative_score = None + self.__touch_point_negative_score = None + self.__scoring_rule = None + self.__field_states = None + self.__id = None + self.__zia_visions = None + self.__touch_point_positive_score = None + self.__key_modified = dict() + + def get_entity(self): + """ + The method to get the entity + + Returns: + Entity: An instance of Entity + """ + + return self.__entity + + def set_entity(self, entity): + """ + The method to set the value to entity + + Parameters: + entity (Entity) : An instance of Entity + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.entity import Entity + except Exception: + from .entity import Entity + + if entity is not None and not isinstance(entity, Entity): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: entity EXPECTED TYPE: Entity', None, None) + + self.__entity = entity + self.__key_modified['Entity'] = 1 + + def get_positive_score(self): + """ + The method to get the positive_score + + Returns: + int: An int representing the positive_score + """ + + return self.__positive_score + + def set_positive_score(self, positive_score): + """ + The method to set the value to positive_score + + Parameters: + positive_score (int) : An int representing the positive_score + """ + + if positive_score is not None and not isinstance(positive_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: positive_score EXPECTED TYPE: int', None, None) + + self.__positive_score = positive_score + self.__key_modified['Positive_Score'] = 1 + + def get_touch_point_score(self): + """ + The method to get the touch_point_score + + Returns: + int: An int representing the touch_point_score + """ + + return self.__touch_point_score + + def set_touch_point_score(self, touch_point_score): + """ + The method to set the value to touch_point_score + + Parameters: + touch_point_score (int) : An int representing the touch_point_score + """ + + if touch_point_score is not None and not isinstance(touch_point_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: touch_point_score EXPECTED TYPE: int', None, None) + + self.__touch_point_score = touch_point_score + self.__key_modified['Touch_Point_Score'] = 1 + + def get_score(self): + """ + The method to get the score + + Returns: + int: An int representing the score + """ + + return self.__score + + def set_score(self, score): + """ + The method to set the value to score + + Parameters: + score (int) : An int representing the score + """ + + if score is not None and not isinstance(score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: score EXPECTED TYPE: int', None, None) + + self.__score = score + self.__key_modified['Score'] = 1 + + def get_negative_score(self): + """ + The method to get the negative_score + + Returns: + int: An int representing the negative_score + """ + + return self.__negative_score + + def set_negative_score(self, negative_score): + """ + The method to set the value to negative_score + + Parameters: + negative_score (int) : An int representing the negative_score + """ + + if negative_score is not None and not isinstance(negative_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: negative_score EXPECTED TYPE: int', None, None) + + self.__negative_score = negative_score + self.__key_modified['Negative_Score'] = 1 + + def get_touch_point_negative_score(self): + """ + The method to get the touch_point_negative_score + + Returns: + int: An int representing the touch_point_negative_score + """ + + return self.__touch_point_negative_score + + def set_touch_point_negative_score(self, touch_point_negative_score): + """ + The method to set the value to touch_point_negative_score + + Parameters: + touch_point_negative_score (int) : An int representing the touch_point_negative_score + """ + + if touch_point_negative_score is not None and not isinstance(touch_point_negative_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: touch_point_negative_score EXPECTED TYPE: int', None, None) + + self.__touch_point_negative_score = touch_point_negative_score + self.__key_modified['Touch_Point_Negative_Score'] = 1 + + def get_scoring_rule(self): + """ + The method to get the scoring_rule + + Returns: + ScoringRule: An instance of ScoringRule + """ + + return self.__scoring_rule + + def set_scoring_rule(self, scoring_rule): + """ + The method to set the value to scoring_rule + + Parameters: + scoring_rule (ScoringRule) : An instance of ScoringRule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.scoring_rule import ScoringRule + except Exception: + from .scoring_rule import ScoringRule + + if scoring_rule is not None and not isinstance(scoring_rule, ScoringRule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rule EXPECTED TYPE: ScoringRule', None, None) + + self.__scoring_rule = scoring_rule + self.__key_modified['Scoring_Rule'] = 1 + + def get_field_states(self): + """ + The method to get the field_states + + Returns: + list: An instance of list + """ + + return self.__field_states + + def set_field_states(self, field_states): + """ + The method to set the value to field_states + + Parameters: + field_states (list) : An instance of list + """ + + if field_states is not None and not isinstance(field_states, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_states EXPECTED TYPE: list', None, None) + + self.__field_states = field_states + self.__key_modified['$field_states'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_zia_visions(self): + """ + The method to get the zia_visions + + Returns: + bool: A bool representing the zia_visions + """ + + return self.__zia_visions + + def set_zia_visions(self, zia_visions): + """ + The method to set the value to zia_visions + + Parameters: + zia_visions (bool) : A bool representing the zia_visions + """ + + if zia_visions is not None and not isinstance(zia_visions, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_visions EXPECTED TYPE: bool', None, None) + + self.__zia_visions = zia_visions + self.__key_modified['$zia_visions'] = 1 + + def get_touch_point_positive_score(self): + """ + The method to get the touch_point_positive_score + + Returns: + int: An int representing the touch_point_positive_score + """ + + return self.__touch_point_positive_score + + def set_touch_point_positive_score(self, touch_point_positive_score): + """ + The method to set the value to touch_point_positive_score + + Parameters: + touch_point_positive_score (int) : An int representing the touch_point_positive_score + """ + + if touch_point_positive_score is not None and not isinstance(touch_point_positive_score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: touch_point_positive_score EXPECTED TYPE: int', None, None) + + self.__touch_point_positive_score = touch_point_positive_score + self.__key_modified['Touch_Point_Positive_Score'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores_operations.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores_operations.py new file mode 100644 index 0000000..d56ceb2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/entity_scores_operations.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class EntityScoresOperations(object): + def __init__(self, fields=None, cvid=None): + """ + Creates an instance of EntityScoresOperations with the given parameters + + Parameters: + fields (string) : A string representing the fields + cvid (string) : A string representing the cvid + """ + + if fields is not None and not isinstance(fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: str', None, None) + + if cvid is not None and not isinstance(cvid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: str', None, None) + + self.__fields = fields + self.__cvid = cvid + + + def get_entity_score(self, record_id): + """ + The method to get entity score + + Parameters: + record_id (int) : An int representing the record_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Entity_Scores__s/' + api_path = api_path + str(record_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('fields', 'com.zoho.crm.api.EntityScores.GetEntityScoreParam'), self.__fields) + handler_instance.add_param(Param('cvid', 'com.zoho.crm.api.EntityScores.GetEntityScoreParam'), self.__cvid) + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_entity_scores(self, param_instance=None, header_instance=None): + """ + The method to get entity scores + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Entity_Scores__s' + 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', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam'), self.__fields) + handler_instance.add_param(Param('cvid', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam'), self.__cvid) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetEntityScoreParam(object): + pass + + +class GetEntityScoresParam(object): + ids = Param('ids', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + page = Param('page', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + per_page = Param('per_page', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + page_token = Param('page_token', 'com.zoho.crm.api.EntityScores.GetEntityScoresParam') + + +class GetEntityScoresHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.EntityScores.GetEntityScoresHeader') diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/info.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/info.py new file mode 100644 index 0000000..b2f0541 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/info.py @@ -0,0 +1,274 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__sort_by = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__sort_order = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + string: A string representing the page_token_expiry + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (string) : A string representing the page_token_expiry + """ + + if page_token_expiry is not None and not isinstance(page_token_expiry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: str', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/module.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_wrapper.py new file mode 100644 index 0000000..605cc68 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.entity_scores.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/entity_scores/scoring_rule.py b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/scoring_rule.py new file mode 100644 index 0000000..22057df --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/entity_scores/scoring_rule.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScoringRule(object): + def __init__(self): + """Creates an instance of ScoringRule""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/exception/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/exception/__init__.py new file mode 100755 index 0000000..dcf5633 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/exception/__init__.py @@ -0,0 +1 @@ +from .sdk_exception import SDKException diff --git a/zohocrmsdk/src/com/zoho/crm/api/exception/sdk_exception.py b/zohocrmsdk/src/com/zoho/crm/api/exception/sdk_exception.py new file mode 100755 index 0000000..2f50bb7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/exception/sdk_exception.py @@ -0,0 +1,38 @@ +import json + + +class SDKException(Exception): + + """ + This class is the common SDKException object. + """ + + message = 'Caused By: {code} - {message}' + + def __init__(self, code=None, message=None, details=None, cause=None): + + """ + Creates an SDKException class instance with the specified parameters. + + Parameters: + code (str) : A string containing the Exception error code. + message (str) : A string containing the Exception error message. + details (dict) : A dict containing the error response. + cause (Exception) : A Exception class instance. + """ + + self.code = code + self.cause = cause + self.details = details + self.error_message = "" if message is None else message + + if self.details is not None: + self.error_message = self.error_message + json.dumps(self.details,default=str) + + if self.cause is not None: + self.error_message = self.error_message + str(self.cause) + + Exception.__init__(self, code, message) + + def __str__(self): + return self.message.format(code=self.code, message=self.error_message) diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/features/__init__.py new file mode 100644 index 0000000..58e9ba0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/__init__.py @@ -0,0 +1,9 @@ +from .features_operations import FeaturesOperations, GetFeatureDetailsParam, GetFeatureDetailParam +from .api_exception import APIException +from .component import Component +from .response_handler import ResponseHandler +from .feature import Feature +from .limit import Limit +from .response_wrapper import ResponseWrapper +from .detail import Detail +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/features/api_exception.py new file mode 100644 index 0000000..c759a23 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/component.py b/zohocrmsdk/src/com/zoho/crm/api/features/component.py new file mode 100644 index 0000000..f458ebe --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/component.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Component(object): + def __init__(self): + """Creates an instance of Component""" + + self.__api_name = None + self.__module_supported = None + self.__details = None + self.__feature_label = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module_supported(self): + """ + The method to get the module_supported + + Returns: + bool: A bool representing the module_supported + """ + + return self.__module_supported + + def set_module_supported(self, module_supported): + """ + The method to set the value to module_supported + + Parameters: + module_supported (bool) : A bool representing the module_supported + """ + + if module_supported is not None and not isinstance(module_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_supported EXPECTED TYPE: bool', None, None) + + self.__module_supported = module_supported + self.__key_modified['module_supported'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + Detail: An instance of Detail + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Detail) : An instance of Detail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.detail import Detail + except Exception: + from .detail import Detail + + if details is not None and not isinstance(details, Detail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Detail', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_feature_label(self): + """ + The method to get the feature_label + + Returns: + string: A string representing the feature_label + """ + + return self.__feature_label + + def set_feature_label(self, feature_label): + """ + The method to set the value to feature_label + + Parameters: + feature_label (string) : A string representing the feature_label + """ + + if feature_label is not None and not isinstance(feature_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_label EXPECTED TYPE: str', None, None) + + self.__feature_label = feature_label + self.__key_modified['feature_label'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/detail.py b/zohocrmsdk/src/com/zoho/crm/api/features/detail.py new file mode 100644 index 0000000..f3a80d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/detail.py @@ -0,0 +1,139 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Detail(object): + def __init__(self): + """Creates an instance of Detail""" + + self.__available_count = None + self.__limits = None + self.__used_count = None + self.__key_modified = dict() + + def get_available_count(self): + """ + The method to get the available_count + + Returns: + Limit: An instance of Limit + """ + + return self.__available_count + + def set_available_count(self, available_count): + """ + The method to set the value to available_count + + Parameters: + available_count (Limit) : An instance of Limit + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.limit import Limit + except Exception: + from .limit import Limit + + if available_count is not None and not isinstance(available_count, Limit): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_count EXPECTED TYPE: Limit', None, None) + + self.__available_count = available_count + self.__key_modified['available_count'] = 1 + + def get_limits(self): + """ + The method to get the limits + + Returns: + Limit: An instance of Limit + """ + + return self.__limits + + def set_limits(self, limits): + """ + The method to set the value to limits + + Parameters: + limits (Limit) : An instance of Limit + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.limit import Limit + except Exception: + from .limit import Limit + + if limits is not None and not isinstance(limits, Limit): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: limits EXPECTED TYPE: Limit', None, None) + + self.__limits = limits + self.__key_modified['limits'] = 1 + + def get_used_count(self): + """ + The method to get the used_count + + Returns: + Limit: An instance of Limit + """ + + return self.__used_count + + def set_used_count(self, used_count): + """ + The method to set the value to used_count + + Parameters: + used_count (Limit) : An instance of Limit + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.limit import Limit + except Exception: + from .limit import Limit + + if used_count is not None and not isinstance(used_count, Limit): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: used_count EXPECTED TYPE: Limit', None, None) + + self.__used_count = used_count + self.__key_modified['used_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/feature.py b/zohocrmsdk/src/com/zoho/crm/api/features/feature.py new file mode 100644 index 0000000..4f2b4fb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/feature.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Feature(object): + def __init__(self): + """Creates an instance of Feature""" + + self.__api_name = None + self.__parent_feature = None + self.__module_supported = None + self.__details = None + self.__feature_label = None + self.__components = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_parent_feature(self): + """ + The method to get the parent_feature + + Returns: + Feature: An instance of Feature + """ + + return self.__parent_feature + + def set_parent_feature(self, parent_feature): + """ + The method to set the value to parent_feature + + Parameters: + parent_feature (Feature) : An instance of Feature + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.feature import Feature + except Exception: + from .feature import Feature + + if parent_feature is not None and not isinstance(parent_feature, Feature): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_feature EXPECTED TYPE: Feature', None, None) + + self.__parent_feature = parent_feature + self.__key_modified['parent_feature'] = 1 + + def get_module_supported(self): + """ + The method to get the module_supported + + Returns: + bool: A bool representing the module_supported + """ + + return self.__module_supported + + def set_module_supported(self, module_supported): + """ + The method to set the value to module_supported + + Parameters: + module_supported (bool) : A bool representing the module_supported + """ + + if module_supported is not None and not isinstance(module_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_supported EXPECTED TYPE: bool', None, None) + + self.__module_supported = module_supported + self.__key_modified['module_supported'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + Detail: An instance of Detail + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Detail) : An instance of Detail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.detail import Detail + except Exception: + from .detail import Detail + + if details is not None and not isinstance(details, Detail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Detail', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_feature_label(self): + """ + The method to get the feature_label + + Returns: + string: A string representing the feature_label + """ + + return self.__feature_label + + def set_feature_label(self, feature_label): + """ + The method to set the value to feature_label + + Parameters: + feature_label (string) : A string representing the feature_label + """ + + if feature_label is not None and not isinstance(feature_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_label EXPECTED TYPE: str', None, None) + + self.__feature_label = feature_label + self.__key_modified['feature_label'] = 1 + + def get_components(self): + """ + The method to get the components + + Returns: + list: An instance of list + """ + + return self.__components + + def set_components(self, components): + """ + The method to set the value to components + + Parameters: + components (list) : An instance of list + """ + + if components is not None and not isinstance(components, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: components EXPECTED TYPE: list', None, None) + + self.__components = components + self.__key_modified['components'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/features_operations.py b/zohocrmsdk/src/com/zoho/crm/api/features/features_operations.py new file mode 100644 index 0000000..2107009 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/features_operations.py @@ -0,0 +1,144 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FeaturesOperations(object): + def __init__(self): + """Creates an instance of FeaturesOperations""" + pass + + def get_feature_details(self, param_instance=None): + """ + The method to get feature details + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/__features' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_feature_detail(self, feature_api_name, param_instance=None): + """ + The method to get feature detail + + Parameters: + feature_api_name (string) : A string representing the feature_api_name + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(feature_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_api_name EXPECTED TYPE: str', None, None) + + 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/v7/__features/' + api_path = api_path + str(feature_api_name) + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_data_enrichment(self): + """ + The method to get data enrichment + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__features/data_enrichment' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_user_licences_count(self): + """ + The method to get user licences count + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__features/user_licenses' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetFeatureDetailsParam(object): + module = Param('module', 'com.zoho.crm.api.Features.GetFeatureDetailsParam') + api_names = Param('api_names', 'com.zoho.crm.api.Features.GetFeatureDetailsParam') + + +class GetFeatureDetailParam(object): + module = Param('module', 'com.zoho.crm.api.Features.GetFeatureDetailParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/info.py b/zohocrmsdk/src/com/zoho/crm/api/features/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/limit.py b/zohocrmsdk/src/com/zoho/crm/api/features/limit.py new file mode 100644 index 0000000..ba686d5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/limit.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Limit(object): + def __init__(self): + """Creates an instance of Limit""" + + self.__total = None + self.__edition_limit = None + self.__key_modified = dict() + + def get_total(self): + """ + The method to get the total + + Returns: + int: An int representing the total + """ + + return self.__total + + def set_total(self, total): + """ + The method to set the value to total + + Parameters: + total (int) : An int representing the total + """ + + if total is not None and not isinstance(total, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total EXPECTED TYPE: int', None, None) + + self.__total = total + self.__key_modified['total'] = 1 + + def get_edition_limit(self): + """ + The method to get the edition_limit + + Returns: + int: An int representing the edition_limit + """ + + return self.__edition_limit + + def set_edition_limit(self, edition_limit): + """ + The method to set the value to edition_limit + + Parameters: + edition_limit (int) : An int representing the edition_limit + """ + + if edition_limit is not None and not isinstance(edition_limit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edition_limit EXPECTED TYPE: int', None, None) + + self.__edition_limit = edition_limit + self.__key_modified['edition_limit'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/features/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/features/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/features/response_wrapper.py new file mode 100644 index 0000000..545ace3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/features/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.features.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__features = None + self.__info = None + self.__key_modified = dict() + + def get_features(self): + """ + The method to get the features + + Returns: + list: An instance of list + """ + + return self.__features + + def set_features(self, features): + """ + The method to set the value to features + + Parameters: + features (list) : An instance of list + """ + + if features is not None and not isinstance(features, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: features EXPECTED TYPE: list', None, None) + + self.__features = features + self.__key_modified['__features'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.features.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_attachments/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/__init__.py new file mode 100644 index 0000000..483ad85 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .file_body_wrapper import FileBodyWrapper +from .field_attachments_operations import FieldAttachmentsOperations, GetFieldAttachmentsParam diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_attachments/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/api_exception.py new file mode 100644 index 0000000..85696a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_attachments/field_attachments_operations.py b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/field_attachments_operations.py new file mode 100644 index 0000000..9f253a9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/field_attachments_operations.py @@ -0,0 +1,66 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FieldAttachmentsOperations(object): + def __init__(self, module_api_name, record_id, fields_attachment_id=None): + """ + Creates an instance of FieldAttachmentsOperations with the given parameters + + Parameters: + module_api_name (string) : A string representing the module_api_name + record_id (int) : An int representing the record_id + fields_attachment_id (int) : An int representing the fields_attachment_id + """ + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if fields_attachment_id is not None and not isinstance(fields_attachment_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields_attachment_id EXPECTED TYPE: int', None, None) + + self.__module_api_name = module_api_name + self.__record_id = record_id + self.__fields_attachment_id = fields_attachment_id + + + 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/v7/' + 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 zohocrmsdk.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 GetFieldAttachmentsParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_attachments/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/file_body_wrapper.py new file mode 100644 index 0000000..ca5364e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_attachments.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_attachments/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_attachments/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/__init__.py new file mode 100644 index 0000000..3868bf9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .parent import Parent +from .field_map_dependency_operations import FieldMapDependencyOperations, CreateMapDependencyParam, CreateMapDependencyHeader, GetMapDependenciesParam, UpdateMapDependencyParam, GetMapDependencyParam, DeleteMapDependencyParam +from .pick_list_mapping import PickListMapping +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .map_dependency import MapDependency +from .sub_module import SubModule +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .picklist_map import PicklistMap +from .child import Child +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_wrapper.py new file mode 100644 index 0000000..4bc153c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__map_dependency = None + self.__key_modified = dict() + + def get_map_dependency(self): + """ + The method to get the map_dependency + + Returns: + list: An instance of list + """ + + return self.__map_dependency + + def set_map_dependency(self, map_dependency): + """ + The method to set the value to map_dependency + + Parameters: + map_dependency (list) : An instance of list + """ + + if map_dependency is not None and not isinstance(map_dependency, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: map_dependency EXPECTED TYPE: list', None, None) + + self.__map_dependency = map_dependency + self.__key_modified['map_dependency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/api_exception.py new file mode 100644 index 0000000..95dded1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/body_wrapper.py new file mode 100644 index 0000000..950fe6e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__map_dependency = None + self.__key_modified = dict() + + def get_map_dependency(self): + """ + The method to get the map_dependency + + Returns: + list: An instance of list + """ + + return self.__map_dependency + + def set_map_dependency(self, map_dependency): + """ + The method to set the value to map_dependency + + Parameters: + map_dependency (list) : An instance of list + """ + + if map_dependency is not None and not isinstance(map_dependency, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: map_dependency EXPECTED TYPE: list', None, None) + + self.__map_dependency = map_dependency + self.__key_modified['map_dependency'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/child.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/child.py new file mode 100644 index 0000000..7c7d505 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/child.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Child(object): + def __init__(self): + """Creates an instance of Child""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/field_map_dependency_operations.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/field_map_dependency_operations.py new file mode 100644 index 0000000..90fffdf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/field_map_dependency_operations.py @@ -0,0 +1,244 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FieldMapDependencyOperations(object): + def __init__(self, layout_id, module=None): + """ + Creates an instance of FieldMapDependencyOperations with the given parameters + + Parameters: + layout_id (int) : An int representing the layout_id + module (string) : A string representing the module + """ + + if not isinstance(layout_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: int', None, None) + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__layout_id = layout_id + self.__module = module + + + def create_map_dependency(self, request): + """ + The method to create map dependency + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency' + 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('module', 'com.zoho.crm.api.FieldMapDependency.CreateMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_map_dependencies(self, param_instance=None): + """ + The method to get map dependencies + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency' + 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.FieldMapDependency.GetMapDependenciesParam'), self.__module) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_map_dependency(self, dependency_id, request): + """ + The method to update map dependency + + Parameters: + dependency_id (int) : An int representing the dependency_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(dependency_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dependency_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/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency/' + api_path = api_path + str(dependency_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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.FieldMapDependency.UpdateMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_map_dependency(self, dependency_id): + """ + The method to get map dependency + + Parameters: + dependency_id (int) : An int representing the dependency_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(dependency_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dependency_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency/' + api_path = api_path + str(dependency_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.FieldMapDependency.GetMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_map_dependency(self, dependency_id): + """ + The method to delete map dependency + + Parameters: + dependency_id (int) : An int representing the dependency_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(dependency_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dependency_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/layouts/' + api_path = api_path + str(self.__layout_id) + api_path = api_path + '/map_dependency/' + api_path = api_path + str(dependency_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.FieldMapDependency.DeleteMapDependencyParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class CreateMapDependencyParam(object): + pass + + +class CreateMapDependencyHeader(object): + pass + + +class GetMapDependenciesParam(object): + page = Param('page', 'com.zoho.crm.api.FieldMapDependency.GetMapDependenciesParam') + per_page = Param('per_page', 'com.zoho.crm.api.FieldMapDependency.GetMapDependenciesParam') + filters = Param('filters', 'com.zoho.crm.api.FieldMapDependency.GetMapDependenciesParam') + + +class UpdateMapDependencyParam(object): + pass + + +class GetMapDependencyParam(object): + pass + + +class DeleteMapDependencyParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/info.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/info.py new file mode 100644 index 0000000..b33ef98 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__page = None + self.__per_page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/map_dependency.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/map_dependency.py new file mode 100644 index 0000000..2efbaaa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/map_dependency.py @@ -0,0 +1,289 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MapDependency(object): + def __init__(self): + """Creates an instance of MapDependency""" + + self.__parent = None + self.__child = None + self.__pick_list_values = None + self.__internal = None + self.__active = None + self.__id = None + self.__source = None + self.__category = None + self.__sub_module = None + self.__key_modified = dict() + + def get_parent(self): + """ + The method to get the parent + + Returns: + Parent: An instance of Parent + """ + + return self.__parent + + def set_parent(self, parent): + """ + The method to set the value to parent + + Parameters: + parent (Parent) : An instance of Parent + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.parent import Parent + except Exception: + from .parent import Parent + + if parent is not None and not isinstance(parent, Parent): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent EXPECTED TYPE: Parent', None, None) + + self.__parent = parent + self.__key_modified['parent'] = 1 + + def get_child(self): + """ + The method to get the child + + Returns: + Child: An instance of Child + """ + + return self.__child + + def set_child(self, child): + """ + The method to set the value to child + + Parameters: + child (Child) : An instance of Child + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.child import Child + except Exception: + from .child import Child + + if child is not None and not isinstance(child, Child): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: child EXPECTED TYPE: Child', None, None) + + self.__child = child + self.__key_modified['child'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_internal(self): + """ + The method to get the internal + + Returns: + bool: A bool representing the internal + """ + + return self.__internal + + def set_internal(self, internal): + """ + The method to set the value to internal + + Parameters: + internal (bool) : A bool representing the internal + """ + + if internal is not None and not isinstance(internal, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: internal EXPECTED TYPE: bool', None, None) + + self.__internal = internal + self.__key_modified['internal'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + int: An int representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (int) : An int representing the source + """ + + if source is not None and not isinstance(source, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: int', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + SubModule: An instance of SubModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (SubModule) : An instance of SubModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.sub_module import SubModule + except Exception: + from .sub_module import SubModule + + if sub_module is not None and not isinstance(sub_module, SubModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: SubModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/parent.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/parent.py new file mode 100644 index 0000000..1f3545c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/parent.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Parent(object): + def __init__(self): + """Creates an instance of Parent""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/pick_list_mapping.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/pick_list_mapping.py new file mode 100644 index 0000000..dbebea2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/pick_list_mapping.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PickListMapping(object): + def __init__(self): + """Creates an instance of PickListMapping""" + + self.__id = None + self.__actual_value = None + self.__display_value = None + self.__maps = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_maps(self): + """ + The method to get the maps + + Returns: + list: An instance of list + """ + + return self.__maps + + def set_maps(self, maps): + """ + The method to set the value to maps + + Parameters: + maps (list) : An instance of list + """ + + if maps is not None and not isinstance(maps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: list', None, None) + + self.__maps = maps + self.__key_modified['maps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/picklist_map.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/picklist_map.py new file mode 100644 index 0000000..6a0d019 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/picklist_map.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PicklistMap(object): + def __init__(self): + """Creates an instance of PicklistMap""" + + self.__id = None + self.__actual_value = None + self.__display_value = None + self.__delete = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_wrapper.py new file mode 100644 index 0000000..136b7ba --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__map_dependency = None + self.__info = None + self.__key_modified = dict() + + def get_map_dependency(self): + """ + The method to get the map_dependency + + Returns: + list: An instance of list + """ + + return self.__map_dependency + + def set_map_dependency(self, map_dependency): + """ + The method to set the value to map_dependency + + Parameters: + map_dependency (list) : An instance of list + """ + + if map_dependency is not None and not isinstance(map_dependency, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: map_dependency EXPECTED TYPE: list', None, None) + + self.__map_dependency = map_dependency + self.__key_modified['map_dependency'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/sub_module.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/sub_module.py new file mode 100644 index 0000000..61cd5c5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/sub_module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SubModule(object): + def __init__(self): + """Creates an instance of SubModule""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/success_response.py new file mode 100644 index 0000000..561ce2c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/field_map_dependency/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/fields/__init__.py new file mode 100644 index 0000000..c575e85 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/__init__.py @@ -0,0 +1,48 @@ +from .history_tracking_module import HistoryTrackingModule +from .layout_association import LayoutAssociation +from .private import Private +from .operation_type import OperationType +from .file_upolad_option import FileUpoladOption +from .criteria import Criteria +from .crypt import Crypt +from .tooltip import Tooltip +from .forecast_category import ForecastCategory +from .textarea import Textarea +from .fields_operations import FieldsOperations, GetFieldsParam, GetFieldsHeader, CreateFieldParam, UpdateFieldsParam, GetFieldParam, GetFieldHeader, UpdateFieldParam, DeleteFieldParam +from .function_parameter import FunctionParameter +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .association_details import AssociationDetails +from .success_response import SuccessResponse +from .email_parser import EmailParser +from .rollup_criteria import RollupCriteria +from .sharing_properties import SharingProperties +from .multi_module_lookup import MultiModuleLookup +from .action_handler import ActionHandler +from .currency import Currency +from .mandatory_details import MandatoryDetails +from .minified_field import MinifiedField +from .action_wrapper import ActionWrapper +from .lookup import Lookup +from .hipaa_compliance import HipaaCompliance +from .convert_mapping import ConvertMapping +from .expression import Expression +from .refer_from_field import ReferFromField +from .show_fields import ShowFields +from .maps import Maps +from .profile import Profile +from .rollup_summary import RollupSummary +from .view_type import ViewType +from .body_wrapper import BodyWrapper +from .subform import Subform +from .external import External +from .history_tracking import HistoryTracking +from .unique import Unique +from .formula import Formula +from .response_wrapper import ResponseWrapper +from .fields import Fields +from .query_details import QueryDetails +from .pick_list_value import PickListValue +from .multiselectlookup import Multiselectlookup +from .auto_number import AutoNumber diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/fields/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/fields/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/fields/action_wrapper.py new file mode 100644 index 0000000..60f0f7c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/fields/api_exception.py new file mode 100644 index 0000000..6d24100 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.fields.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/association_details.py b/zohocrmsdk/src/com/zoho/crm/api/fields/association_details.py new file mode 100644 index 0000000..ef1872d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/association_details.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationDetails(object): + def __init__(self): + """Creates an instance of AssociationDetails""" + + self.__related_field = None + self.__lookup_field = None + self.__key_modified = dict() + + def get_related_field(self): + """ + The method to get the related_field + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__related_field + + def set_related_field(self, related_field): + """ + The method to set the value to related_field + + Parameters: + related_field (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if related_field is not None and not isinstance(related_field, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_field EXPECTED TYPE: MinifiedModule', None, None) + + self.__related_field = related_field + self.__key_modified['related_field'] = 1 + + def get_lookup_field(self): + """ + The method to get the lookup_field + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__lookup_field + + def set_lookup_field(self, lookup_field): + """ + The method to set the value to lookup_field + + Parameters: + lookup_field (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if lookup_field is not None and not isinstance(lookup_field, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_field EXPECTED TYPE: MinifiedModule', None, None) + + self.__lookup_field = lookup_field + self.__key_modified['lookup_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/auto_number.py b/zohocrmsdk/src/com/zoho/crm/api/fields/auto_number.py new file mode 100644 index 0000000..f47dc56 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/auto_number.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutoNumber(object): + def __init__(self): + """Creates an instance of AutoNumber""" + + self.__starting_number_length = None + self.__prefix = None + self.__suffix = None + self.__start_number = None + self.__key_modified = dict() + + def get_starting_number_length(self): + """ + The method to get the starting_number_length + + Returns: + int: An int representing the starting_number_length + """ + + return self.__starting_number_length + + def set_starting_number_length(self, starting_number_length): + """ + The method to set the value to starting_number_length + + Parameters: + starting_number_length (int) : An int representing the starting_number_length + """ + + if starting_number_length is not None and not isinstance(starting_number_length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: starting_number_length EXPECTED TYPE: int', None, None) + + self.__starting_number_length = starting_number_length + self.__key_modified['starting_number_length'] = 1 + + def get_prefix(self): + """ + The method to get the prefix + + Returns: + string: A string representing the prefix + """ + + return self.__prefix + + def set_prefix(self, prefix): + """ + The method to set the value to prefix + + Parameters: + prefix (string) : A string representing the prefix + """ + + if prefix is not None and not isinstance(prefix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: prefix EXPECTED TYPE: str', None, None) + + self.__prefix = prefix + self.__key_modified['prefix'] = 1 + + def get_suffix(self): + """ + The method to get the suffix + + Returns: + string: A string representing the suffix + """ + + return self.__suffix + + def set_suffix(self, suffix): + """ + The method to set the value to suffix + + Parameters: + suffix (string) : A string representing the suffix + """ + + if suffix is not None and not isinstance(suffix, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suffix EXPECTED TYPE: str', None, None) + + self.__suffix = suffix + self.__key_modified['suffix'] = 1 + + def get_start_number(self): + """ + The method to get the start_number + + Returns: + int: An int representing the start_number + """ + + return self.__start_number + + def set_start_number(self, start_number): + """ + The method to set the value to start_number + + Parameters: + start_number (int) : An int representing the start_number + """ + + if start_number is not None and not isinstance(start_number, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_number EXPECTED TYPE: int', None, None) + + self.__start_number = start_number + self.__key_modified['start_number'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/fields/body_wrapper.py new file mode 100644 index 0000000..bbb1400 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/convert_mapping.py b/zohocrmsdk/src/com/zoho/crm/api/fields/convert_mapping.py new file mode 100644 index 0000000..cad894a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/convert_mapping.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertMapping(object): + def __init__(self): + """Creates an instance of ConvertMapping""" + + self.__contacts = None + self.__deals = None + self.__accounts = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + string: A string representing the contacts + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (string) : A string representing the contacts + """ + + if contacts is not None and not isinstance(contacts, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: str', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + string: A string representing the deals + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (string) : A string representing the deals + """ + + if deals is not None and not isinstance(deals, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: str', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + string: A string representing the accounts + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (string) : A string representing the accounts + """ + + if accounts is not None and not isinstance(accounts, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: str', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/fields/criteria.py new file mode 100644 index 0000000..3c48d81 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/crypt.py b/zohocrmsdk/src/com/zoho/crm/api/fields/crypt.py new file mode 100644 index 0000000..3302bbd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/crypt.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Crypt(object): + def __init__(self): + """Creates an instance of Crypt""" + + self.__mode = None + self.__status = None + self.__column = None + self.__table = None + self.__encfldids = None + self.__notify = None + self.__key_modified = dict() + + def get_mode(self): + """ + The method to get the mode + + Returns: + string: A string representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (string) : A string representing the mode + """ + + if mode is not None and not isinstance(mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: str', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + int: An int representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (int) : An int representing the status + """ + + if status is not None and not isinstance(status, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: int', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_column(self): + """ + The method to get the column + + Returns: + string: A string representing the column + """ + + return self.__column + + def set_column(self, column): + """ + The method to set the value to column + + Parameters: + column (string) : A string representing the column + """ + + if column is not None and not isinstance(column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column EXPECTED TYPE: str', None, None) + + self.__column = column + self.__key_modified['column'] = 1 + + def get_table(self): + """ + The method to get the table + + Returns: + string: A string representing the table + """ + + return self.__table + + def set_table(self, table): + """ + The method to set the value to table + + Parameters: + table (string) : A string representing the table + """ + + if table is not None and not isinstance(table, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: table EXPECTED TYPE: str', None, None) + + self.__table = table + self.__key_modified['table'] = 1 + + def get_encfldids(self): + """ + The method to get the encfldids + + Returns: + list: An instance of list + """ + + return self.__encfldids + + def set_encfldids(self, encfldids): + """ + The method to set the value to encfldids + + Parameters: + encfldids (list) : An instance of list + """ + + if encfldids is not None and not isinstance(encfldids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encfldids EXPECTED TYPE: list', None, None) + + self.__encfldids = encfldids + self.__key_modified['encFldIds'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + string: A string representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (string) : A string representing the notify + """ + + if notify is not None and not isinstance(notify, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: str', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/currency.py b/zohocrmsdk/src/com/zoho/crm/api/fields/currency.py new file mode 100644 index 0000000..4bc8b8c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/currency.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Currency(object): + def __init__(self): + """Creates an instance of Currency""" + + self.__rounding_option = None + self.__precision = None + self.__key_modified = dict() + + def get_rounding_option(self): + """ + The method to get the rounding_option + + Returns: + Choice: An instance of Choice + """ + + return self.__rounding_option + + def set_rounding_option(self, rounding_option): + """ + The method to set the value to rounding_option + + Parameters: + rounding_option (Choice) : An instance of Choice + """ + + if rounding_option is not None and not isinstance(rounding_option, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rounding_option EXPECTED TYPE: Choice', None, None) + + self.__rounding_option = rounding_option + self.__key_modified['rounding_option'] = 1 + + def get_precision(self): + """ + The method to get the precision + + Returns: + int: An int representing the precision + """ + + return self.__precision + + def set_precision(self, precision): + """ + The method to set the value to precision + + Parameters: + precision (int) : An int representing the precision + """ + + if precision is not None and not isinstance(precision, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: precision EXPECTED TYPE: int', None, None) + + self.__precision = precision + self.__key_modified['precision'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/email_parser.py b/zohocrmsdk/src/com/zoho/crm/api/fields/email_parser.py new file mode 100644 index 0000000..3932f08 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/email_parser.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailParser(object): + def __init__(self): + """Creates an instance of EmailParser""" + + self.__fields_update_supported = None + self.__record_operations_supported = None + self.__key_modified = dict() + + def get_fields_update_supported(self): + """ + The method to get the fields_update_supported + + Returns: + bool: A bool representing the fields_update_supported + """ + + return self.__fields_update_supported + + def set_fields_update_supported(self, fields_update_supported): + """ + The method to set the value to fields_update_supported + + Parameters: + fields_update_supported (bool) : A bool representing the fields_update_supported + """ + + if fields_update_supported is not None and not isinstance(fields_update_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields_update_supported EXPECTED TYPE: bool', None, None) + + self.__fields_update_supported = fields_update_supported + self.__key_modified['fields_update_supported'] = 1 + + def get_record_operations_supported(self): + """ + The method to get the record_operations_supported + + Returns: + bool: A bool representing the record_operations_supported + """ + + return self.__record_operations_supported + + def set_record_operations_supported(self, record_operations_supported): + """ + The method to set the value to record_operations_supported + + Parameters: + record_operations_supported (bool) : A bool representing the record_operations_supported + """ + + if record_operations_supported is not None and not isinstance(record_operations_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_operations_supported EXPECTED TYPE: bool', None, None) + + self.__record_operations_supported = record_operations_supported + self.__key_modified['record_operations_supported'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/expression.py b/zohocrmsdk/src/com/zoho/crm/api/fields/expression.py new file mode 100644 index 0000000..882aa40 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/expression.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Expression(object): + def __init__(self): + """Creates an instance of Expression""" + + self.__function_parameters = None + self.__criteria = None + self.__function = None + self.__key_modified = dict() + + def get_function_parameters(self): + """ + The method to get the function_parameters + + Returns: + list: An instance of list + """ + + return self.__function_parameters + + def set_function_parameters(self, function_parameters): + """ + The method to set the value to function_parameters + + Parameters: + function_parameters (list) : An instance of list + """ + + if function_parameters is not None and not isinstance(function_parameters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: function_parameters EXPECTED TYPE: list', None, None) + + self.__function_parameters = function_parameters + self.__key_modified['function_parameters'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + RollupCriteria: An instance of RollupCriteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (RollupCriteria) : An instance of RollupCriteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.rollup_criteria import RollupCriteria + except Exception: + from .rollup_criteria import RollupCriteria + + if criteria is not None and not isinstance(criteria, RollupCriteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: RollupCriteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_function(self): + """ + The method to get the function + + Returns: + string: A string representing the function + """ + + return self.__function + + def set_function(self, function): + """ + The method to set the value to function + + Parameters: + function (string) : A string representing the function + """ + + if function is not None and not isinstance(function, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: function EXPECTED TYPE: str', None, None) + + self.__function = function + self.__key_modified['function'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/external.py b/zohocrmsdk/src/com/zoho/crm/api/fields/external.py new file mode 100644 index 0000000..942e95d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/external.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class External(object): + def __init__(self): + """Creates an instance of External""" + + self.__show = None + self.__type = None + self.__allow_multiple_config = None + self.__key_modified = dict() + + def get_show(self): + """ + The method to get the show + + Returns: + bool: A bool representing the show + """ + + return self.__show + + def set_show(self, show): + """ + The method to set the value to show + + Parameters: + show (bool) : A bool representing the show + """ + + if show is not None and not isinstance(show, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show EXPECTED TYPE: bool', None, None) + + self.__show = show + self.__key_modified['show'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_allow_multiple_config(self): + """ + The method to get the allow_multiple_config + + Returns: + bool: A bool representing the allow_multiple_config + """ + + return self.__allow_multiple_config + + def set_allow_multiple_config(self, allow_multiple_config): + """ + The method to set the value to allow_multiple_config + + Parameters: + allow_multiple_config (bool) : A bool representing the allow_multiple_config + """ + + if allow_multiple_config is not None and not isinstance(allow_multiple_config, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allow_multiple_config EXPECTED TYPE: bool', None, None) + + self.__allow_multiple_config = allow_multiple_config + self.__key_modified['allow_multiple_config'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/fields.py b/zohocrmsdk/src/com/zoho/crm/api/fields/fields.py new file mode 100644 index 0000000..af6bd1b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/fields.py @@ -0,0 +1,2135 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__associated_module = None + self.__data_type = None + self.__operation_type = None + self.__system_mandatory = None + self.__webhook = None + self.__sequence_number = None + self.__default_value = None + self.__blueprint_supported = None + self.__virtual_field = None + self.__field_read_only = None + self.__customizable_properties = None + self.__read_only = None + self.__custom_field = None + self.__businesscard_supported = None + self.__filterable = None + self.__visible = None + self.__available_in_user_layout = None + self.__display_field = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__layout_associations = None + self.__separator = None + self.__searchable = None + self.__enable_colour_code = None + self.__mass_update = None + self.__json_type = None + self.__created_source = None + self.__type = None + self.__display_label = None + self.__column_name = None + self.__api_name = None + self.__display_type = None + self.__ui_type = None + self.__colour_code_enabled_by_system = None + self.__length = None + self.__decimal_place = None + self.__quick_sequence_number = None + self.__email_parser = None + self.__rollup_summary = None + self.__refer_from_field = None + self.__created_time = None + self.__modified_time = None + self.__show_type = None + self.__category = None + self.__id = None + self.__multi_module_lookup = None + self.__sharing_properties = None + self.__currency = None + self.__file_upolad_optionlist = None + self.__lookup = None + self.__profiles = None + self.__view_type = None + self.__unique = None + self.__sub_module = None + self.__subform = None + self.__external = None + self.__formula = None + self.__private = None + self.__convert_mapping = None + self.__multiselectlookup = None + self.__multiuserlookup = None + self.__autonumber = None + self.__auto_number_61 = None + self.__pick_list_values = None + self.__crypt = None + self.__tooltip = None + self.__history_tracking = None + self.__association_details = None + self.__allowed_modules = None + self.__additional_column = None + self.__field_label = None + self.__global_picklist = None + self.__hipaa_compliance_enabled = None + self.__hipaa_compliance = None + self.__updateexistingrecords = None + self.__number_separator = None + self.__textarea = None + self.__static_field = None + self.__key_modified = dict() + + def get_associated_module(self): + """ + The method to get the associated_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__associated_module + + def set_associated_module(self, associated_module): + """ + The method to set the value to associated_module + + Parameters: + associated_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if associated_module is not None and not isinstance(associated_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__associated_module = associated_module + self.__key_modified['associated_module'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_operation_type(self): + """ + The method to get the operation_type + + Returns: + OperationType: An instance of OperationType + """ + + return self.__operation_type + + def set_operation_type(self, operation_type): + """ + The method to set the value to operation_type + + Parameters: + operation_type (OperationType) : An instance of OperationType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.operation_type import OperationType + except Exception: + from .operation_type import OperationType + + if operation_type is not None and not isinstance(operation_type, OperationType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_type EXPECTED TYPE: OperationType', None, None) + + self.__operation_type = operation_type + self.__key_modified['operation_type'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_default_value(self): + """ + The method to get the default_value + + Returns: + string: A string representing the default_value + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (string) : A string representing the default_value + """ + + if default_value is not None and not isinstance(default_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: str', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_blueprint_supported(self): + """ + The method to get the blueprint_supported + + Returns: + bool: A bool representing the blueprint_supported + """ + + return self.__blueprint_supported + + def set_blueprint_supported(self, blueprint_supported): + """ + The method to set the value to blueprint_supported + + Parameters: + blueprint_supported (bool) : A bool representing the blueprint_supported + """ + + if blueprint_supported is not None and not isinstance(blueprint_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: bool', None, None) + + self.__blueprint_supported = blueprint_supported + self.__key_modified['blueprint_supported'] = 1 + + def get_virtual_field(self): + """ + The method to get the virtual_field + + Returns: + bool: A bool representing the virtual_field + """ + + return self.__virtual_field + + def set_virtual_field(self, virtual_field): + """ + The method to set the value to virtual_field + + Parameters: + virtual_field (bool) : A bool representing the virtual_field + """ + + if virtual_field is not None and not isinstance(virtual_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: virtual_field EXPECTED TYPE: bool', None, None) + + self.__virtual_field = virtual_field + self.__key_modified['virtual_field'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_customizable_properties(self): + """ + The method to get the customizable_properties + + Returns: + list: An instance of list + """ + + return self.__customizable_properties + + def set_customizable_properties(self, customizable_properties): + """ + The method to set the value to customizable_properties + + Parameters: + customizable_properties (list) : An instance of list + """ + + if customizable_properties is not None and not isinstance(customizable_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable_properties EXPECTED TYPE: list', None, None) + + self.__customizable_properties = customizable_properties + self.__key_modified['customizable_properties'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_businesscard_supported(self): + """ + The method to get the businesscard_supported + + Returns: + bool: A bool representing the businesscard_supported + """ + + return self.__businesscard_supported + + def set_businesscard_supported(self, businesscard_supported): + """ + The method to set the value to businesscard_supported + + Parameters: + businesscard_supported (bool) : A bool representing the businesscard_supported + """ + + if businesscard_supported is not None and not isinstance(businesscard_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: bool', None, None) + + self.__businesscard_supported = businesscard_supported + self.__key_modified['businesscard_supported'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + bool: A bool representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (bool) : A bool representing the display_field + """ + + if display_field is not None and not isinstance(display_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: bool', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def get_separator(self): + """ + The method to get the separator + + Returns: + bool: A bool representing the separator + """ + + return self.__separator + + def set_separator(self, separator): + """ + The method to set the value to separator + + Parameters: + separator (bool) : A bool representing the separator + """ + + if separator is not None and not isinstance(separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: separator EXPECTED TYPE: bool', None, None) + + self.__separator = separator + self.__key_modified['separator'] = 1 + + def get_searchable(self): + """ + The method to get the searchable + + Returns: + bool: A bool representing the searchable + """ + + return self.__searchable + + def set_searchable(self, searchable): + """ + The method to set the value to searchable + + Parameters: + searchable (bool) : A bool representing the searchable + """ + + if searchable is not None and not isinstance(searchable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: searchable EXPECTED TYPE: bool', None, None) + + self.__searchable = searchable + self.__key_modified['searchable'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_mass_update(self): + """ + The method to get the mass_update + + Returns: + bool: A bool representing the mass_update + """ + + return self.__mass_update + + def set_mass_update(self, mass_update): + """ + The method to set the value to mass_update + + Parameters: + mass_update (bool) : A bool representing the mass_update + """ + + if mass_update is not None and not isinstance(mass_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: bool', None, None) + + self.__mass_update = mass_update + self.__key_modified['mass_update'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_colour_code_enabled_by_system(self): + """ + The method to get the colour_code_enabled_by_system + + Returns: + bool: A bool representing the colour_code_enabled_by_system + """ + + return self.__colour_code_enabled_by_system + + def set_colour_code_enabled_by_system(self, colour_code_enabled_by_system): + """ + The method to set the value to colour_code_enabled_by_system + + Parameters: + colour_code_enabled_by_system (bool) : A bool representing the colour_code_enabled_by_system + """ + + if colour_code_enabled_by_system is not None and not isinstance(colour_code_enabled_by_system, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code_enabled_by_system EXPECTED TYPE: bool', None, None) + + self.__colour_code_enabled_by_system = colour_code_enabled_by_system + self.__key_modified['colour_code_enabled_by_system'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + int: An int representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (int) : An int representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: int', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + string: A string representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (string) : A string representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: str', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_email_parser(self): + """ + The method to get the email_parser + + Returns: + EmailParser: An instance of EmailParser + """ + + return self.__email_parser + + def set_email_parser(self, email_parser): + """ + The method to set the value to email_parser + + Parameters: + email_parser (EmailParser) : An instance of EmailParser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.email_parser import EmailParser + except Exception: + from .email_parser import EmailParser + + if email_parser is not None and not isinstance(email_parser, EmailParser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser EXPECTED TYPE: EmailParser', None, None) + + self.__email_parser = email_parser + self.__key_modified['email_parser'] = 1 + + def get_rollup_summary(self): + """ + The method to get the rollup_summary + + Returns: + RollupSummary: An instance of RollupSummary + """ + + return self.__rollup_summary + + def set_rollup_summary(self, rollup_summary): + """ + The method to set the value to rollup_summary + + Parameters: + rollup_summary (RollupSummary) : An instance of RollupSummary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.rollup_summary import RollupSummary + except Exception: + from .rollup_summary import RollupSummary + + if rollup_summary is not None and not isinstance(rollup_summary, RollupSummary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_summary EXPECTED TYPE: RollupSummary', None, None) + + self.__rollup_summary = rollup_summary + self.__key_modified['rollup_summary'] = 1 + + def get_refer_from_field(self): + """ + The method to get the refer_from_field + + Returns: + ReferFromField: An instance of ReferFromField + """ + + return self.__refer_from_field + + def set_refer_from_field(self, refer_from_field): + """ + The method to set the value to refer_from_field + + Parameters: + refer_from_field (ReferFromField) : An instance of ReferFromField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.refer_from_field import ReferFromField + except Exception: + from .refer_from_field import ReferFromField + + if refer_from_field is not None and not isinstance(refer_from_field, ReferFromField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: refer_from_field EXPECTED TYPE: ReferFromField', None, None) + + self.__refer_from_field = refer_from_field + self.__key_modified['refer_from_field'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_show_type(self): + """ + The method to get the show_type + + Returns: + int: An int representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (int) : An int representing the show_type + """ + + if show_type is not None and not isinstance(show_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: int', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.multi_module_lookup import MultiModuleLookup + except Exception: + from .multi_module_lookup import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_sharing_properties(self): + """ + The method to get the sharing_properties + + Returns: + SharingProperties: An instance of SharingProperties + """ + + return self.__sharing_properties + + def set_sharing_properties(self, sharing_properties): + """ + The method to set the value to sharing_properties + + Parameters: + sharing_properties (SharingProperties) : An instance of SharingProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import SharingProperties + except Exception: + from ..modules import SharingProperties + + if sharing_properties is not None and not isinstance(sharing_properties, SharingProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_properties EXPECTED TYPE: SharingProperties', None, None) + + self.__sharing_properties = sharing_properties + self.__key_modified['sharing_properties'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.currency import Currency + except Exception: + from .currency import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_file_upolad_optionlist(self): + """ + The method to get the file_upolad_optionlist + + Returns: + list: An instance of list + """ + + return self.__file_upolad_optionlist + + def set_file_upolad_optionlist(self, file_upolad_optionlist): + """ + The method to set the value to file_upolad_optionlist + + Parameters: + file_upolad_optionlist (list) : An instance of list + """ + + if file_upolad_optionlist is not None and not isinstance(file_upolad_optionlist, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_upolad_optionlist EXPECTED TYPE: list', None, None) + + self.__file_upolad_optionlist = file_upolad_optionlist + self.__key_modified['file_upolad_optionlist'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Lookup: An instance of Lookup + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Lookup) : An instance of Lookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.lookup import Lookup + except Exception: + from .lookup import Lookup + + if lookup is not None and not isinstance(lookup, Lookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Lookup', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.view_type import ViewType + except Exception: + from .view_type import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.unique import Unique + except Exception: + from .unique import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if sub_module is not None and not isinstance(sub_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def get_subform(self): + """ + The method to get the subform + + Returns: + Subform: An instance of Subform + """ + + return self.__subform + + def set_subform(self, subform): + """ + The method to set the value to subform + + Parameters: + subform (Subform) : An instance of Subform + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.subform import Subform + except Exception: + from .subform import Subform + + if subform is not None and not isinstance(subform, Subform): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Subform', None, None) + + self.__subform = subform + self.__key_modified['subform'] = 1 + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.external import External + except Exception: + from .external import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.formula import Formula + except Exception: + from .formula import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.private import Private + except Exception: + from .private import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.convert_mapping import ConvertMapping + except Exception: + from .convert_mapping import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.multiselectlookup import Multiselectlookup + except Exception: + from .multiselectlookup import Multiselectlookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_multiuserlookup(self): + """ + The method to get the multiuserlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiuserlookup + + def set_multiuserlookup(self, multiuserlookup): + """ + The method to set the value to multiuserlookup + + Parameters: + multiuserlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.multiselectlookup import Multiselectlookup + except Exception: + from .multiselectlookup import Multiselectlookup + + if multiuserlookup is not None and not isinstance(multiuserlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiuserlookup = multiuserlookup + self.__key_modified['multiuserlookup'] = 1 + + def get_autonumber(self): + """ + The method to get the autonumber + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__autonumber + + def set_autonumber(self, autonumber): + """ + The method to set the value to autonumber + + Parameters: + autonumber (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.auto_number import AutoNumber + except Exception: + from .auto_number import AutoNumber + + if autonumber is not None and not isinstance(autonumber, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: autonumber EXPECTED TYPE: AutoNumber', None, None) + + self.__autonumber = autonumber + self.__key_modified['autonumber'] = 1 + + def get_auto_number_61(self): + """ + The method to get the auto_number_61 + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number_61 + + def set_auto_number_61(self, auto_number_61): + """ + The method to set the value to auto_number_61 + + Parameters: + auto_number_61 (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.auto_number import AutoNumber + except Exception: + from .auto_number import AutoNumber + + if auto_number_61 is not None and not isinstance(auto_number_61, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number_61 EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number_61 = auto_number_61 + self.__key_modified['auto_number'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.crypt import Crypt + except Exception: + from .crypt import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.tooltip import Tooltip + except Exception: + from .tooltip import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + HistoryTracking: An instance of HistoryTracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (HistoryTracking) : An instance of HistoryTracking + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.history_tracking import HistoryTracking + except Exception: + from .history_tracking import HistoryTracking + + if history_tracking is not None and not isinstance(history_tracking, HistoryTracking): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.association_details import AssociationDetails + except Exception: + from .association_details import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_allowed_modules(self): + """ + The method to get the allowed_modules + + Returns: + list: An instance of list + """ + + return self.__allowed_modules + + def set_allowed_modules(self, allowed_modules): + """ + The method to set the value to allowed_modules + + Parameters: + allowed_modules (list) : An instance of list + """ + + if allowed_modules is not None and not isinstance(allowed_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_modules EXPECTED TYPE: list', None, None) + + self.__allowed_modules = allowed_modules + self.__key_modified['allowed_modules'] = 1 + + def get_additional_column(self): + """ + The method to get the additional_column + + Returns: + string: A string representing the additional_column + """ + + return self.__additional_column + + def set_additional_column(self, additional_column): + """ + The method to set the value to additional_column + + Parameters: + additional_column (string) : A string representing the additional_column + """ + + if additional_column is not None and not isinstance(additional_column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: additional_column EXPECTED TYPE: str', None, None) + + self.__additional_column = additional_column + self.__key_modified['additional_column'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_global_picklist(self): + """ + The method to get the global_picklist + + Returns: + Object: A Object representing the global_picklist + """ + + return self.__global_picklist + + def set_global_picklist(self, global_picklist): + """ + The method to set the value to global_picklist + + Parameters: + global_picklist (Object) : A Object representing the global_picklist + """ + + self.__global_picklist = global_picklist + self.__key_modified['global_picklist'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.hipaa_compliance import HipaaCompliance + except Exception: + from .hipaa_compliance import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def get_updateexistingrecords(self): + """ + The method to get the updateexistingrecords + + Returns: + bool: A bool representing the updateexistingrecords + """ + + return self.__updateexistingrecords + + def set_updateexistingrecords(self, updateexistingrecords): + """ + The method to set the value to updateexistingrecords + + Parameters: + updateexistingrecords (bool) : A bool representing the updateexistingrecords + """ + + if updateexistingrecords is not None and not isinstance(updateexistingrecords, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updateexistingrecords EXPECTED TYPE: bool', None, None) + + self.__updateexistingrecords = updateexistingrecords + self.__key_modified['_update_existing_records'] = 1 + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + bool: A bool representing the number_separator + """ + + return self.__number_separator + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (bool) : A bool representing the number_separator + """ + + if number_separator is not None and not isinstance(number_separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: bool', None, None) + + self.__number_separator = number_separator + self.__key_modified['number_separator'] = 1 + + def get_textarea(self): + """ + The method to get the textarea + + Returns: + Textarea: An instance of Textarea + """ + + return self.__textarea + + def set_textarea(self, textarea): + """ + The method to set the value to textarea + + Parameters: + textarea (Textarea) : An instance of Textarea + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.textarea import Textarea + except Exception: + from .textarea import Textarea + + if textarea is not None and not isinstance(textarea, Textarea): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: textarea EXPECTED TYPE: Textarea', None, None) + + self.__textarea = textarea + self.__key_modified['textarea'] = 1 + + def get_static_field(self): + """ + The method to get the static_field + + Returns: + bool: A bool representing the static_field + """ + + return self.__static_field + + def set_static_field(self, static_field): + """ + The method to set the value to static_field + + Parameters: + static_field (bool) : A bool representing the static_field + """ + + if static_field is not None and not isinstance(static_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_field EXPECTED TYPE: bool', None, None) + + self.__static_field = static_field + self.__key_modified['static_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/fields_operations.py b/zohocrmsdk/src/com/zoho/crm/api/fields/fields_operations.py new file mode 100644 index 0000000..81105df --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/fields_operations.py @@ -0,0 +1,314 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class FieldsOperations(object): + def __init__(self): + """Creates an instance of FieldsOperations""" + pass + + def get_fields(self, param_instance=None): + """ + The method to get fields + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/fields' + 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.set_param(param_instance) + try: + from zohocrmsdk.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 create_field(self, request, param_instance=None): + """ + The method to create field + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/fields' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_fields(self, request, param_instance=None): + """ + The method to update fields + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/fields' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_field(self, field, param_instance=None): + """ + The method to get field + + Parameters: + field (int) : An int representing the field + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(field, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: int', None, None) + + 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/v7/settings/fields/' + api_path = api_path + str(field) + 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.set_param(param_instance) + try: + from zohocrmsdk.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 update_field(self, field, request, param_instance=None): + """ + The method to update field + + Parameters: + field (int) : An int representing the field + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(field, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field 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) + + 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/v7/settings/fields/' + api_path = api_path + str(field) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_field(self, field, param_instance=None): + """ + The method to delete field + + Parameters: + field (int) : An int representing the field + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(field, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: int', None, None) + + 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/v7/settings/fields/' + api_path = api_path + str(field) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetFieldsParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.GetFieldsParam') + data_type = Param('data_type', 'com.zoho.crm.api.Fields.GetFieldsParam') + type = Param('type', 'com.zoho.crm.api.Fields.GetFieldsParam') + include = Param('include', 'com.zoho.crm.api.Fields.GetFieldsParam') + feature_name = Param('feature_name', 'com.zoho.crm.api.Fields.GetFieldsParam') + component = Param('component', 'com.zoho.crm.api.Fields.GetFieldsParam') + layout_id = Param('layout_id', 'com.zoho.crm.api.Fields.GetFieldsParam') + + +class GetFieldsHeader(object): + pass + + +class CreateFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.CreateFieldParam') + + +class UpdateFieldsParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.UpdateFieldsParam') + + +class GetFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.GetFieldParam') + include = Param('include', 'com.zoho.crm.api.Fields.GetFieldParam') + + +class GetFieldHeader(object): + pass + + +class UpdateFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.UpdateFieldParam') + + +class DeleteFieldParam(object): + module = Param('module', 'com.zoho.crm.api.Fields.DeleteFieldParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/file_upolad_option.py b/zohocrmsdk/src/com/zoho/crm/api/fields/file_upolad_option.py new file mode 100644 index 0000000..a8fa70a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/file_upolad_option.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FileUpoladOption(object): + def __init__(self): + """Creates an instance of FileUpoladOption""" + + self.__actual_value = None + self.__display_value = None + self.__key_modified = dict() + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/forecast_category.py b/zohocrmsdk/src/com/zoho/crm/api/fields/forecast_category.py new file mode 100644 index 0000000..502f910 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/forecast_category.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ForecastCategory(object): + def __init__(self): + """Creates an instance of ForecastCategory""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/formula.py b/zohocrmsdk/src/com/zoho/crm/api/fields/formula.py new file mode 100644 index 0000000..e31c6e4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/formula.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Formula(object): + def __init__(self): + """Creates an instance of Formula""" + + self.__return_type = None + self.__expression = None + self.__key_modified = dict() + + def get_return_type(self): + """ + The method to get the return_type + + Returns: + string: A string representing the return_type + """ + + return self.__return_type + + def set_return_type(self, return_type): + """ + The method to set the value to return_type + + Parameters: + return_type (string) : A string representing the return_type + """ + + if return_type is not None and not isinstance(return_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: str', None, None) + + self.__return_type = return_type + self.__key_modified['return_type'] = 1 + + def get_expression(self): + """ + The method to get the expression + + Returns: + string: A string representing the expression + """ + + return self.__expression + + def set_expression(self, expression): + """ + The method to set the value to expression + + Parameters: + expression (string) : A string representing the expression + """ + + if expression is not None and not isinstance(expression, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: str', None, None) + + self.__expression = expression + self.__key_modified['expression'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/function_parameter.py b/zohocrmsdk/src/com/zoho/crm/api/fields/function_parameter.py new file mode 100644 index 0000000..6f22c9f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/function_parameter.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FunctionParameter(object): + def __init__(self): + """Creates an instance of FunctionParameter""" + + self.__api_name = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/hipaa_compliance.py b/zohocrmsdk/src/com/zoho/crm/api/fields/hipaa_compliance.py new file mode 100644 index 0000000..0c338e9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/hipaa_compliance.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HipaaCompliance(object): + def __init__(self): + """Creates an instance of HipaaCompliance""" + + self.__restricted_in_export = None + self.__restricted = None + self.__key_modified = dict() + + def get_restricted_in_export(self): + """ + The method to get the restricted_in_export + + Returns: + bool: A bool representing the restricted_in_export + """ + + return self.__restricted_in_export + + def set_restricted_in_export(self, restricted_in_export): + """ + The method to set the value to restricted_in_export + + Parameters: + restricted_in_export (bool) : A bool representing the restricted_in_export + """ + + if restricted_in_export is not None and not isinstance(restricted_in_export, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_in_export EXPECTED TYPE: bool', None, None) + + self.__restricted_in_export = restricted_in_export + self.__key_modified['restricted_in_export'] = 1 + + def get_restricted(self): + """ + The method to get the restricted + + Returns: + bool: A bool representing the restricted + """ + + return self.__restricted + + def set_restricted(self, restricted): + """ + The method to set the value to restricted + + Parameters: + restricted (bool) : A bool representing the restricted + """ + + if restricted is not None and not isinstance(restricted, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted EXPECTED TYPE: bool', None, None) + + self.__restricted = restricted + self.__key_modified['restricted'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking.py b/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking.py new file mode 100644 index 0000000..61eec83 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HistoryTracking(object): + def __init__(self): + """Creates an instance of HistoryTracking""" + + self.__module = None + self.__duration_configured_field = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + HistoryTrackingModule: An instance of HistoryTrackingModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (HistoryTrackingModule) : An instance of HistoryTrackingModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.history_tracking_module import HistoryTrackingModule + except Exception: + from .history_tracking_module import HistoryTrackingModule + + if module is not None and not isinstance(module, HistoryTrackingModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: HistoryTrackingModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_duration_configured_field(self): + """ + The method to get the duration_configured_field + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__duration_configured_field + + def set_duration_configured_field(self, duration_configured_field): + """ + The method to set the value to duration_configured_field + + Parameters: + duration_configured_field (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if duration_configured_field is not None and not isinstance(duration_configured_field, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duration_configured_field EXPECTED TYPE: MinifiedModule', None, None) + + self.__duration_configured_field = duration_configured_field + self.__key_modified['duration_configured_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking_module.py b/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking_module.py new file mode 100644 index 0000000..3fc5140 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/history_tracking_module.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HistoryTrackingModule(object): + def __init__(self): + """Creates an instance of HistoryTrackingModule""" + + self.__layout = None + self.__display_label = None + self.__api_name = None + self.__module = None + self.__id = None + self.__module_name = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layouts: An instance of Layouts + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layouts) : An instance of Layouts + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts import Layouts + except Exception: + from ..layouts import Layouts + + if layout is not None and not isinstance(layout, Layouts): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layouts', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + HistoryTrackingModule: An instance of HistoryTrackingModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (HistoryTrackingModule) : An instance of HistoryTrackingModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.history_tracking_module import HistoryTrackingModule + except Exception: + from .history_tracking_module import HistoryTrackingModule + + if module is not None and not isinstance(module, HistoryTrackingModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: HistoryTrackingModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/layout_association.py b/zohocrmsdk/src/com/zoho/crm/api/fields/layout_association.py new file mode 100644 index 0000000..615c716 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/layout_association.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LayoutAssociation(object): + def __init__(self): + """Creates an instance of LayoutAssociation""" + + self.__api_name = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/lookup.py b/zohocrmsdk/src/com/zoho/crm/api/fields/lookup.py new file mode 100644 index 0000000..40a08d9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/lookup.py @@ -0,0 +1,234 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Lookup(object): + def __init__(self): + """Creates an instance of Lookup""" + + self.__display_label = None + self.__api_name = None + self.__query_details = None + self.__module = None + self.__id = None + self.__revalidate_filter_during_edit = None + self.__show_fields = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_query_details(self): + """ + The method to get the query_details + + Returns: + QueryDetails: An instance of QueryDetails + """ + + return self.__query_details + + def set_query_details(self, query_details): + """ + The method to set the value to query_details + + Parameters: + query_details (QueryDetails) : An instance of QueryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.query_details import QueryDetails + except Exception: + from .query_details import QueryDetails + + if query_details is not None and not isinstance(query_details, QueryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_details EXPECTED TYPE: QueryDetails', None, None) + + self.__query_details = query_details + self.__key_modified['query_details'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_revalidate_filter_during_edit(self): + """ + The method to get the revalidate_filter_during_edit + + Returns: + bool: A bool representing the revalidate_filter_during_edit + """ + + return self.__revalidate_filter_during_edit + + def set_revalidate_filter_during_edit(self, revalidate_filter_during_edit): + """ + The method to set the value to revalidate_filter_during_edit + + Parameters: + revalidate_filter_during_edit (bool) : A bool representing the revalidate_filter_during_edit + """ + + if revalidate_filter_during_edit is not None and not isinstance(revalidate_filter_during_edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: revalidate_filter_during_edit EXPECTED TYPE: bool', None, None) + + self.__revalidate_filter_during_edit = revalidate_filter_during_edit + self.__key_modified['revalidate_filter_during_edit'] = 1 + + def get_show_fields(self): + """ + The method to get the show_fields + + Returns: + list: An instance of list + """ + + return self.__show_fields + + def set_show_fields(self, show_fields): + """ + The method to set the value to show_fields + + Parameters: + show_fields (list) : An instance of list + """ + + if show_fields is not None and not isinstance(show_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_fields EXPECTED TYPE: list', None, None) + + self.__show_fields = show_fields + self.__key_modified['show_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/mandatory_details.py b/zohocrmsdk/src/com/zoho/crm/api/fields/mandatory_details.py new file mode 100644 index 0000000..6ee3c77 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/mandatory_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MandatoryDetails(object): + def __init__(self): + """Creates an instance of MandatoryDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/maps.py b/zohocrmsdk/src/com/zoho/crm/api/fields/maps.py new file mode 100644 index 0000000..da59ce0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/maps.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Maps(object): + def __init__(self): + """Creates an instance of Maps""" + + self.__api_name = None + self.__pick_list_values = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/minified_field.py b/zohocrmsdk/src/com/zoho/crm/api/fields/minified_field.py new file mode 100644 index 0000000..472ee6d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/minified_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedField(object): + def __init__(self): + """Creates an instance of MinifiedField""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/multi_module_lookup.py b/zohocrmsdk/src/com/zoho/crm/api/fields/multi_module_lookup.py new file mode 100644 index 0000000..106f35c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/multi_module_lookup.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiModuleLookup(object): + def __init__(self): + """Creates an instance of MultiModuleLookup""" + + self.__display_label = None + self.__api_name = None + self.__modules = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/multiselectlookup.py b/zohocrmsdk/src/com/zoho/crm/api/fields/multiselectlookup.py new file mode 100644 index 0000000..18e2dc6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/multiselectlookup.py @@ -0,0 +1,284 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Multiselectlookup(object): + def __init__(self): + """Creates an instance of Multiselectlookup""" + + self.__display_label = None + self.__linking_module = None + self.__connected_module = None + self.__lookup_apiname = None + self.__api_name = None + self.__connectedfield_apiname = None + self.__connectedlookup_apiname = None + self.__id = None + self.__record_access = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_linking_module(self): + """ + The method to get the linking_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__linking_module + + def set_linking_module(self, linking_module): + """ + The method to set the value to linking_module + + Parameters: + linking_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if linking_module is not None and not isinstance(linking_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linking_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__linking_module = linking_module + self.__key_modified['linking_module'] = 1 + + def get_connected_module(self): + """ + The method to get the connected_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__connected_module + + def set_connected_module(self, connected_module): + """ + The method to set the value to connected_module + + Parameters: + connected_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if connected_module is not None and not isinstance(connected_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: connected_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__connected_module = connected_module + self.__key_modified['connected_module'] = 1 + + def get_lookup_apiname(self): + """ + The method to get the lookup_apiname + + Returns: + string: A string representing the lookup_apiname + """ + + return self.__lookup_apiname + + def set_lookup_apiname(self, lookup_apiname): + """ + The method to set the value to lookup_apiname + + Parameters: + lookup_apiname (string) : A string representing the lookup_apiname + """ + + if lookup_apiname is not None and not isinstance(lookup_apiname, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_apiname EXPECTED TYPE: str', None, None) + + self.__lookup_apiname = lookup_apiname + self.__key_modified['lookup_apiname'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_connectedfield_apiname(self): + """ + The method to get the connectedfield_apiname + + Returns: + string: A string representing the connectedfield_apiname + """ + + return self.__connectedfield_apiname + + def set_connectedfield_apiname(self, connectedfield_apiname): + """ + The method to set the value to connectedfield_apiname + + Parameters: + connectedfield_apiname (string) : A string representing the connectedfield_apiname + """ + + if connectedfield_apiname is not None and not isinstance(connectedfield_apiname, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: connectedfield_apiname EXPECTED TYPE: str', None, None) + + self.__connectedfield_apiname = connectedfield_apiname + self.__key_modified['connectedfield_apiname'] = 1 + + def get_connectedlookup_apiname(self): + """ + The method to get the connectedlookup_apiname + + Returns: + string: A string representing the connectedlookup_apiname + """ + + return self.__connectedlookup_apiname + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_record_access(self): + """ + The method to get the record_access + + Returns: + bool: A bool representing the record_access + """ + + return self.__record_access + + def set_record_access(self, record_access): + """ + The method to set the value to record_access + + Parameters: + record_access (bool) : A bool representing the record_access + """ + + if record_access is not None and not isinstance(record_access, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_access EXPECTED TYPE: bool', None, None) + + self.__record_access = record_access + self.__key_modified['record_access'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/operation_type.py b/zohocrmsdk/src/com/zoho/crm/api/fields/operation_type.py new file mode 100644 index 0000000..1ff5ab7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/operation_type.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OperationType(object): + def __init__(self): + """Creates an instance of OperationType""" + + self.__web_update = None + self.__api_create = None + self.__web_create = None + self.__api_update = None + self.__key_modified = dict() + + def get_web_update(self): + """ + The method to get the web_update + + Returns: + bool: A bool representing the web_update + """ + + return self.__web_update + + def set_web_update(self, web_update): + """ + The method to set the value to web_update + + Parameters: + web_update (bool) : A bool representing the web_update + """ + + if web_update is not None and not isinstance(web_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: web_update EXPECTED TYPE: bool', None, None) + + self.__web_update = web_update + self.__key_modified['web_update'] = 1 + + def get_api_create(self): + """ + The method to get the api_create + + Returns: + bool: A bool representing the api_create + """ + + return self.__api_create + + def set_api_create(self, api_create): + """ + The method to set the value to api_create + + Parameters: + api_create (bool) : A bool representing the api_create + """ + + if api_create is not None and not isinstance(api_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_create EXPECTED TYPE: bool', None, None) + + self.__api_create = api_create + self.__key_modified['api_create'] = 1 + + def get_web_create(self): + """ + The method to get the web_create + + Returns: + bool: A bool representing the web_create + """ + + return self.__web_create + + def set_web_create(self, web_create): + """ + The method to set the value to web_create + + Parameters: + web_create (bool) : A bool representing the web_create + """ + + if web_create is not None and not isinstance(web_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: web_create EXPECTED TYPE: bool', None, None) + + self.__web_create = web_create + self.__key_modified['web_create'] = 1 + + def get_api_update(self): + """ + The method to get the api_update + + Returns: + bool: A bool representing the api_update + """ + + return self.__api_update + + def set_api_update(self, api_update): + """ + The method to set the value to api_update + + Parameters: + api_update (bool) : A bool representing the api_update + """ + + if api_update is not None and not isinstance(api_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_update EXPECTED TYPE: bool', None, None) + + self.__api_update = api_update + self.__key_modified['api_update'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/pick_list_value.py b/zohocrmsdk/src/com/zoho/crm/api/fields/pick_list_value.py new file mode 100644 index 0000000..f26d32e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/pick_list_value.py @@ -0,0 +1,354 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class PickListValue(object): + def __init__(self): + """Creates an instance of PickListValue""" + + self.__colour_code = None + self.__actual_value = None + self.__type = None + self.__id = None + self.__sequence_number = None + self.__display_value = None + self.__probability = None + self.__forecast_category = None + self.__expected_data_type = None + self.__sys_ref_name = None + self.__forecast_type = None + self.__maps = None + self.__key_modified = dict() + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_probability(self): + """ + The method to get the probability + + Returns: + int: An int representing the probability + """ + + return self.__probability + + def set_probability(self, probability): + """ + The method to set the value to probability + + Parameters: + probability (int) : An int representing the probability + """ + + if probability is not None and not isinstance(probability, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: probability EXPECTED TYPE: int', None, None) + + self.__probability = probability + self.__key_modified['probability'] = 1 + + def get_forecast_category(self): + """ + The method to get the forecast_category + + Returns: + ForecastCategory: An instance of ForecastCategory + """ + + return self.__forecast_category + + def set_forecast_category(self, forecast_category): + """ + The method to set the value to forecast_category + + Parameters: + forecast_category (ForecastCategory) : An instance of ForecastCategory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.forecast_category import ForecastCategory + except Exception: + from .forecast_category import ForecastCategory + + if forecast_category is not None and not isinstance(forecast_category, ForecastCategory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_category EXPECTED TYPE: ForecastCategory', None, None) + + self.__forecast_category = forecast_category + self.__key_modified['forecast_category'] = 1 + + def get_expected_data_type(self): + """ + The method to get the expected_data_type + + Returns: + string: A string representing the expected_data_type + """ + + return self.__expected_data_type + + def set_expected_data_type(self, expected_data_type): + """ + The method to set the value to expected_data_type + + Parameters: + expected_data_type (string) : A string representing the expected_data_type + """ + + if expected_data_type is not None and not isinstance(expected_data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expected_data_type EXPECTED TYPE: str', None, None) + + self.__expected_data_type = expected_data_type + self.__key_modified['expected_data_type'] = 1 + + def get_sys_ref_name(self): + """ + The method to get the sys_ref_name + + Returns: + string: A string representing the sys_ref_name + """ + + return self.__sys_ref_name + + def set_sys_ref_name(self, sys_ref_name): + """ + The method to set the value to sys_ref_name + + Parameters: + sys_ref_name (string) : A string representing the sys_ref_name + """ + + if sys_ref_name is not None and not isinstance(sys_ref_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sys_ref_name EXPECTED TYPE: str', None, None) + + self.__sys_ref_name = sys_ref_name + self.__key_modified['sys_ref_name'] = 1 + + def get_forecast_type(self): + """ + The method to get the forecast_type + + Returns: + string: A string representing the forecast_type + """ + + return self.__forecast_type + + def set_forecast_type(self, forecast_type): + """ + The method to set the value to forecast_type + + Parameters: + forecast_type (string) : A string representing the forecast_type + """ + + if forecast_type is not None and not isinstance(forecast_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_type EXPECTED TYPE: str', None, None) + + self.__forecast_type = forecast_type + self.__key_modified['forecast_type'] = 1 + + def get_maps(self): + """ + The method to get the maps + + Returns: + list: An instance of list + """ + + return self.__maps + + def set_maps(self, maps): + """ + The method to set the value to maps + + Parameters: + maps (list) : An instance of list + """ + + if maps is not None and not isinstance(maps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: list', None, None) + + self.__maps = maps + self.__key_modified['maps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/private.py b/zohocrmsdk/src/com/zoho/crm/api/fields/private.py new file mode 100644 index 0000000..ad849e1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/private.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Private(object): + def __init__(self): + """Creates an instance of Private""" + + self.__restricted = None + self.__type = None + self.__export = None + self.__key_modified = dict() + + def get_restricted(self): + """ + The method to get the restricted + + Returns: + bool: A bool representing the restricted + """ + + return self.__restricted + + def set_restricted(self, restricted): + """ + The method to set the value to restricted + + Parameters: + restricted (bool) : A bool representing the restricted + """ + + if restricted is not None and not isinstance(restricted, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted EXPECTED TYPE: bool', None, None) + + self.__restricted = restricted + self.__key_modified['restricted'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_export(self): + """ + The method to get the export + + Returns: + bool: A bool representing the export + """ + + return self.__export + + def set_export(self, export): + """ + The method to set the value to export + + Parameters: + export (bool) : A bool representing the export + """ + + if export is not None and not isinstance(export, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: export EXPECTED TYPE: bool', None, None) + + self.__export = export + self.__key_modified['export'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/profile.py b/zohocrmsdk/src/com/zoho/crm/api/fields/profile.py new file mode 100644 index 0000000..239ea71 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/profile.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__name = None + self.__id = None + self.__permission_type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + string: A string representing the permission_type + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (string) : A string representing the permission_type + """ + + if permission_type is not None and not isinstance(permission_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: str', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/query_details.py b/zohocrmsdk/src/com/zoho/crm/api/fields/query_details.py new file mode 100644 index 0000000..6d09f04 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/query_details.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class QueryDetails(object): + def __init__(self): + """Creates an instance of QueryDetails""" + + self.__query_id = None + self.__criteria = None + self.__key_modified = dict() + + def get_query_id(self): + """ + The method to get the query_id + + Returns: + int: An int representing the query_id + """ + + return self.__query_id + + def set_query_id(self, query_id): + """ + The method to set the value to query_id + + Parameters: + query_id (int) : An int representing the query_id + """ + + if query_id is not None and not isinstance(query_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_id EXPECTED TYPE: int', None, None) + + self.__query_id = query_id + self.__key_modified['query_id'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/refer_from_field.py b/zohocrmsdk/src/com/zoho/crm/api/fields/refer_from_field.py new file mode 100644 index 0000000..20ebb50 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/refer_from_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReferFromField(object): + def __init__(self): + """Creates an instance of ReferFromField""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/fields/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/fields/response_wrapper.py new file mode 100644 index 0000000..fa47a01 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_criteria.py b/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_criteria.py new file mode 100644 index 0000000..1e07caa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_criteria.py @@ -0,0 +1,126 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RollupCriteria(object): + def __init__(self): + """Creates an instance of RollupCriteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_summary.py b/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_summary.py new file mode 100644 index 0000000..559d5bc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/rollup_summary.py @@ -0,0 +1,189 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RollupSummary(object): + def __init__(self): + """Creates an instance of RollupSummary""" + + self.__return_type = None + self.__expression = None + self.__based_on_module = None + self.__related_list = None + self.__rollup_based_on = None + self.__key_modified = dict() + + def get_return_type(self): + """ + The method to get the return_type + + Returns: + string: A string representing the return_type + """ + + return self.__return_type + + def set_return_type(self, return_type): + """ + The method to set the value to return_type + + Parameters: + return_type (string) : A string representing the return_type + """ + + if return_type is not None and not isinstance(return_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_type EXPECTED TYPE: str', None, None) + + self.__return_type = return_type + self.__key_modified['return_type'] = 1 + + def get_expression(self): + """ + The method to get the expression + + Returns: + Expression: An instance of Expression + """ + + return self.__expression + + def set_expression(self, expression): + """ + The method to set the value to expression + + Parameters: + expression (Expression) : An instance of Expression + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.expression import Expression + except Exception: + from .expression import Expression + + if expression is not None and not isinstance(expression, Expression): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expression EXPECTED TYPE: Expression', None, None) + + self.__expression = expression + self.__key_modified['expression'] = 1 + + def get_based_on_module(self): + """ + The method to get the based_on_module + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__based_on_module + + def set_based_on_module(self, based_on_module): + """ + The method to set the value to based_on_module + + Parameters: + based_on_module (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if based_on_module is not None and not isinstance(based_on_module, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: based_on_module EXPECTED TYPE: MinifiedField', None, None) + + self.__based_on_module = based_on_module + self.__key_modified['based_on_module'] = 1 + + def get_related_list(self): + """ + The method to get the related_list + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__related_list + + def set_related_list(self, related_list): + """ + The method to set the value to related_list + + Parameters: + related_list (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if related_list is not None and not isinstance(related_list, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_list EXPECTED TYPE: MinifiedField', None, None) + + self.__related_list = related_list + self.__key_modified['related_list'] = 1 + + def get_rollup_based_on(self): + """ + The method to get the rollup_based_on + + Returns: + string: A string representing the rollup_based_on + """ + + return self.__rollup_based_on + + def set_rollup_based_on(self, rollup_based_on): + """ + The method to set the value to rollup_based_on + + Parameters: + rollup_based_on (string) : A string representing the rollup_based_on + """ + + if rollup_based_on is not None and not isinstance(rollup_based_on, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_based_on EXPECTED TYPE: str', None, None) + + self.__rollup_based_on = rollup_based_on + self.__key_modified['rollup_based_on'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/sharing_properties.py b/zohocrmsdk/src/com/zoho/crm/api/fields/sharing_properties.py new file mode 100644 index 0000000..aeb4540 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/sharing_properties.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SharingProperties(object): + def __init__(self): + """Creates an instance of SharingProperties""" + + self.__scheduler_status = None + self.__share_preference_enabled = None + self.__share_permission = None + self.__key_modified = dict() + + def get_scheduler_status(self): + """ + The method to get the scheduler_status + + Returns: + string: A string representing the scheduler_status + """ + + return self.__scheduler_status + + def set_scheduler_status(self, scheduler_status): + """ + The method to set the value to scheduler_status + + Parameters: + scheduler_status (string) : A string representing the scheduler_status + """ + + if scheduler_status is not None and not isinstance(scheduler_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduler_status EXPECTED TYPE: str', None, None) + + self.__scheduler_status = scheduler_status + self.__key_modified['scheduler_status'] = 1 + + def get_share_preference_enabled(self): + """ + The method to get the share_preference_enabled + + Returns: + bool: A bool representing the share_preference_enabled + """ + + return self.__share_preference_enabled + + def set_share_preference_enabled(self, share_preference_enabled): + """ + The method to set the value to share_preference_enabled + + Parameters: + share_preference_enabled (bool) : A bool representing the share_preference_enabled + """ + + if share_preference_enabled is not None and not isinstance(share_preference_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_preference_enabled EXPECTED TYPE: bool', None, None) + + self.__share_preference_enabled = share_preference_enabled + self.__key_modified['share_preference_enabled'] = 1 + + def get_share_permission(self): + """ + The method to get the share_permission + + Returns: + Choice: An instance of Choice + """ + + return self.__share_permission + + def set_share_permission(self, share_permission): + """ + The method to set the value to share_permission + + Parameters: + share_permission (Choice) : An instance of Choice + """ + + if share_permission is not None and not isinstance(share_permission, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_permission EXPECTED TYPE: Choice', None, None) + + self.__share_permission = share_permission + self.__key_modified['share_permission'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/show_fields.py b/zohocrmsdk/src/com/zoho/crm/api/fields/show_fields.py new file mode 100644 index 0000000..deee745 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/show_fields.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShowFields(object): + def __init__(self): + """Creates an instance of ShowFields""" + + self.__show_data = None + self.__field = None + self.__key_modified = dict() + + def get_show_data(self): + """ + The method to get the show_data + + Returns: + bool: A bool representing the show_data + """ + + return self.__show_data + + def set_show_data(self, show_data): + """ + The method to set the value to show_data + + Parameters: + show_data (bool) : A bool representing the show_data + """ + + if show_data is not None and not isinstance(show_data, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_data EXPECTED TYPE: bool', None, None) + + self.__show_data = show_data + self.__key_modified['show_data'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields.minified_field import MinifiedField + except Exception: + from .minified_field import MinifiedField + + if field is not None and not isinstance(field, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: MinifiedField', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/subform.py b/zohocrmsdk/src/com/zoho/crm/api/fields/subform.py new file mode 100644 index 0000000..8dce54d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/subform.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Subform(object): + def __init__(self): + """Creates an instance of Subform""" + + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/fields/success_response.py new file mode 100644 index 0000000..d27a86b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fields.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/textarea.py b/zohocrmsdk/src/com/zoho/crm/api/fields/textarea.py new file mode 100644 index 0000000..f85bf55 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/textarea.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Textarea(object): + def __init__(self): + """Creates an instance of Textarea""" + + self.__type = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/tooltip.py b/zohocrmsdk/src/com/zoho/crm/api/fields/tooltip.py new file mode 100644 index 0000000..5637a62 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/tooltip.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tooltip(object): + def __init__(self): + """Creates an instance of Tooltip""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/unique.py b/zohocrmsdk/src/com/zoho/crm/api/fields/unique.py new file mode 100644 index 0000000..a3d499d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/unique.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Unique(object): + def __init__(self): + """Creates an instance of Unique""" + + self.__casesensitive = None + self.__key_modified = dict() + + def get_casesensitive(self): + """ + The method to get the casesensitive + + Returns: + string: A string representing the casesensitive + """ + + return self.__casesensitive + + def set_casesensitive(self, casesensitive): + """ + The method to set the value to casesensitive + + Parameters: + casesensitive (string) : A string representing the casesensitive + """ + + if casesensitive is not None and not isinstance(casesensitive, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: casesensitive EXPECTED TYPE: str', None, None) + + self.__casesensitive = casesensitive + self.__key_modified['casesensitive'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fields/view_type.py b/zohocrmsdk/src/com/zoho/crm/api/fields/view_type.py new file mode 100644 index 0000000..be78bd4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fields/view_type.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ViewType(object): + def __init__(self): + """Creates an instance of ViewType""" + + self.__view = None + self.__edit = None + self.__quick_create = None + self.__create = None + self.__key_modified = dict() + + def get_view(self): + """ + The method to get the view + + Returns: + bool: A bool representing the view + """ + + return self.__view + + def set_view(self, view): + """ + The method to set the value to view + + Parameters: + view (bool) : A bool representing the view + """ + + if view is not None and not isinstance(view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view EXPECTED TYPE: bool', None, None) + + self.__view = view + self.__key_modified['view'] = 1 + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_quick_create(self): + """ + The method to get the quick_create + + Returns: + bool: A bool representing the quick_create + """ + + return self.__quick_create + + def set_quick_create(self, quick_create): + """ + The method to set the value to quick_create + + Parameters: + quick_create (bool) : A bool representing the quick_create + """ + + if quick_create is not None and not isinstance(quick_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_create EXPECTED TYPE: bool', None, None) + + self.__quick_create = quick_create + self.__key_modified['quick_create'] = 1 + + def get_create(self): + """ + The method to get the create + + Returns: + bool: A bool representing the create + """ + + return self.__create + + def set_create(self, create): + """ + The method to set the value to create + + Parameters: + create (bool) : A bool representing the create + """ + + if create is not None and not isinstance(create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create EXPECTED TYPE: bool', None, None) + + self.__create = create + self.__key_modified['create'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/files/__init__.py new file mode 100644 index 0000000..5d0fe34 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/__init__.py @@ -0,0 +1,9 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .files_operations import FilesOperations, UploadFilesParam, UploadFilesHeader, GetFileParam diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/files/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/files/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/files/action_wrapper.py new file mode 100644 index 0000000..3f3af91 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.files.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/files/api_exception.py new file mode 100644 index 0000000..374cdf3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.files.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.files.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/files/body_wrapper.py new file mode 100644 index 0000000..5546eee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + list: An instance of list + """ + + return self.__file + + def set_file(self, file): + """ + The method to set the value to file + + Parameters: + file (list) : An instance of list + """ + + if file is not None and not isinstance(file, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file EXPECTED TYPE: list', None, None) + + self.__file = file + self.__key_modified['file'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/files/file_body_wrapper.py new file mode 100644 index 0000000..cf98187 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.files.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/files_operations.py b/zohocrmsdk/src/com/zoho/crm/api/files/files_operations.py new file mode 100644 index 0000000..0f3c93f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/files_operations.py @@ -0,0 +1,108 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FilesOperations(object): + def __init__(self): + """Creates an instance of FilesOperations""" + pass + + def upload_files(self, request, param_instance=None): + """ + The method to upload files + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.files.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/files' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.files.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_file(self, param_instance=None): + """ + The method to get file + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/files' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.files.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/x-download') + + +class UploadFilesParam(object): + type = Param('type', 'com.zoho.crm.api.Files.UploadFilesParam') + + +class UploadFilesHeader(object): + pass + + +class GetFileParam(object): + id = Param('id', 'com.zoho.crm.api.Files.GetFileParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/files/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/files/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/files/success_response.py new file mode 100644 index 0000000..fcdc80a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/files/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.files.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/__init__.py new file mode 100644 index 0000000..fb7efa8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .body_wrapper import BodyWrapper +from .master_record_fields import MasterRecordFields +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .merge import Merge +from .image_data import ImageData +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .find_and_merge_operations import FindAndMergeOperations, GetRecordMergeParam +from .data_fields import DataFields +from .merge_data import MergeData diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_wrapper.py new file mode 100644 index 0000000..d8c3ec2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__merge = None + self.__key_modified = dict() + + def get_merge(self): + """ + The method to get the merge + + Returns: + list: An instance of list + """ + + return self.__merge + + def set_merge(self, merge): + """ + The method to set the value to merge + + Parameters: + merge (list) : An instance of list + """ + + if merge is not None and not isinstance(merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: merge EXPECTED TYPE: list', None, None) + + self.__merge = merge + self.__key_modified['merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/api_exception.py new file mode 100644 index 0000000..6af12de --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/body_wrapper.py new file mode 100644 index 0000000..3c0b528 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__merge = None + self.__key_modified = dict() + + def get_merge(self): + """ + The method to get the merge + + Returns: + list: An instance of list + """ + + return self.__merge + + def set_merge(self, merge): + """ + The method to set the value to merge + + Parameters: + merge (list) : An instance of list + """ + + if merge is not None and not isinstance(merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: merge EXPECTED TYPE: list', None, None) + + self.__merge = merge + self.__key_modified['merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/data_fields.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/data_fields.py new file mode 100644 index 0000000..a206fe3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/data_fields.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataFields(object): + def __init__(self): + """Creates an instance of DataFields""" + + self.__api_name = None + self.__data = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['_data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/find_and_merge_operations.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/find_and_merge_operations.py new file mode 100644 index 0000000..f069dd8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/find_and_merge_operations.py @@ -0,0 +1,113 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class FindAndMergeOperations(object): + def __init__(self, module, masterrecordid): + """ + Creates an instance of FindAndMergeOperations with the given parameters + + Parameters: + module (string) : A string representing the module + masterrecordid (int) : An int representing the masterrecordid + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(masterrecordid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: masterrecordid EXPECTED TYPE: int', None, None) + + self.__module = module + self.__masterrecordid = masterrecordid + + + def get_record_merge(self, param_instance=None): + """ + The method to get record merge + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__masterrecordid) + api_path = api_path + '/actions/merge' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def merge_records(self, request): + """ + The method to merge records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__masterrecordid) + api_path = api_path + '/actions/merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetRecordMergeParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.FindAndMerge.GetRecordMergeParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/image_data.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/image_data.py new file mode 100644 index 0000000..5e1d646 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/image_data.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ImageData(object): + def __init__(self): + """Creates an instance of ImageData""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/master_record_fields.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/master_record_fields.py new file mode 100644 index 0000000..02bd986 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/master_record_fields.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MasterRecordFields(object): + def __init__(self): + """Creates an instance of MasterRecordFields""" + + self.__api_name = None + self.__data = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['_data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge.py new file mode 100644 index 0000000..39f1e32 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Merge(object): + def __init__(self): + """Creates an instance of Merge""" + + self.__job_id = None + self.__status = None + self.__data = None + self.__master_record_fields = None + self.__key_modified = dict() + + def get_job_id(self): + """ + The method to get the job_id + + Returns: + int: An int representing the job_id + """ + + return self.__job_id + + def set_job_id(self, job_id): + """ + The method to set the value to job_id + + Parameters: + job_id (int) : An int representing the job_id + """ + + if job_id is not None and not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + self.__job_id = job_id + self.__key_modified['job_id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_master_record_fields(self): + """ + The method to get the master_record_fields + + Returns: + list: An instance of list + """ + + return self.__master_record_fields + + def set_master_record_fields(self, master_record_fields): + """ + The method to set the value to master_record_fields + + Parameters: + master_record_fields (list) : An instance of list + """ + + if master_record_fields is not None and not isinstance(master_record_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: master_record_fields EXPECTED TYPE: list', None, None) + + self.__master_record_fields = master_record_fields + self.__key_modified['master_record_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge_data.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge_data.py new file mode 100644 index 0000000..02a0909 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/merge_data.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MergeData(object): + def __init__(self): + """Creates an instance of MergeData""" + + self.__fields = None + self.__id = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['_fields'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_wrapper.py new file mode 100644 index 0000000..1ca51be --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__merge = None + self.__key_modified = dict() + + def get_merge(self): + """ + The method to get the merge + + Returns: + list: An instance of list + """ + + return self.__merge + + def set_merge(self, merge): + """ + The method to set the value to merge + + Parameters: + merge (list) : An instance of list + """ + + if merge is not None and not isinstance(merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: merge EXPECTED TYPE: list', None, None) + + self.__merge = merge + self.__key_modified['merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/success_response.py new file mode 100644 index 0000000..7177c25 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/find_and_merge/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.find_and_merge.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/__init__.py new file mode 100644 index 0000000..470e40e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .year import Year +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .fiscal_year_operations import FiscalYearOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_wrapper.py new file mode 100644 index 0000000..7ca56d5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__fiscal_year = None + self.__key_modified = dict() + + def get_fiscal_year(self): + """ + The method to get the fiscal_year + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__fiscal_year + + def set_fiscal_year(self, fiscal_year): + """ + The method to set the value to fiscal_year + + Parameters: + fiscal_year (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if fiscal_year is not None and not isinstance(fiscal_year, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fiscal_year EXPECTED TYPE: ActionResponse', None, None) + + self.__fiscal_year = fiscal_year + self.__key_modified['fiscal_year'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/api_exception.py new file mode 100644 index 0000000..02689a1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/body_wrapper.py new file mode 100644 index 0000000..e7c178a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__fiscal_year = None + self.__key_modified = dict() + + def get_fiscal_year(self): + """ + The method to get the fiscal_year + + Returns: + Year: An instance of Year + """ + + return self.__fiscal_year + + def set_fiscal_year(self, fiscal_year): + """ + The method to set the value to fiscal_year + + Parameters: + fiscal_year (Year) : An instance of Year + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.year import Year + except Exception: + from .year import Year + + if fiscal_year is not None and not isinstance(fiscal_year, Year): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fiscal_year EXPECTED TYPE: Year', None, None) + + self.__fiscal_year = fiscal_year + self.__key_modified['fiscal_year'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/fiscal_year_operations.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/fiscal_year_operations.py new file mode 100644 index 0000000..73e6439 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/fiscal_year_operations.py @@ -0,0 +1,72 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class FiscalYearOperations(object): + def __init__(self): + """Creates an instance of FiscalYearOperations""" + pass + + def get_fiscal_year(self): + """ + The method to get fiscal year + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/fiscal_year' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_fiscal_year(self, request): + """ + The method to update fiscal year + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/fiscal_year' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_wrapper.py new file mode 100644 index 0000000..06f1231 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__fiscal_year = None + self.__key_modified = dict() + + def get_fiscal_year(self): + """ + The method to get the fiscal_year + + Returns: + Year: An instance of Year + """ + + return self.__fiscal_year + + def set_fiscal_year(self, fiscal_year): + """ + The method to set the value to fiscal_year + + Parameters: + fiscal_year (Year) : An instance of Year + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.year import Year + except Exception: + from .year import Year + + if fiscal_year is not None and not isinstance(fiscal_year, Year): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fiscal_year EXPECTED TYPE: Year', None, None) + + self.__fiscal_year = fiscal_year + self.__key_modified['fiscal_year'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/success_response.py new file mode 100644 index 0000000..fc40578 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.fiscal_year.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/year.py b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/year.py new file mode 100644 index 0000000..5361883 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/fiscal_year/year.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Year(object): + def __init__(self): + """Creates an instance of Year""" + + self.__start_month = None + self.__display_based_on = None + self.__id = None + self.__key_modified = dict() + + def get_start_month(self): + """ + The method to get the start_month + + Returns: + Choice: An instance of Choice + """ + + return self.__start_month + + def set_start_month(self, start_month): + """ + The method to set the value to start_month + + Parameters: + start_month (Choice) : An instance of Choice + """ + + if start_month is not None and not isinstance(start_month, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_month EXPECTED TYPE: Choice', None, None) + + self.__start_month = start_month + self.__key_modified['start_month'] = 1 + + def get_display_based_on(self): + """ + The method to get the display_based_on + + Returns: + Choice: An instance of Choice + """ + + return self.__display_based_on + + def set_display_based_on(self, display_based_on): + """ + The method to set the value to display_based_on + + Parameters: + display_based_on (Choice) : An instance of Choice + """ + + if display_based_on is not None and not isinstance(display_based_on, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_based_on EXPECTED TYPE: Choice', None, None) + + self.__display_based_on = display_based_on + self.__key_modified['display_based_on'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/from_addresses/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/__init__.py new file mode 100644 index 0000000..00c417b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/__init__.py @@ -0,0 +1,5 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .address import Address +from .response_wrapper import ResponseWrapper +from .from_addresses_operations import FromAddressesOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/from_addresses/address.py b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/address.py new file mode 100644 index 0000000..34c4e25 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__email = None + self.__type = None + self.__id = None + self.__user_name = None + self.__default = None + self.__key_modified = dict() + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/from_addresses/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/api_exception.py new file mode 100644 index 0000000..a3c633a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.from_addresses.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/from_addresses/from_addresses_operations.py b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/from_addresses_operations.py new file mode 100644 index 0000000..a0fb2de --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/from_addresses_operations.py @@ -0,0 +1,35 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class FromAddressesOperations(object): + def __init__(self): + """Creates an instance of FromAddressesOperations""" + pass + + def get_from_addresses(self): + """ + The method to get from addresses + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/emails/actions/from_addresses' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.from_addresses.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_wrapper.py new file mode 100644 index 0000000..9c1d0a7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/from_addresses/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.from_addresses.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__from_addresses = None + self.__key_modified = dict() + + def get_from_addresses(self): + """ + The method to get the from_addresses + + Returns: + list: An instance of list + """ + + return self.__from_addresses + + def set_from_addresses(self, from_addresses): + """ + The method to set the value to from_addresses + + Parameters: + from_addresses (list) : An instance of list + """ + + if from_addresses is not None and not isinstance(from_addresses, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_addresses EXPECTED TYPE: list', None, None) + + self.__from_addresses = from_addresses + self.__key_modified['from_addresses'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/functions/__init__.py new file mode 100644 index 0000000..a541852 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .functions_operations import FunctionsOperations, ExecuteFunctionUsingRequestBodyParam, ExecuteFunctionUsingRequestBodyHeader, ExecuteFunctionUsingParametersParam, ExecuteFunctionUsingParametersHeader, ExecuteFunctionUsingFileParam, ExecuteFunctionUsingFileHeader +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/functions/api_exception.py new file mode 100644 index 0000000..a62d300 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_wrapper import ResponseWrapper + + +class APIException(ResponseWrapper): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/functions/body_wrapper.py new file mode 100644 index 0000000..1991c62 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__body = None + self.__key_modified = dict() + + def get_body(self): + """ + The method to get the body + + Returns: + dict: An instance of dict + """ + + return self.__body + + def set_body(self, body): + """ + The method to set the value to body + + Parameters: + body (dict) : An instance of dict + """ + + if body is not None and not isinstance(body, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: body EXPECTED TYPE: dict', None, None) + + self.__body = body + self.__key_modified['body'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/functions/file_body_wrapper.py new file mode 100644 index 0000000..06224c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/file_body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + + +class FileBodyWrapper(object): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + + self.__inputfile = None + self.__key_modified = dict() + + def get_inputfile(self): + """ + The method to get the inputfile + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__inputfile + + def set_inputfile(self, inputfile): + """ + The method to set the value to inputfile + + Parameters: + inputfile (StreamWrapper) : An instance of StreamWrapper + """ + + if inputfile is not None and not isinstance(inputfile, StreamWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inputfile EXPECTED TYPE: StreamWrapper', None, None) + + self.__inputfile = inputfile + self.__key_modified['inputFile'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/functions_operations.py b/zohocrmsdk/src/com/zoho/crm/api/functions/functions_operations.py new file mode 100644 index 0000000..495e3bb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/functions_operations.py @@ -0,0 +1,231 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class FunctionsOperations(object): + def __init__(self, function_name, auth_type=None, arguments=None): + """ + Creates an instance of FunctionsOperations with the given parameters + + Parameters: + function_name (string) : A string representing the function_name + auth_type (string) : A string representing the auth_type + arguments (dict) : An instance of dict + """ + + if not isinstance(function_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: function_name EXPECTED TYPE: str', None, None) + + if auth_type is not None and not isinstance(auth_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auth_type EXPECTED TYPE: str', None, None) + + if arguments is not None and not isinstance(arguments, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: arguments EXPECTED TYPE: dict', None, None) + + self.__function_name = function_name + self.__auth_type = auth_type + self.__arguments = arguments + + + def execute_function_using_request_body(self, request, param_instance=None, header_instance=None): + """ + The method to execute function using request body + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/functions/' + api_path = api_path + str(self.__function_name) + api_path = api_path + '/actions/execute' + 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('auth_type', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyParam'), self.__auth_type) + handler_instance.add_param(Param('arguments', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyParam'), self.__arguments) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + def execute_function_using_parameters(self, param_instance=None, header_instance=None): + """ + The method to execute function using parameters + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/functions/' + api_path = api_path + str(self.__function_name) + api_path = api_path + '/actions/execute' + 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('auth_type', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersParam'), self.__auth_type) + handler_instance.add_param(Param('arguments', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersParam'), self.__arguments) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + def execute_function_using_file(self, request, param_instance=None, header_instance=None): + """ + The method to execute function using file + + Parameters: + request (FileBodyWrapper) : An instance of FileBodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/functions/' + api_path = api_path + str(self.__function_name) + api_path = api_path + '/actions/execute' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.add_param(Param('auth_type', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileParam'), self.__auth_type) + handler_instance.add_param(Param('arguments', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileParam'), self.__arguments) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper + except Exception: + from .response_wrapper import ResponseWrapper + return handler_instance.api_call(ResponseWrapper.__module__, 'application/json') + + +class ExecuteFunctionUsingRequestBodyParam(object): + custom_functions_param = Param('custom_functions_param', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyParam') + + +class ExecuteFunctionUsingRequestBodyHeader(object): + custom_functions_header = Header('custom_functions_header', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingRequestBodyHeader') + + +class ExecuteFunctionUsingParametersParam(object): + get_custom_functions_param = Param('get_custom_functions_param', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersParam') + + +class ExecuteFunctionUsingParametersHeader(object): + get_custom_functions_header = Header('get_custom_functions_header', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingParametersHeader') + + +class ExecuteFunctionUsingFileParam(object): + upload_file_param = Param('upload_file_param', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileParam') + + +class ExecuteFunctionUsingFileHeader(object): + upload_file_header = Header('upload_file_header', 'com.zoho.crm.api.Functions.ExecuteFunctionUsingFileHeader') diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/functions/response_wrapper.py new file mode 100644 index 0000000..1c2d2c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/response_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseWrapper(ABC): + def __init__(self): + """Creates an instance of ResponseWrapper""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/functions/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/functions/success_response.py new file mode 100644 index 0000000..3466ae0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/functions/success_response.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.functions.response_wrapper import ResponseWrapper +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_wrapper import ResponseWrapper + + +class SuccessResponse(ResponseWrapper): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/__init__.py new file mode 100644 index 0000000..8741349 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/__init__.py @@ -0,0 +1,32 @@ +from .pick_list_values_associations_response_wrapper import PickListValuesAssociationsResponseWrapper +from .associations_response_wrapper import AssociationsResponseWrapper +from .replace_body_wrapper import ReplaceBodyWrapper +from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler +from .picklist import Picklist +from .association import Association +from .pick_list_values_association import PickListValuesAssociation +from .associations_response_handler import AssociationsResponseHandler +from .global_picklists_operations import GlobalPicklistsOperations, GetGlobalPicklistsParam, DeleteGlobalPicklistsParam, GetGlobalPicklistParam, GetAssociationsParam, GetPickListValueAssociationsParam +from .replace_action_handler import ReplaceActionHandler +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .replace_picklist_values import ReplacePicklistValues +from .success_response import SuccessResponse +from .action_handler import ActionHandler +from .replace_action_wrapper import ReplaceActionWrapper +from .info import Info +from .replaced_response_handler import ReplacedResponseHandler +from .action_wrapper import ActionWrapper +from .replaced_value import ReplacedValue +from .resource import Resource +from .module import Module +from .body_wrapper import BodyWrapper +from .replace_success_response import ReplaceSuccessResponse +from .layout import Layout +from .field import Field +from .replaced_response_wrapper import ReplacedResponseWrapper +from .response_wrapper import ResponseWrapper +from .replace_picklist_value import ReplacePicklistValue +from .replace_action_response import ReplaceActionResponse +from .pick_list_values import PickListValues diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_wrapper.py new file mode 100644 index 0000000..3bc6238 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__global_picklists = None + self.__key_modified = dict() + + def get_global_picklists(self): + """ + The method to get the global_picklists + + Returns: + list: An instance of list + """ + + return self.__global_picklists + + def set_global_picklists(self, global_picklists): + """ + The method to set the value to global_picklists + + Parameters: + global_picklists (list) : An instance of list + """ + + if global_picklists is not None and not isinstance(global_picklists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_picklists EXPECTED TYPE: list', None, None) + + self.__global_picklists = global_picklists + self.__key_modified['global_picklists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/api_exception.py new file mode 100644 index 0000000..5eb174c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/api_exception.py @@ -0,0 +1,166 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.associations_response_handler import AssociationsResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_handler import ReplaceActionHandler + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_response import ReplaceActionResponse + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replaced_response_handler import ReplacedResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + from .action_handler import ActionHandler + from .associations_response_handler import AssociationsResponseHandler + from .replace_action_handler import ReplaceActionHandler + from .replace_action_response import ReplaceActionResponse + from .replaced_response_handler import ReplacedResponseHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler, ReplaceActionHandler, ReplaceActionResponse, ReplacedResponseHandler, AssociationsResponseHandler, PickListValuesAssociationsResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/association.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/association.py new file mode 100644 index 0000000..e99f80a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/association.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Association(object): + def __init__(self): + """Creates an instance of Association""" + + self.__field = None + self.__module = None + self.__layouts = None + self.__key_modified = dict() + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_handler.py new file mode 100644 index 0000000..0b460f7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class AssociationsResponseHandler(ABC): + def __init__(self): + """Creates an instance of AssociationsResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_wrapper.py new file mode 100644 index 0000000..b7056b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/associations_response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.associations_response_handler import AssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .associations_response_handler import AssociationsResponseHandler + + +class AssociationsResponseWrapper(AssociationsResponseHandler): + def __init__(self): + """Creates an instance of AssociationsResponseWrapper""" + super().__init__() + + self.__associations = None + self.__info = None + self.__key_modified = dict() + + def get_associations(self): + """ + The method to get the associations + + Returns: + list: An instance of list + """ + + return self.__associations + + def set_associations(self, associations): + """ + The method to set the value to associations + + Parameters: + associations (list) : An instance of list + """ + + if associations is not None and not isinstance(associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associations EXPECTED TYPE: list', None, None) + + self.__associations = associations + self.__key_modified['associations'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/body_wrapper.py new file mode 100644 index 0000000..3ae2801 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__global_picklists = None + self.__key_modified = dict() + + def get_global_picklists(self): + """ + The method to get the global_picklists + + Returns: + list: An instance of list + """ + + return self.__global_picklists + + def set_global_picklists(self, global_picklists): + """ + The method to set the value to global_picklists + + Parameters: + global_picklists (list) : An instance of list + """ + + if global_picklists is not None and not isinstance(global_picklists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_picklists EXPECTED TYPE: list', None, None) + + self.__global_picklists = global_picklists + self.__key_modified['global_picklists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/field.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/global_picklists_operations.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/global_picklists_operations.py new file mode 100644 index 0000000..f10029a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/global_picklists_operations.py @@ -0,0 +1,448 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class GlobalPicklistsOperations(object): + def __init__(self): + """Creates an instance of GlobalPicklistsOperations""" + pass + + def get_global_picklists(self, param_instance=None): + """ + The method to get global picklists + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/global_picklists' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_global_picklist(self, request): + """ + The method to create global picklist + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/global_picklists' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_global_picklists(self, request): + """ + The method to update global picklists + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/global_picklists' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_global_picklists(self, param_instance=None): + """ + The method to delete global picklists + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/global_picklists' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_global_picklist(self, id, param_instance=None): + """ + The method to get global picklist + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/global_picklists/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_global_picklist(self, id, request): + """ + The method to update global picklist + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/global_picklists/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_global_picklist(self, id): + """ + The method to delete global picklist + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def replace_picklist_values(self, id, request): + """ + The method to replace picklist values + + Parameters: + id (int) : An int representing the id + request (ReplaceBodyWrapper) : An instance of ReplaceBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_body_wrapper import ReplaceBodyWrapper + except Exception: + from .replace_body_wrapper import ReplaceBodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, ReplaceBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ReplaceBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/replace_picklist_values' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_handler import ReplaceActionHandler + except Exception: + from .replace_action_handler import ReplaceActionHandler + return handler_instance.api_call(ReplaceActionHandler.__module__, 'application/json') + + def get_replace_values(self, id): + """ + The method to get replace values + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/replaced_values' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replaced_response_handler import ReplacedResponseHandler + except Exception: + from .replaced_response_handler import ReplacedResponseHandler + return handler_instance.api_call(ReplacedResponseHandler.__module__, 'application/json') + + def get_associations(self, id, param_instance=None): + """ + The method to get associations + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.associations_response_handler import AssociationsResponseHandler + except Exception: + from .associations_response_handler import AssociationsResponseHandler + return handler_instance.api_call(AssociationsResponseHandler.__module__, 'application/json') + + def get_pick_list_value_associations(self, id, param_instance=None): + """ + The method to get pick list value associations + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/global_picklists/' + api_path = api_path + str(id) + api_path = api_path + '/actions/pick_list_values_associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + except Exception: + from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + return handler_instance.api_call(PickListValuesAssociationsResponseHandler.__module__, 'application/json') + + +class GetGlobalPicklistsParam(object): + include = Param('include', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistsParam') + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistsParam') + + +class DeleteGlobalPicklistsParam(object): + ids = Param('ids', 'com.zoho.crm.api.GlobalPicklists.DeleteGlobalPicklistsParam') + + +class GetGlobalPicklistParam(object): + include = Param('include', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistParam') + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.GlobalPicklists.GetGlobalPicklistParam') + + +class GetAssociationsParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.GlobalPicklists.GetAssociationsParam') + page = Param('page', 'com.zoho.crm.api.GlobalPicklists.GetAssociationsParam') + per_page = Param('per_page', 'com.zoho.crm.api.GlobalPicklists.GetAssociationsParam') + + +class GetPickListValueAssociationsParam(object): + picklist_value_id = Param('picklist_value_id', 'com.zoho.crm.api.GlobalPicklists.GetPickListValueAssociationsParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/info.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/layout.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/layout.py new file mode 100644 index 0000000..4c19809 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/layout.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__name = None + self.__id = None + self.__status = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/module.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/module.py new file mode 100644 index 0000000..f36b9b9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__plural_label = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values.py new file mode 100644 index 0000000..7085cd1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class PickListValues(object): + def __init__(self): + """Creates an instance of PickListValues""" + + self.__actual_value = None + self.__type = None + self.__id = None + self.__sequence_number = None + self.__display_value = None + self.__key_modified = dict() + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_association.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_association.py new file mode 100644 index 0000000..e1568cb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_association.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PickListValuesAssociation(object): + def __init__(self): + """Creates an instance of PickListValuesAssociation""" + + self.__type = None + self.__resources = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_handler.py new file mode 100644 index 0000000..28310c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class PickListValuesAssociationsResponseHandler(ABC): + def __init__(self): + """Creates an instance of PickListValuesAssociationsResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_wrapper.py new file mode 100644 index 0000000..cf8aa33 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/pick_list_values_associations_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .pick_list_values_associations_response_handler import PickListValuesAssociationsResponseHandler + + +class PickListValuesAssociationsResponseWrapper(PickListValuesAssociationsResponseHandler): + def __init__(self): + """Creates an instance of PickListValuesAssociationsResponseWrapper""" + super().__init__() + + self.__pick_list_values_associations = None + self.__key_modified = dict() + + def get_pick_list_values_associations(self): + """ + The method to get the pick_list_values_associations + + Returns: + list: An instance of list + """ + + return self.__pick_list_values_associations + + def set_pick_list_values_associations(self, pick_list_values_associations): + """ + The method to set the value to pick_list_values_associations + + Parameters: + pick_list_values_associations (list) : An instance of list + """ + + if pick_list_values_associations is not None and not isinstance(pick_list_values_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_associations EXPECTED TYPE: list', None, None) + + self.__pick_list_values_associations = pick_list_values_associations + self.__key_modified['pick_list_values_associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/picklist.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/picklist.py new file mode 100644 index 0000000..fde8548 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/picklist.py @@ -0,0 +1,363 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Picklist(object): + def __init__(self): + """Creates an instance of Picklist""" + + self.__display_label = None + self.__created_time = None + self.__modified_time = None + self.__id = None + self.__api_name = None + self.__actual_label = None + self.__description = None + self.__modified_by = None + self.__created_by = None + self.__presence = None + self.__pick_list_values_sorted_lexically = None + self.__pick_list_values = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_actual_label(self): + """ + The method to get the actual_label + + Returns: + string: A string representing the actual_label + """ + + return self.__actual_label + + def set_actual_label(self, actual_label): + """ + The method to set the value to actual_label + + Parameters: + actual_label (string) : A string representing the actual_label + """ + + if actual_label is not None and not isinstance(actual_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_label EXPECTED TYPE: str', None, None) + + self.__actual_label = actual_label + self.__key_modified['actual_label'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_presence(self): + """ + The method to get the presence + + Returns: + bool: A bool representing the presence + """ + + return self.__presence + + def set_presence(self, presence): + """ + The method to set the value to presence + + Parameters: + presence (bool) : A bool representing the presence + """ + + if presence is not None and not isinstance(presence, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: presence EXPECTED TYPE: bool', None, None) + + self.__presence = presence + self.__key_modified['presence'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_handler.py new file mode 100644 index 0000000..7c7f618 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ReplaceActionHandler(ABC): + def __init__(self): + """Creates an instance of ReplaceActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_response.py new file mode 100644 index 0000000..07120ad --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ReplaceActionResponse(ABC): + def __init__(self): + """Creates an instance of ReplaceActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_wrapper.py new file mode 100644 index 0000000..096190d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_handler import ReplaceActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .replace_action_handler import ReplaceActionHandler + + +class ReplaceActionWrapper(ReplaceActionHandler): + def __init__(self): + """Creates an instance of ReplaceActionWrapper""" + super().__init__() + + self.__replace_picklist_values = None + self.__key_modified = dict() + + def get_replace_picklist_values(self): + """ + The method to get the replace_picklist_values + + Returns: + list: An instance of list + """ + + return self.__replace_picklist_values + + def set_replace_picklist_values(self, replace_picklist_values): + """ + The method to set the value to replace_picklist_values + + Parameters: + replace_picklist_values (list) : An instance of list + """ + + if replace_picklist_values is not None and not isinstance(replace_picklist_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replace_picklist_values EXPECTED TYPE: list', None, None) + + self.__replace_picklist_values = replace_picklist_values + self.__key_modified['replace_picklist_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_body_wrapper.py new file mode 100644 index 0000000..704dd19 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplaceBodyWrapper(object): + def __init__(self): + """Creates an instance of ReplaceBodyWrapper""" + + self.__replace_picklist_values = None + self.__key_modified = dict() + + def get_replace_picklist_values(self): + """ + The method to get the replace_picklist_values + + Returns: + list: An instance of list + """ + + return self.__replace_picklist_values + + def set_replace_picklist_values(self, replace_picklist_values): + """ + The method to set the value to replace_picklist_values + + Parameters: + replace_picklist_values (list) : An instance of list + """ + + if replace_picklist_values is not None and not isinstance(replace_picklist_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replace_picklist_values EXPECTED TYPE: list', None, None) + + self.__replace_picklist_values = replace_picklist_values + self.__key_modified['replace_picklist_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_value.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_value.py new file mode 100644 index 0000000..a537003 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_value.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplacePicklistValue(object): + def __init__(self): + """Creates an instance of ReplacePicklistValue""" + + self.__id = None + self.__display_value = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_values.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_values.py new file mode 100644 index 0000000..0b77197 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_picklist_values.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplacePicklistValues(object): + def __init__(self): + """Creates an instance of ReplacePicklistValues""" + + self.__new_value = None + self.__old_value = None + self.__key_modified = dict() + + def get_new_value(self): + """ + The method to get the new_value + + Returns: + ReplacePicklistValue: An instance of ReplacePicklistValue + """ + + return self.__new_value + + def set_new_value(self, new_value): + """ + The method to set the value to new_value + + Parameters: + new_value (ReplacePicklistValue) : An instance of ReplacePicklistValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_picklist_value import ReplacePicklistValue + except Exception: + from .replace_picklist_value import ReplacePicklistValue + + if new_value is not None and not isinstance(new_value, ReplacePicklistValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: new_value EXPECTED TYPE: ReplacePicklistValue', None, None) + + self.__new_value = new_value + self.__key_modified['new_value'] = 1 + + def get_old_value(self): + """ + The method to get the old_value + + Returns: + ReplacePicklistValue: An instance of ReplacePicklistValue + """ + + return self.__old_value + + def set_old_value(self, old_value): + """ + The method to set the value to old_value + + Parameters: + old_value (ReplacePicklistValue) : An instance of ReplacePicklistValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_picklist_value import ReplacePicklistValue + except Exception: + from .replace_picklist_value import ReplacePicklistValue + + if old_value is not None and not isinstance(old_value, ReplacePicklistValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: old_value EXPECTED TYPE: ReplacePicklistValue', None, None) + + self.__old_value = old_value + self.__key_modified['old_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_success_response.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_success_response.py new file mode 100644 index 0000000..a1b62ba --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replace_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replace_action_response import ReplaceActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .replace_action_response import ReplaceActionResponse + + +class ReplaceSuccessResponse(ReplaceActionResponse): + def __init__(self): + """Creates an instance of ReplaceSuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_handler.py new file mode 100644 index 0000000..754e5ba --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ReplacedResponseHandler(ABC): + def __init__(self): + """Creates an instance of ReplacedResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_wrapper.py new file mode 100644 index 0000000..ea89ceb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.replaced_response_handler import ReplacedResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .replaced_response_handler import ReplacedResponseHandler + + +class ReplacedResponseWrapper(ReplacedResponseHandler): + def __init__(self): + """Creates an instance of ReplacedResponseWrapper""" + super().__init__() + + self.__replaced_values = None + self.__key_modified = dict() + + def get_replaced_values(self): + """ + The method to get the replaced_values + + Returns: + list: An instance of list + """ + + return self.__replaced_values + + def set_replaced_values(self, replaced_values): + """ + The method to set the value to replaced_values + + Parameters: + replaced_values (list) : An instance of list + """ + + if replaced_values is not None and not isinstance(replaced_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: replaced_values EXPECTED TYPE: list', None, None) + + self.__replaced_values = replaced_values + self.__key_modified['replaced_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_value.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_value.py new file mode 100644 index 0000000..0c8c6a3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/replaced_value.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReplacedValue(object): + def __init__(self): + """Creates an instance of ReplacedValue""" + + self.__display_value = None + self.__actual_value = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/resource.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/resource.py new file mode 100644 index 0000000..1dc9c7f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/resource.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__details = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + list: An instance of list + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (list) : An instance of list + """ + + if details is not None and not isinstance(details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: list', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_wrapper.py new file mode 100644 index 0000000..29587d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__global_picklists = None + self.__key_modified = dict() + + def get_global_picklists(self): + """ + The method to get the global_picklists + + Returns: + list: An instance of list + """ + + return self.__global_picklists + + def set_global_picklists(self, global_picklists): + """ + The method to set the value to global_picklists + + Parameters: + global_picklists (list) : An instance of list + """ + + if global_picklists is not None and not isinstance(global_picklists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_picklists EXPECTED TYPE: list', None, None) + + self.__global_picklists = global_picklists + self.__key_modified['global_picklists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/global_picklists/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/success_response.py new file mode 100644 index 0000000..828d114 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/global_picklists/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.global_picklists.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/header.py b/zohocrmsdk/src/com/zoho/crm/api/header.py new file mode 100755 index 0000000..ae36490 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/header.py @@ -0,0 +1,19 @@ + +class Header(object): + + """ + This class represents the HTTP header. + """ + + def __init__(self, name, class_name=None): + + """ + Creates an Header class instance with the following parameters + + Parameters: + name (str) : A string containing the header name. + class_name (str) : A string containing the header class name. + """ + + self.name = name + self.class_name = class_name diff --git a/zohocrmsdk/src/com/zoho/crm/api/header_map.py b/zohocrmsdk/src/com/zoho/crm/api/header_map.py new file mode 100755 index 0000000..534a702 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/header_map.py @@ -0,0 +1,69 @@ +try: + import logging + from zohocrmsdk.src.com.zoho.crm.api.header import Header + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.header_param_validator import HeaderParamValidator +except Exception: + import logging + from .util.constants import Constants + from .util.header_param_validator import HeaderParamValidator + from .util.datatype_converter import DataTypeConverter + from .header import Header + from ..api.exception import SDKException + + +class HeaderMap(object): + + """ + This class represents the HTTP header name and value. + """ + + def __init__(self): + """Creates an instance of HeaderMap Class""" + + self.request_headers = dict() + + def add(self, header, value): + + """ + The method to add the parameter name and value. + + Parameters: + header (Header): A Header class instance. + value (object): An object containing the header value. + """ + + if header is None: + raise SDKException(Constants.HEADER_NONE_ERROR, Constants.HEADER_INSTANCE_NONE_ERROR) + + header_name = header.name + + if header_name is None: + raise SDKException(Constants.HEADER_NAME_NONE_ERROR, Constants.HEADER_NAME_NULL_ERROR_MESSAGE) + + if value is None: + raise SDKException(Constants.HEADER_NONE_ERROR, header_name + Constants.NONE_VALUE_ERROR_MESSAGE) + try: + class_name = header.class_name + parsed_header_value = None + if class_name is not None: + parsed_header_value = HeaderParamValidator().validate(header_name, class_name, value) + else: + try: + parsed_header_value = DataTypeConverter.post_convert(value, value.__class__.__name__) + except Exception as e: + parsed_header_value = str(value) + if header_name not in self.request_headers: + self.request_headers[header_name] = str(parsed_header_value) + else: + header_value = self.request_headers[header_name] + self.request_headers[header_name] = header_value + ',' + str(parsed_header_value) + except SDKException as e: + logging.getLogger('SDKLogger').error(Constants.HEADER_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + logging.getLogger('SDKLogger').error(Constants.HEADER_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/__init__.py new file mode 100644 index 0000000..f8c1736 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/__init__.py @@ -0,0 +1,8 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .hipaa_compliance import HipaaCompliance +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .modules import Modules diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_wrapper.py new file mode 100644 index 0000000..1d5ece0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__hipaa_compliance = None + self.__key_modified = dict() + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: ActionResponse', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/api_exception.py new file mode 100644 index 0000000..70438a3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class APIException(ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/hipaa_compliance.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/hipaa_compliance.py new file mode 100644 index 0000000..8801590 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/hipaa_compliance.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class HipaaCompliance(object): + def __init__(self): + """Creates an instance of HipaaCompliance""" + + self.__enabled = None + self.__enabled_for_modules = None + self.__restrict_to_zoho_apps = None + self.__restrict_data_access_through_api = None + self.__restrict_data_in_export = None + self.__restrict_to_third_party_apps = None + self.__key_modified = dict() + + def get_enabled(self): + """ + The method to get the enabled + + Returns: + bool: A bool representing the enabled + """ + + return self.__enabled + + def set_enabled(self, enabled): + """ + The method to set the value to enabled + + Parameters: + enabled (bool) : A bool representing the enabled + """ + + if enabled is not None and not isinstance(enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enabled EXPECTED TYPE: bool', None, None) + + self.__enabled = enabled + self.__key_modified['enabled'] = 1 + + def get_enabled_for_modules(self): + """ + The method to get the enabled_for_modules + + Returns: + list: An instance of list + """ + + return self.__enabled_for_modules + + def set_enabled_for_modules(self, enabled_for_modules): + """ + The method to set the value to enabled_for_modules + + Parameters: + enabled_for_modules (list) : An instance of list + """ + + if enabled_for_modules is not None and not isinstance(enabled_for_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enabled_for_modules EXPECTED TYPE: list', None, None) + + self.__enabled_for_modules = enabled_for_modules + self.__key_modified['enabled_for_modules'] = 1 + + def get_restrict_to_zoho_apps(self): + """ + The method to get the restrict_to_zoho_apps + + Returns: + bool: A bool representing the restrict_to_zoho_apps + """ + + return self.__restrict_to_zoho_apps + + def set_restrict_to_zoho_apps(self, restrict_to_zoho_apps): + """ + The method to set the value to restrict_to_zoho_apps + + Parameters: + restrict_to_zoho_apps (bool) : A bool representing the restrict_to_zoho_apps + """ + + if restrict_to_zoho_apps is not None and not isinstance(restrict_to_zoho_apps, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_to_zoho_apps EXPECTED TYPE: bool', None, None) + + self.__restrict_to_zoho_apps = restrict_to_zoho_apps + self.__key_modified['restrict_to_zoho_apps'] = 1 + + def get_restrict_data_access_through_api(self): + """ + The method to get the restrict_data_access_through_api + + Returns: + bool: A bool representing the restrict_data_access_through_api + """ + + return self.__restrict_data_access_through_api + + def set_restrict_data_access_through_api(self, restrict_data_access_through_api): + """ + The method to set the value to restrict_data_access_through_api + + Parameters: + restrict_data_access_through_api (bool) : A bool representing the restrict_data_access_through_api + """ + + if restrict_data_access_through_api is not None and not isinstance(restrict_data_access_through_api, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_data_access_through_api EXPECTED TYPE: bool', None, None) + + self.__restrict_data_access_through_api = restrict_data_access_through_api + self.__key_modified['restrict_data_access_through_api'] = 1 + + def get_restrict_data_in_export(self): + """ + The method to get the restrict_data_in_export + + Returns: + bool: A bool representing the restrict_data_in_export + """ + + return self.__restrict_data_in_export + + def set_restrict_data_in_export(self, restrict_data_in_export): + """ + The method to set the value to restrict_data_in_export + + Parameters: + restrict_data_in_export (bool) : A bool representing the restrict_data_in_export + """ + + if restrict_data_in_export is not None and not isinstance(restrict_data_in_export, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_data_in_export EXPECTED TYPE: bool', None, None) + + self.__restrict_data_in_export = restrict_data_in_export + self.__key_modified['restrict_data_in_export'] = 1 + + def get_restrict_to_third_party_apps(self): + """ + The method to get the restrict_to_third_party_apps + + Returns: + list: An instance of list + """ + + return self.__restrict_to_third_party_apps + + def set_restrict_to_third_party_apps(self, restrict_to_third_party_apps): + """ + The method to set the value to restrict_to_third_party_apps + + Parameters: + restrict_to_third_party_apps (list) : An instance of list + """ + + if restrict_to_third_party_apps is not None and not isinstance(restrict_to_third_party_apps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_to_third_party_apps EXPECTED TYPE: list', None, None) + + self.__restrict_to_third_party_apps = restrict_to_third_party_apps + self.__key_modified['restrict_to_third_party_apps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/modules.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/modules.py new file mode 100644 index 0000000..ef2588f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/modules.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/response_wrapper.py new file mode 100644 index 0000000..7be71e2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/response_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__hipaa_compliance = None + self.__key_modified = dict() + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.hipaa_compliance import HipaaCompliance + except Exception: + from .hipaa_compliance import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/success_response.py new file mode 100644 index 0000000..27c7c19 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/hipaa_compliance/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class SuccessResponse(ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/__init__.py new file mode 100644 index 0000000..0292164 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .shift_holiday import ShiftHoliday +from .resonse_handler import ResonseHandler +from .body_wrapper import BodyWrapper +from .holiday import Holiday +from .create_shift_holiday import CreateShiftHoliday +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .holidays import Holidays +from .business_holiday import BusinessHoliday +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .create_business_holiday import CreateBusinessHoliday +from .holidays_operations import HolidaysOperations, GetHolidaysHeader, GetHolidaysParam, CreateHolidaysHeader, UpdateHolidaysHeader, UpdateHolidayHeader, GetHolidayHeader, DeleteHolidayHeader +from .shift_hour import ShiftHour +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/action_wrapper.py new file mode 100644 index 0000000..1aca812 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/api_exception.py new file mode 100644 index 0000000..964cc39 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.holidays.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.holidays.resonse_handler import ResonseHandler + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .resonse_handler import ResonseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse, ResonseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/body_wrapper.py new file mode 100644 index 0000000..2f7bb78 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/body_wrapper.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class BodyWrapper(ABC): + def __init__(self): + """Creates an instance of BodyWrapper""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/business_holiday.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/business_holiday.py new file mode 100644 index 0000000..faef905 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/business_holiday.py @@ -0,0 +1,126 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BusinessHoliday(object): + def __init__(self): + """Creates an instance of BusinessHoliday""" + + self.__name = None + self.__date = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/create_business_holiday.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/create_business_holiday.py new file mode 100644 index 0000000..ff98146 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/create_business_holiday.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.body_wrapper import BodyWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .body_wrapper import BodyWrapper + + +class CreateBusinessHoliday(BodyWrapper): + def __init__(self): + """Creates an instance of CreateBusinessHoliday""" + super().__init__() + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/create_shift_holiday.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/create_shift_holiday.py new file mode 100644 index 0000000..4b8f84e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/create_shift_holiday.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.body_wrapper import BodyWrapper +except Exception: + from ..exception import SDKException + from ..util import Constants + from .body_wrapper import BodyWrapper + + +class CreateShiftHoliday(BodyWrapper): + def __init__(self): + """Creates an instance of CreateShiftHoliday""" + super().__init__() + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/holiday.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/holiday.py new file mode 100644 index 0000000..acbd361 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/holiday.py @@ -0,0 +1,206 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Holiday(object): + def __init__(self): + """Creates an instance of Holiday""" + + self.__year = None + self.__name = None + self.__date = None + self.__type = None + self.__id = None + self.__shift_hour = None + self.__key_modified = dict() + + def get_year(self): + """ + The method to get the year + + Returns: + int: An int representing the year + """ + + return self.__year + + def set_year(self, year): + """ + The method to set the value to year + + Parameters: + year (int) : An int representing the year + """ + + if year is not None and not isinstance(year, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: year EXPECTED TYPE: int', None, None) + + self.__year = year + self.__key_modified['year'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_shift_hour(self): + """ + The method to get the shift_hour + + Returns: + ShiftHour: An instance of ShiftHour + """ + + return self.__shift_hour + + def set_shift_hour(self, shift_hour): + """ + The method to set the value to shift_hour + + Parameters: + shift_hour (ShiftHour) : An instance of ShiftHour + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.shift_hour import ShiftHour + except Exception: + from .shift_hour import ShiftHour + + if shift_hour is not None and not isinstance(shift_hour, ShiftHour): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hour EXPECTED TYPE: ShiftHour', None, None) + + self.__shift_hour = shift_hour + self.__key_modified['shift_hour'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays.py new file mode 100644 index 0000000..ec79830 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Holidays(object): + def __init__(self): + """Creates an instance of Holidays""" + + self.__holidays = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays_operations.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays_operations.py new file mode 100644 index 0000000..ae8ad38 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/holidays_operations.py @@ -0,0 +1,273 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class HolidaysOperations(object): + def __init__(self, x_crm_org=None): + """ + Creates an instance of HolidaysOperations with the given parameters + + Parameters: + x_crm_org (string) : A string representing the x_crm_org + """ + + if x_crm_org is not None and not isinstance(x_crm_org, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_crm_org EXPECTED TYPE: str', None, None) + + self.__x_crm_org = x_crm_org + + + def get_holidays(self, param_instance=None): + """ + The method to get holidays + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/holidays' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.GetHolidaysHeader'), self.__x_crm_org) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_holidays(self, request): + """ + The method to create holidays + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/holidays' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.CreateHolidaysHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_holidays(self, request): + """ + The method to update holidays + + Parameters: + request (Holidays) : An instance of Holidays + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.holidays import Holidays + except Exception: + from .holidays import Holidays + + if request is not None and not isinstance(request, Holidays): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: Holidays', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays' + 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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.UpdateHolidaysHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_holiday(self, holiday_id, request): + """ + The method to update holiday + + Parameters: + holiday_id (int) : An int representing the holiday_id + request (Holidays) : An instance of Holidays + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.holidays import Holidays + except Exception: + from .holidays import Holidays + + if not isinstance(holiday_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holiday_id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, Holidays): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: Holidays', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays/' + api_path = api_path + str(holiday_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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.UpdateHolidayHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_holiday(self, holiday_id): + """ + The method to get holiday + + Parameters: + holiday_id (int) : An int representing the holiday_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(holiday_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holiday_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays/' + api_path = api_path + str(holiday_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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.GetHolidayHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.resonse_handler import ResonseHandler + except Exception: + from .resonse_handler import ResonseHandler + return handler_instance.api_call(ResonseHandler.__module__, 'application/json') + + def delete_holiday(self, holiday_id): + """ + The method to delete holiday + + Parameters: + holiday_id (int) : An int representing the holiday_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(holiday_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holiday_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/holidays/' + api_path = api_path + str(holiday_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.Holidays.DeleteHolidayHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetHolidaysHeader(object): + pass + + +class GetHolidaysParam(object): + year = Param('year', 'com.zoho.crm.api.Holidays.GetHolidaysParam') + type = Param('type', 'com.zoho.crm.api.Holidays.GetHolidaysParam') + shift_id = Param('shift_id', 'com.zoho.crm.api.Holidays.GetHolidaysParam') + + +class CreateHolidaysHeader(object): + pass + + +class UpdateHolidaysHeader(object): + pass + + +class UpdateHolidayHeader(object): + pass + + +class GetHolidayHeader(object): + pass + + +class DeleteHolidayHeader(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/info.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/resonse_handler.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/resonse_handler.py new file mode 100644 index 0000000..8bc9286 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/resonse_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResonseHandler(ABC): + def __init__(self): + """Creates an instance of ResonseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/response_wrapper.py new file mode 100644 index 0000000..8d9706b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/response_wrapper.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.holidays.resonse_handler import ResonseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + from .resonse_handler import ResonseHandler + + +class ResponseWrapper(ResponseHandler, ResonseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__holidays = None + self.__info = None + self.__key_modified = dict() + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_holiday.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_holiday.py new file mode 100644 index 0000000..529dcd3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_holiday.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ShiftHoliday(object): + def __init__(self): + """Creates an instance of ShiftHoliday""" + + self.__name = None + self.__date = None + self.__type = None + self.__shift_hour = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_shift_hour(self): + """ + The method to get the shift_hour + + Returns: + ShiftHour: An instance of ShiftHour + """ + + return self.__shift_hour + + def set_shift_hour(self, shift_hour): + """ + The method to set the value to shift_hour + + Parameters: + shift_hour (ShiftHour) : An instance of ShiftHour + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.holidays.shift_hour import ShiftHour + except Exception: + from .shift_hour import ShiftHour + + if shift_hour is not None and not isinstance(shift_hour, ShiftHour): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hour EXPECTED TYPE: ShiftHour', None, None) + + self.__shift_hour = shift_hour + self.__key_modified['shift_hour'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_hour.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_hour.py new file mode 100644 index 0000000..9b67b81 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/shift_hour.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftHour(object): + def __init__(self): + """Creates an instance of ShiftHour""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/holidays/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/holidays/success_response.py new file mode 100644 index 0000000..7a62e6c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/holidays/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.holidays.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/initializer.py b/zohocrmsdk/src/com/zoho/crm/api/initializer.py new file mode 100755 index 0000000..9038042 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/initializer.py @@ -0,0 +1,232 @@ +""" +Copyright (c) 2021, ZOHO CORPORATION PRIVATE LIMITED +All rights reserved. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +""" + +try: + import logging + import os + import json + import threading + from zohocrmsdk.src.com.zoho.crm.api.user_signature import UserSignature + from zohocrmsdk.src.com.zoho.api.authenticator.store.token_store import TokenStore + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.dc.data_center import DataCenter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.api.authenticator.token import Token + from zohocrmsdk.src.com.zoho.api.logger import Logger, SDKLogger + from zohocrmsdk.src.com.zoho.crm.api.request_proxy import RequestProxy + from zohocrmsdk.src.com.zoho.crm.api.sdk_config import SDKConfig + +except Exception: + import logging + import os + import json + import threading + from ..api.user_signature import UserSignature + from ...api.authenticator.store.token_store import TokenStore + from ..api.exception import SDKException + from ..api.dc.data_center import DataCenter + from ..api.util.constants import Constants + from ...api.authenticator.token import Token + from ...api.logger import Logger, SDKLogger + from .request_proxy import RequestProxy + from .sdk_config import SDKConfig + + +class Initializer(object): + + """ + The class to initialize Zoho CRM SDK. + """ + + def __init__(self): + self.environment = None + self.store = None + self.token = None + self.sdk_config = None + self.request_proxy = None + self.resource_path = None + + json_details = None + initializer = None + LOCAL = threading.local() + LOCAL.init = None + + @staticmethod + def initialize(environment, token, store=None, sdk_config=None, resource_path=None, logger=None, proxy=None): + + """ + The method to initialize the SDK. + + Parameters: + environment (DataCenter.Environment) : An Environment class instance containing the CRM API base URL and Accounts URL. + token (Token) : A Token class instance containing the OAuth client application information. + store (TokenStore) : A TokenStore class instance containing the token store information. + sdk_config (SDKConfig) : A SDKConfig class instance containing the configuration. + resource_path (str) : A String containing the absolute directory path to store user specific JSON files containing module fields information. + logger (Logger): A Logger class instance containing the log file path and Logger type. + proxy (RequestProxy) : A RequestProxy class instance containing the proxy properties of the user. + """ + + try: + if not isinstance(token, Token): + error = {Constants.FIELD: Constants.TOKEN, Constants.EXPECTED_TYPE: Token.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.TOKEN_ERROR_MESSAGE, details=error) + + if store is not None and not isinstance(store, TokenStore): + error = {Constants.FIELD: Constants.STORE, Constants.EXPECTED_TYPE: TokenStore.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.STORE_ERROR_MESSAGE, details=error) + + if sdk_config is not None and not isinstance(sdk_config, SDKConfig): + error = {Constants.FIELD: Constants.SDK_CONFIG, Constants.EXPECTED_TYPE: SDKConfig.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.SDK_CONFIG_ERROR_MESSAGE, details=error) + + if proxy is not None and not isinstance(proxy, RequestProxy): + error = {Constants.FIELD: Constants.USER_PROXY, Constants.EXPECTED_TYPE: RequestProxy.__module__} + + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.REQUEST_PROXY_ERROR_MESSAGE, details=error) + + if store is None: + try: + from zohocrmsdk.src.com.zoho.api.authenticator.store.file_store import FileStore + except Exception: + from ...api.authenticator.store.file_store import FileStore + + store = FileStore(os.path.join(os.getcwd(), Constants.TOKEN_FILE)) + + if sdk_config is None: + sdk_config = SDKConfig() + + if resource_path is None or len(resource_path) == 0: + resource_path = os.getcwd() + + if logger is None: + logger = Logger(Logger.Levels.NOTSET, None) + + SDKLogger.initialize(logger) + + if not os.path.isdir(resource_path): + raise SDKException(Constants.INITIALIZATION_ERROR, Constants.RESOURCE_PATH_INVALID_ERROR_MESSAGE) + + try: + json_details_path = os.path.join(os.path.dirname(__file__), '..', '..', '..', '..', Constants.JSON_DETAILS_FILE_PATH) + if Initializer.json_details is None or len(Initializer.json_details) == 0: + with open(json_details_path, mode='r') as JSON: + Initializer.json_details = json.load(JSON) + except Exception as e: + raise SDKException(code=Constants.JSON_DETAILS_ERROR, cause=e) + + initializer = Initializer() + + initializer.environment = environment + initializer.store = store + initializer.sdk_config = sdk_config + initializer.resource_path = resource_path + initializer.request_proxy = proxy + Initializer.initializer = initializer + initializer.token = token + if token is not None: + token.generate_token() + initializer.token = token + Initializer.initializer = initializer + Initializer.LOCAL.init = initializer + + logging.getLogger('SDKLogger').info(Constants.INITIALIZATION_SUCCESSFUL + initializer.__str__()) + + except SDKException as e: + raise e + + def __str__(self): + return Constants.IN_ENVIRONMENT + Initializer.get_initializer().environment.url + '.' + + @staticmethod + def get_initializer(): + + """ + The method to get Initializer class instance. + + Returns: + Initializer : An instance of Initializer + """ + + if getattr(Initializer.LOCAL, 'init', None) is not None: + return getattr(Initializer.LOCAL, 'init') + + return Initializer.initializer + + @staticmethod + def get_json(file_path): + with open(file_path, mode="r") as JSON: + file_contents = json.load(JSON) + JSON.close() + + return file_contents + + @staticmethod + def switch_user(environment=None, token=None, sdk_config=None, proxy=None): + + """ + The method to switch the different user in SDK environment. + + Parameters: + environment (DataCenter.Environment) : An Environment class instance containing the CRM API base URL and Accounts URL. + token (Token) : A Token class instance containing the OAuth client application information. + sdk_config (SDKConfig) : A SDKConfig class instance containing the configuration. + proxy (RequestProxy) : A RequestProxy class instance containing the proxy properties of the user. + """ + + if Initializer.initializer is None: + raise SDKException(Constants.SDK_UNINITIALIZATION_ERROR, Constants.SDK_UNINITIALIZATION_MESSAGE) + + if environment is not None and not isinstance(environment, DataCenter.Environment): + error = {Constants.FIELD: Constants.ENVIRONMENT, + Constants.EXPECTED_TYPE: DataCenter.Environment.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.ENVIRONMENT_ERROR_MESSAGE, details=error) + + if token is not None and not isinstance(token, Token): + error = {Constants.FIELD: Constants.TOKEN, Constants.EXPECTED_TYPE: Token.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.TOKEN_ERROR_MESSAGE, details=error) + + if sdk_config is not None and not isinstance(sdk_config, SDKConfig): + error = {Constants.FIELD: Constants.SDK_CONFIG, Constants.EXPECTED_TYPE: SDKConfig.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.SDK_CONFIG_ERROR_MESSAGE, details=error) + + if proxy is not None and not isinstance(proxy, RequestProxy): + error = {Constants.FIELD: Constants.USER_PROXY, Constants.EXPECTED_TYPE: RequestProxy.__module__} + + raise SDKException(Constants.SWITCH_USER_ERROR, Constants.REQUEST_PROXY_ERROR_MESSAGE, details=error) + + previous_initializer = Initializer.get_initializer() + + initializer = Initializer() + initializer.environment = previous_initializer.environment if environment is None else environment + initializer.sdk_config = previous_initializer.sdk_config if sdk_config is None else sdk_config + initializer.store = Initializer.initializer.store + initializer.resource_path = Initializer.initializer.resource_path + initializer.request_proxy = proxy + initializer.token = token + if token is not None: + token.generate_token() + initializer.token = token + Initializer.LOCAL.init = initializer + + logging.getLogger('SDKLogger').info(Constants.INITIALIZATION_SWITCHED + initializer.__str__()) diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/__init__.py new file mode 100644 index 0000000..4b20384 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/__init__.py @@ -0,0 +1,6 @@ +from .inventory_converter import InventoryConverter +from .api_exception import APIException +from .success_response import SuccessResponse +from .module import Module +from .record import Record +from .convert_to import ConvertTo diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/api_exception.py new file mode 100644 index 0000000..04d05aa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/convert_to.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/convert_to.py new file mode 100644 index 0000000..864dabc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/convert_to.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertTo(object): + def __init__(self): + """Creates an instance of ConvertTo""" + + self.__module = None + self.__carry_over_tags = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_convert.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + bool: A bool representing the carry_over_tags + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (bool) : A bool representing the carry_over_tags + """ + + if carry_over_tags is not None and not isinstance(carry_over_tags, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: bool', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/inventory_converter.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/inventory_converter.py new file mode 100644 index 0000000..d95160f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/inventory_converter.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryConverter(object): + def __init__(self): + """Creates an instance of InventoryConverter""" + + self.__convert_to = None + self.__key_modified = dict() + + def get_convert_to(self): + """ + The method to get the convert_to + + Returns: + list: An instance of list + """ + + return self.__convert_to + + def set_convert_to(self, convert_to): + """ + The method to set the value to convert_to + + Parameters: + convert_to (list) : An instance of list + """ + + if convert_to is not None and not isinstance(convert_to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_to EXPECTED TYPE: list', None, None) + + self.__convert_to = convert_to + self.__key_modified['convert_to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/module.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/record.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/record.py new file mode 100644 index 0000000..54736b3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/record.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/success_response.py new file mode 100644 index 0000000..2b33f5d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_convert/success_response.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SuccessResponse(object): + def __init__(self): + """Creates an instance of SuccessResponse""" + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/__init__.py new file mode 100644 index 0000000..6ad0723 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/__init__.py @@ -0,0 +1,7 @@ +from .api_exception import APIException +from .success_response import SuccessResponse +from .module import Module +from .related_modules import RelatedModules +from .body_wrapper import BodyWrapper +from .user import User +from .convert_to import ConvertTo diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/api_exception.py new file mode 100644 index 0000000..04d05aa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/body_wrapper.py new file mode 100644 index 0000000..b6a1ec9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/body_wrapper.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__convert_to = None + self.__assign_to = None + self.__related_modules = None + self.__ids = None + self.__key_modified = dict() + + def get_convert_to(self): + """ + The method to get the convert_to + + Returns: + list: An instance of list + """ + + return self.__convert_to + + def set_convert_to(self, convert_to): + """ + The method to set the value to convert_to + + Parameters: + convert_to (list) : An instance of list + """ + + if convert_to is not None and not isinstance(convert_to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_to EXPECTED TYPE: list', None, None) + + self.__convert_to = convert_to + self.__key_modified['convert_to'] = 1 + + def get_assign_to(self): + """ + The method to get the assign_to + + Returns: + User: An instance of User + """ + + return self.__assign_to + + def set_assign_to(self, assign_to): + """ + The method to set the value to assign_to + + Parameters: + assign_to (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.user import User + except Exception: + from .user import User + + if assign_to is not None and not isinstance(assign_to, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assign_to EXPECTED TYPE: User', None, None) + + self.__assign_to = assign_to + self.__key_modified['assign_to'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/convert_to.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/convert_to.py new file mode 100644 index 0000000..9135f6d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/convert_to.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertTo(object): + def __init__(self): + """Creates an instance of ConvertTo""" + + self.__module = None + self.__carry_over_tags = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + bool: A bool representing the carry_over_tags + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (bool) : A bool representing the carry_over_tags + """ + + if carry_over_tags is not None and not isinstance(carry_over_tags, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: bool', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/module.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/related_modules.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/related_modules.py new file mode 100644 index 0000000..34c71ee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/related_modules.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedModules(object): + def __init__(self): + """Creates an instance of RelatedModules""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/success_response.py new file mode 100644 index 0000000..2b33f5d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/success_response.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SuccessResponse(object): + def __init__(self): + """Creates an instance of SuccessResponse""" + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/user.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/user.py new file mode 100644 index 0000000..b868d16 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_mass_convert/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/__init__.py new file mode 100644 index 0000000..17c4582 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/__init__.py @@ -0,0 +1,9 @@ +from .api_exception import APIException +from .inventory_templates import InventoryTemplates +from .response_handler import ResponseHandler +from .folder import Folder +from .inventory_templates_operations import InventoryTemplatesOperations, GetInventoryTemplatesParam +from .response_wrapper import ResponseWrapper +from .user import User +from .module_map import ModuleMap +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/api_exception.py new file mode 100644 index 0000000..83f0b23 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/folder.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/folder.py new file mode 100644 index 0000000..03de6e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/folder.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Folder(object): + def __init__(self): + """Creates an instance of Folder""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/info.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates.py new file mode 100644 index 0000000..ba98b73 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates.py @@ -0,0 +1,453 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail import Template +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..send_mail import Template + + +class InventoryTemplates(Template): + def __init__(self): + """Creates an instance of InventoryTemplates""" + super().__init__() + + self.__created_time = None + self.__modified_time = None + self.__last_usage_time = None + self.__folder = None + self.__module = None + self.__created_by = None + self.__modified_by = None + self.__name = None + self.__id = None + self.__editor_mode = None + self.__category = None + self.__favorite = None + self.__content = None + self.__active = None + self.__mail_content = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_last_usage_time(self): + """ + The method to get the last_usage_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_usage_time + + def set_last_usage_time(self, last_usage_time): + """ + The method to set the value to last_usage_time + + Parameters: + last_usage_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_usage_time is not None and not isinstance(last_usage_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_usage_time EXPECTED TYPE: datetime', None, None) + + self.__last_usage_time = last_usage_time + self.__key_modified['last_usage_time'] = 1 + + def get_folder(self): + """ + The method to get the folder + + Returns: + Folder: An instance of Folder + """ + + return self.__folder + + def set_folder(self, folder): + """ + The method to set the value to folder + + Parameters: + folder (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.folder import Folder + except Exception: + from .folder import Folder + + if folder is not None and not isinstance(folder, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: Folder', None, None) + + self.__folder = folder + self.__key_modified['folder'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_editor_mode(self): + """ + The method to get the editor_mode + + Returns: + string: A string representing the editor_mode + """ + + return self.__editor_mode + + def set_editor_mode(self, editor_mode): + """ + The method to set the value to editor_mode + + Parameters: + editor_mode (string) : A string representing the editor_mode + """ + + if editor_mode is not None and not isinstance(editor_mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editor_mode EXPECTED TYPE: str', None, None) + + self.__editor_mode = editor_mode + self.__key_modified['editor_mode'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_favorite(self): + """ + The method to get the favorite + + Returns: + bool: A bool representing the favorite + """ + + return self.__favorite + + def set_favorite(self, favorite): + """ + The method to set the value to favorite + + Parameters: + favorite (bool) : A bool representing the favorite + """ + + if favorite is not None and not isinstance(favorite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favorite EXPECTED TYPE: bool', None, None) + + self.__favorite = favorite + self.__key_modified['favorite'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_mail_content(self): + """ + The method to get the mail_content + + Returns: + string: A string representing the mail_content + """ + + return self.__mail_content + + def set_mail_content(self, mail_content): + """ + The method to set the value to mail_content + + Parameters: + mail_content (string) : A string representing the mail_content + """ + + if mail_content is not None and not isinstance(mail_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_content EXPECTED TYPE: str', None, None) + + self.__mail_content = mail_content + self.__key_modified['mail_content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.py new file mode 100644 index 0000000..7a10ef6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/inventory_templates_operations.py @@ -0,0 +1,86 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class InventoryTemplatesOperations(object): + def __init__(self): + """Creates an instance of InventoryTemplatesOperations""" + pass + + 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 + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/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.set_param(param_instance) + try: + from zohocrmsdk.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_inventory_template(self, template): + """ + The method to get inventory template + + Parameters: + template (int) : An int representing the template + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(template, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/inventory_templates/' + api_path = api_path + str(template) + 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) + try: + from zohocrmsdk.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') + + +class GetInventoryTemplatesParam(object): + module = Param('module', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') + category = Param('category', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.InventoryTemplates.GetInventoryTemplatesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/module_map.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/module_map.py new file mode 100644 index 0000000..cec4563 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/module_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleMap(object): + def __init__(self): + """Creates an instance of ModuleMap""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_wrapper.py new file mode 100644 index 0000000..e8d7358 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__inventory_templates = None + self.__info = None + self.__key_modified = dict() + + def get_inventory_templates(self): + """ + The method to get the inventory_templates + + Returns: + list: An instance of list + """ + + return self.__inventory_templates + + def set_inventory_templates(self, inventory_templates): + """ + The method to set the value to inventory_templates + + Parameters: + inventory_templates (list) : An instance of list + """ + + if inventory_templates is not None and not isinstance(inventory_templates, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_templates EXPECTED TYPE: list', None, None) + + self.__inventory_templates = inventory_templates + self.__key_modified['inventory_templates'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.inventory_templates.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/user.py b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/inventory_templates/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/isc_signature/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/isc_signature/__init__.py new file mode 100644 index 0000000..fac9820 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/isc_signature/__init__.py @@ -0,0 +1 @@ +from .signature import Signature diff --git a/zohocrmsdk/src/com/zoho/crm/api/isc_signature/signature.py b/zohocrmsdk/src/com/zoho/crm/api/isc_signature/signature.py new file mode 100644 index 0000000..6dd6b47 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/isc_signature/signature.py @@ -0,0 +1,71 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Signature(object): + def __init__(self): + """Creates an instance of Signature""" + + self.__isc_signature = None + self.__key_modified = dict() + + def get_isc_signature(self): + """ + The method to get the isc_signature + + Returns: + Object: A Object representing the isc_signature + """ + + return self.__isc_signature + + def set_isc_signature(self, isc_signature): + """ + The method to set the value to isc_signature + + Parameters: + isc_signature (Object) : A Object representing the isc_signature + """ + + self.__isc_signature = isc_signature + self.__key_modified['isc_signature'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/__init__.py new file mode 100644 index 0000000..baf727f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/__init__.py @@ -0,0 +1,24 @@ +from .action_wrapper import ActionWrapper +from .convert_mapping import ConvertMapping +from .layouts_operations import LayoutsOperations, GetLayoutsParam, GetLayoutsHeader, GetLayoutParam, GetLayoutHeader +from .tooltip import Tooltip +from .profiles import Profiles +from .section_subform_field import SectionSubformField +from .deal_field import DealField +from .body_wrapper import BodyWrapper +from .layouts import Layouts +from .sections import Sections +from .subform_property import SubformProperty +from .actions_allowed import ActionsAllowed +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .static_values import StaticValues +from .section_field import SectionField +from .response_wrapper import ResponseWrapper +from .deal_layout_mapping import DealLayoutMapping +from .minified_layout import MinifiedLayout +from .default_view import DefaultView +from .properties import Properties +from .default_assignment_view import DefaultAssignmentView diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/action_wrapper.py new file mode 100644 index 0000000..9cf6e92 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__layouts = None + self.__key_modified = dict() + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/actions_allowed.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/actions_allowed.py new file mode 100644 index 0000000..1a1024e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/actions_allowed.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionsAllowed(object): + def __init__(self): + """Creates an instance of ActionsAllowed""" + + self.__edit = None + self.__rename = None + self.__clone = None + self.__downgrade = None + self.__delete = None + self.__deactivate = None + self.__set_layout_permissions = None + self.__key_modified = dict() + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_rename(self): + """ + The method to get the rename + + Returns: + bool: A bool representing the rename + """ + + return self.__rename + + def set_rename(self, rename): + """ + The method to set the value to rename + + Parameters: + rename (bool) : A bool representing the rename + """ + + if rename is not None and not isinstance(rename, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rename EXPECTED TYPE: bool', None, None) + + self.__rename = rename + self.__key_modified['rename'] = 1 + + def get_clone(self): + """ + The method to get the clone + + Returns: + bool: A bool representing the clone + """ + + return self.__clone + + def set_clone(self, clone): + """ + The method to set the value to clone + + Parameters: + clone (bool) : A bool representing the clone + """ + + if clone is not None and not isinstance(clone, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: clone EXPECTED TYPE: bool', None, None) + + self.__clone = clone + self.__key_modified['clone'] = 1 + + def get_downgrade(self): + """ + The method to get the downgrade + + Returns: + bool: A bool representing the downgrade + """ + + return self.__downgrade + + def set_downgrade(self, downgrade): + """ + The method to set the value to downgrade + + Parameters: + downgrade (bool) : A bool representing the downgrade + """ + + if downgrade is not None and not isinstance(downgrade, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: downgrade EXPECTED TYPE: bool', None, None) + + self.__downgrade = downgrade + self.__key_modified['downgrade'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['delete'] = 1 + + def get_deactivate(self): + """ + The method to get the deactivate + + Returns: + bool: A bool representing the deactivate + """ + + return self.__deactivate + + def set_deactivate(self, deactivate): + """ + The method to set the value to deactivate + + Parameters: + deactivate (bool) : A bool representing the deactivate + """ + + if deactivate is not None and not isinstance(deactivate, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deactivate EXPECTED TYPE: bool', None, None) + + self.__deactivate = deactivate + self.__key_modified['deactivate'] = 1 + + def get_set_layout_permissions(self): + """ + The method to get the set_layout_permissions + + Returns: + bool: A bool representing the set_layout_permissions + """ + + return self.__set_layout_permissions + + def set_set_layout_permissions(self, set_layout_permissions): + """ + The method to set the value to set_layout_permissions + + Parameters: + set_layout_permissions (bool) : A bool representing the set_layout_permissions + """ + + if set_layout_permissions is not None and not isinstance(set_layout_permissions, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: set_layout_permissions EXPECTED TYPE: bool', None, None) + + self.__set_layout_permissions = set_layout_permissions + self.__key_modified['set_layout_permissions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/api_exception.py new file mode 100644 index 0000000..229019b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/body_wrapper.py new file mode 100644 index 0000000..5a896a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__layouts = None + self.__key_modified = dict() + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/convert_mapping.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/convert_mapping.py new file mode 100644 index 0000000..7235dbd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/convert_mapping.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConvertMapping(object): + def __init__(self): + """Creates an instance of ConvertMapping""" + + self.__contacts = None + self.__deals = None + self.__accounts = None + self.__invoices = None + self.__salesorders = None + self.__key_modified = dict() + + def get_contacts(self): + """ + The method to get the contacts + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__contacts + + def set_contacts(self, contacts): + """ + The method to set the value to contacts + + Parameters: + contacts (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if contacts is not None and not isinstance(contacts, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contacts EXPECTED TYPE: MinifiedLayout', None, None) + + self.__contacts = contacts + self.__key_modified['Contacts'] = 1 + + def get_deals(self): + """ + The method to get the deals + + Returns: + DealLayoutMapping: An instance of DealLayoutMapping + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (DealLayoutMapping) : An instance of DealLayoutMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.deal_layout_mapping import DealLayoutMapping + except Exception: + from .deal_layout_mapping import DealLayoutMapping + + if deals is not None and not isinstance(deals, DealLayoutMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: DealLayoutMapping', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_accounts(self): + """ + The method to get the accounts + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__accounts + + def set_accounts(self, accounts): + """ + The method to set the value to accounts + + Parameters: + accounts (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if accounts is not None and not isinstance(accounts, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: accounts EXPECTED TYPE: MinifiedLayout', None, None) + + self.__accounts = accounts + self.__key_modified['Accounts'] = 1 + + def get_invoices(self): + """ + The method to get the invoices + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__invoices + + def set_invoices(self, invoices): + """ + The method to set the value to invoices + + Parameters: + invoices (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if invoices is not None and not isinstance(invoices, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: invoices EXPECTED TYPE: MinifiedLayout', None, None) + + self.__invoices = invoices + self.__key_modified['Invoices'] = 1 + + def get_salesorders(self): + """ + The method to get the salesorders + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__salesorders + + def set_salesorders(self, salesorders): + """ + The method to set the value to salesorders + + Parameters: + salesorders (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if salesorders is not None and not isinstance(salesorders, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: salesorders EXPECTED TYPE: MinifiedLayout', None, None) + + self.__salesorders = salesorders + self.__key_modified['SalesOrders'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_field.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_field.py new file mode 100644 index 0000000..a0dbbda --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_field.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DealField(object): + def __init__(self): + """Creates an instance of DealField""" + + self.__api_name = None + self.__field_label = None + self.__id = None + self.__required = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_layout_mapping.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_layout_mapping.py new file mode 100644 index 0000000..3a3a62b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/deal_layout_mapping.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout +except Exception: + from ..exception import SDKException + from ..util import Constants + from .minified_layout import MinifiedLayout + + +class DealLayoutMapping(MinifiedLayout): + def __init__(self): + """Creates an instance of DealLayoutMapping""" + super().__init__() + + self.__fields = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/default_assignment_view.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/default_assignment_view.py new file mode 100644 index 0000000..6c71818 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/default_assignment_view.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultAssignmentView(object): + def __init__(self): + """Creates an instance of DefaultAssignmentView""" + + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/default_view.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/default_view.py new file mode 100644 index 0000000..49e724a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/default_view.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultView(object): + def __init__(self): + """Creates an instance of DefaultView""" + + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts.py new file mode 100644 index 0000000..e1a1a3d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts.py @@ -0,0 +1,633 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layouts(object): + def __init__(self): + """Creates an instance of Layouts""" + + self.__display_type = None + self.__api_name = None + self.__has_more_profiles = None + self.__created_time = None + self.__modified_time = None + self.__visible = None + self.__source = None + self.__id = None + self.__name = None + self.__display_label = None + self.__mode = None + self.__subform_properties = None + self.__status = None + self.__show_business_card = None + self.__generated_type = None + self.__created_for = None + self.__convert_mapping = None + self.__modified_by = None + self.__profiles = None + self.__created_by = None + self.__sections = None + self.__actions_allowed = None + self.__key_modified = dict() + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_has_more_profiles(self): + """ + The method to get the has_more_profiles + + Returns: + bool: A bool representing the has_more_profiles + """ + + return self.__has_more_profiles + + def set_has_more_profiles(self, has_more_profiles): + """ + The method to set the value to has_more_profiles + + Parameters: + has_more_profiles (bool) : A bool representing the has_more_profiles + """ + + if has_more_profiles is not None and not isinstance(has_more_profiles, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_more_profiles EXPECTED TYPE: bool', None, None) + + self.__has_more_profiles = has_more_profiles + self.__key_modified['has_more_profiles'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_mode(self): + """ + The method to get the mode + + Returns: + string: A string representing the mode + """ + + return self.__mode + + def set_mode(self, mode): + """ + The method to set the value to mode + + Parameters: + mode (string) : A string representing the mode + """ + + if mode is not None and not isinstance(mode, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mode EXPECTED TYPE: str', None, None) + + self.__mode = mode + self.__key_modified['mode'] = 1 + + def get_subform_properties(self): + """ + The method to get the subform_properties + + Returns: + SubformProperty: An instance of SubformProperty + """ + + return self.__subform_properties + + def set_subform_properties(self, subform_properties): + """ + The method to set the value to subform_properties + + Parameters: + subform_properties (SubformProperty) : An instance of SubformProperty + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.subform_property import SubformProperty + except Exception: + from .subform_property import SubformProperty + + if subform_properties is not None and not isinstance(subform_properties, SubformProperty): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform_properties EXPECTED TYPE: SubformProperty', None, None) + + self.__subform_properties = subform_properties + self.__key_modified['subform_properties'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_show_business_card(self): + """ + The method to get the show_business_card + + Returns: + bool: A bool representing the show_business_card + """ + + return self.__show_business_card + + def set_show_business_card(self, show_business_card): + """ + The method to set the value to show_business_card + + Parameters: + show_business_card (bool) : A bool representing the show_business_card + """ + + if show_business_card is not None and not isinstance(show_business_card, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_business_card EXPECTED TYPE: bool', None, None) + + self.__show_business_card = show_business_card + self.__key_modified['show_business_card'] = 1 + + def get_generated_type(self): + """ + The method to get the generated_type + + Returns: + string: A string representing the generated_type + """ + + return self.__generated_type + + def set_generated_type(self, generated_type): + """ + The method to set the value to generated_type + + Parameters: + generated_type (string) : A string representing the generated_type + """ + + if generated_type is not None and not isinstance(generated_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: str', None, None) + + self.__generated_type = generated_type + self.__key_modified['generated_type'] = 1 + + def get_created_for(self): + """ + The method to get the created_for + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_for + + def set_created_for(self, created_for): + """ + The method to set the value to created_for + + Parameters: + created_for (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_for is not None and not isinstance(created_for, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_for EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_for = created_for + self.__key_modified['created_for'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.convert_mapping import ConvertMapping + except Exception: + from .convert_mapping import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_sections(self): + """ + The method to get the sections + + Returns: + list: An instance of list + """ + + return self.__sections + + def set_sections(self, sections): + """ + The method to set the value to sections + + Parameters: + sections (list) : An instance of list + """ + + if sections is not None and not isinstance(sections, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: list', None, None) + + self.__sections = sections + self.__key_modified['sections'] = 1 + + def get_actions_allowed(self): + """ + The method to get the actions_allowed + + Returns: + ActionsAllowed: An instance of ActionsAllowed + """ + + return self.__actions_allowed + + def set_actions_allowed(self, actions_allowed): + """ + The method to set the value to actions_allowed + + Parameters: + actions_allowed (ActionsAllowed) : An instance of ActionsAllowed + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.actions_allowed import ActionsAllowed + except Exception: + from .actions_allowed import ActionsAllowed + + if actions_allowed is not None and not isinstance(actions_allowed, ActionsAllowed): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actions_allowed EXPECTED TYPE: ActionsAllowed', None, None) + + self.__actions_allowed = actions_allowed + self.__key_modified['actions_allowed'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts_operations.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts_operations.py new file mode 100644 index 0000000..ba76055 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/layouts_operations.py @@ -0,0 +1,105 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class LayoutsOperations(object): + def __init__(self): + """Creates an instance of LayoutsOperations""" + pass + + def get_layouts(self, param_instance=None): + """ + The method to get layouts + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/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.set_param(param_instance) + try: + from zohocrmsdk.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_layout(self, id, param_instance=None): + """ + The method to get layout + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/layouts/' + 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.set_param(param_instance) + try: + from zohocrmsdk.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') + + +class GetLayoutsParam(object): + module = Param('module', 'com.zoho.crm.api.Layouts.GetLayoutsParam') + + +class GetLayoutsHeader(object): + pass + + +class GetLayoutParam(object): + module = Param('module', 'com.zoho.crm.api.Layouts.GetLayoutParam') + + +class GetLayoutHeader(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/minified_layout.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/minified_layout.py new file mode 100644 index 0000000..500963c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/minified_layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedLayout(object): + def __init__(self): + """Creates an instance of MinifiedLayout""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/profiles.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/profiles.py new file mode 100644 index 0000000..87edd0e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/profiles.py @@ -0,0 +1,184 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profiles(object): + def __init__(self): + """Creates an instance of Profiles""" + + self.__default = None + self.__name = None + self.__id = None + self.__defaultview = None + self.__defaultassignmentview = None + self.__key_modified = dict() + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_defaultview(self): + """ + The method to get the defaultview + + Returns: + DefaultView: An instance of DefaultView + """ + + return self.__defaultview + + def set_defaultview(self, defaultview): + """ + The method to set the value to defaultview + + Parameters: + defaultview (DefaultView) : An instance of DefaultView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.default_view import DefaultView + except Exception: + from .default_view import DefaultView + + if defaultview is not None and not isinstance(defaultview, DefaultView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', None, None) + + self.__defaultview = defaultview + self.__key_modified['_default_view'] = 1 + + def get_defaultassignmentview(self): + """ + The method to get the defaultassignmentview + + Returns: + DefaultAssignmentView: An instance of DefaultAssignmentView + """ + + return self.__defaultassignmentview + + def set_defaultassignmentview(self, defaultassignmentview): + """ + The method to set the value to defaultassignmentview + + Parameters: + defaultassignmentview (DefaultAssignmentView) : An instance of DefaultAssignmentView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.default_assignment_view import DefaultAssignmentView + except Exception: + from .default_assignment_view import DefaultAssignmentView + + if defaultassignmentview is not None and not isinstance(defaultassignmentview, DefaultAssignmentView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultassignmentview EXPECTED TYPE: DefaultAssignmentView', None, None) + + self.__defaultassignmentview = defaultassignmentview + self.__key_modified['_default_assignment_view'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/properties.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/properties.py new file mode 100644 index 0000000..a00dafe --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/properties.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Properties(object): + def __init__(self): + """Creates an instance of Properties""" + + self.__reorder_rows = None + self.__maximum_rows = None + self.__tooltip = None + self.__key_modified = dict() + + def get_reorder_rows(self): + """ + The method to get the reorder_rows + + Returns: + bool: A bool representing the reorder_rows + """ + + return self.__reorder_rows + + def set_reorder_rows(self, reorder_rows): + """ + The method to set the value to reorder_rows + + Parameters: + reorder_rows (bool) : A bool representing the reorder_rows + """ + + if reorder_rows is not None and not isinstance(reorder_rows, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reorder_rows EXPECTED TYPE: bool', None, None) + + self.__reorder_rows = reorder_rows + self.__key_modified['reorder_rows'] = 1 + + def get_maximum_rows(self): + """ + The method to get the maximum_rows + + Returns: + int: An int representing the maximum_rows + """ + + return self.__maximum_rows + + def set_maximum_rows(self, maximum_rows): + """ + The method to set the value to maximum_rows + + Parameters: + maximum_rows (int) : An int representing the maximum_rows + """ + + if maximum_rows is not None and not isinstance(maximum_rows, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maximum_rows EXPECTED TYPE: int', None, None) + + self.__maximum_rows = maximum_rows + self.__key_modified['maximum_rows'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.tooltip import Tooltip + except Exception: + from .tooltip import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/response_wrapper.py new file mode 100644 index 0000000..3d0cdac --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__layouts = None + self.__key_modified = dict() + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/section_field.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/section_field.py new file mode 100644 index 0000000..c242ac2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/section_field.py @@ -0,0 +1,2238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import Fields + + +class SectionField(Fields): + def __init__(self): + """Creates an instance of SectionField""" + super().__init__() + + self.__required = None + self.__validation_rule = None + self.__default_value = None + self.__sequence_number = None + self.__section_id = None + self.__blueprint_supported = None + self.__json_type = None + self.__length = None + self.__decimal_place = None + self.__multi_module_lookup = None + self.__sharing_properties = None + self.__currency = None + self.__file_upolad_optionlist = None + self.__lookup = None + self.__subform = None + self.__formula = None + self.__multiselectlookup = None + self.__multiuserlookup = None + self.__pick_list_values = None + self.__allowed_modules = None + self.__hipaa_compliance_enabled = None + self.__hipaa_compliance = None + self.__static_values = None + self.__static_field = None + self.__layout_associations = None + self.__associated_module = None + self.__data_type = None + self.__operation_type = None + self.__system_mandatory = None + self.__webhook = None + self.__virtual_field = None + self.__field_read_only = None + self.__customizable_properties = None + self.__read_only = None + self.__custom_field = None + self.__businesscard_supported = None + self.__filterable = None + self.__visible = None + self.__available_in_user_layout = None + self.__display_field = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__separator = None + self.__searchable = None + self.__enable_colour_code = None + self.__mass_update = None + self.__created_source = None + self.__type = None + self.__display_label = None + self.__column_name = None + self.__api_name = None + self.__display_type = None + self.__ui_type = None + self.__colour_code_enabled_by_system = None + self.__quick_sequence_number = None + self.__email_parser = None + self.__rollup_summary = None + self.__refer_from_field = None + self.__created_time = None + self.__modified_time = None + self.__show_type = None + self.__category = None + self.__id = None + self.__profiles = None + self.__view_type = None + self.__unique = None + self.__sub_module = None + self.__external = None + self.__private = None + self.__convert_mapping = None + self.__autonumber = None + self.__auto_number_70 = None + self.__crypt = None + self.__tooltip = None + self.__history_tracking = None + self.__association_details = None + self.__additional_column = None + self.__field_label = None + self.__global_picklist = None + self.__updateexistingrecords = None + self.__number_separator = None + self.__textarea = None + self.__key_modified = dict() + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_validation_rule(self): + """ + The method to get the validation_rule + + Returns: + dict: An instance of dict + """ + + return self.__validation_rule + + def set_validation_rule(self, validation_rule): + """ + The method to set the value to validation_rule + + Parameters: + validation_rule (dict) : An instance of dict + """ + + if validation_rule is not None and not isinstance(validation_rule, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: validation_rule EXPECTED TYPE: dict', None, None) + + self.__validation_rule = validation_rule + self.__key_modified['validation_rule'] = 1 + + def get_default_value(self): + """ + The method to get the default_value + + Returns: + string: A string representing the default_value + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (string) : A string representing the default_value + """ + + if default_value is not None and not isinstance(default_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: str', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_section_id(self): + """ + The method to get the section_id + + Returns: + int: An int representing the section_id + """ + + return self.__section_id + + def set_section_id(self, section_id): + """ + The method to set the value to section_id + + Parameters: + section_id (int) : An int representing the section_id + """ + + if section_id is not None and not isinstance(section_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: section_id EXPECTED TYPE: int', None, None) + + self.__section_id = section_id + self.__key_modified['section_id'] = 1 + + def get_blueprint_supported(self): + """ + The method to get the blueprint_supported + + Returns: + bool: A bool representing the blueprint_supported + """ + + return self.__blueprint_supported + + def set_blueprint_supported(self, blueprint_supported): + """ + The method to set the value to blueprint_supported + + Parameters: + blueprint_supported (bool) : A bool representing the blueprint_supported + """ + + if blueprint_supported is not None and not isinstance(blueprint_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: bool', None, None) + + self.__blueprint_supported = blueprint_supported + self.__key_modified['blueprint_supported'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + int: An int representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (int) : An int representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: int', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MultiModuleLookup + except Exception: + from ..fields import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_sharing_properties(self): + """ + The method to get the sharing_properties + + Returns: + SharingProperties: An instance of SharingProperties + """ + + return self.__sharing_properties + + def set_sharing_properties(self, sharing_properties): + """ + The method to set the value to sharing_properties + + Parameters: + sharing_properties (SharingProperties) : An instance of SharingProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import SharingProperties + except Exception: + from ..modules import SharingProperties + + if sharing_properties is not None and not isinstance(sharing_properties, SharingProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_properties EXPECTED TYPE: SharingProperties', None, None) + + self.__sharing_properties = sharing_properties + self.__key_modified['sharing_properties'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Currency + except Exception: + from ..fields import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_file_upolad_optionlist(self): + """ + The method to get the file_upolad_optionlist + + Returns: + list: An instance of list + """ + + return self.__file_upolad_optionlist + + def set_file_upolad_optionlist(self, file_upolad_optionlist): + """ + The method to set the value to file_upolad_optionlist + + Parameters: + file_upolad_optionlist (list) : An instance of list + """ + + if file_upolad_optionlist is not None and not isinstance(file_upolad_optionlist, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_upolad_optionlist EXPECTED TYPE: list', None, None) + + self.__file_upolad_optionlist = file_upolad_optionlist + self.__key_modified['file_upolad_optionlist'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Lookup: An instance of Lookup + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Lookup) : An instance of Lookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Lookup + except Exception: + from ..fields import Lookup + + if lookup is not None and not isinstance(lookup, Lookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Lookup', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_subform(self): + """ + The method to get the subform + + Returns: + Subform: An instance of Subform + """ + + return self.__subform + + def set_subform(self, subform): + """ + The method to set the value to subform + + Parameters: + subform (Subform) : An instance of Subform + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Subform + except Exception: + from ..fields import Subform + + if subform is not None and not isinstance(subform, Subform): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Subform', None, None) + + self.__subform = subform + self.__key_modified['subform'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Formula + except Exception: + from ..fields import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_multiuserlookup(self): + """ + The method to get the multiuserlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiuserlookup + + def set_multiuserlookup(self, multiuserlookup): + """ + The method to set the value to multiuserlookup + + Parameters: + multiuserlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiuserlookup is not None and not isinstance(multiuserlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiuserlookup = multiuserlookup + self.__key_modified['multiuserlookup'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_allowed_modules(self): + """ + The method to get the allowed_modules + + Returns: + list: An instance of list + """ + + return self.__allowed_modules + + def set_allowed_modules(self, allowed_modules): + """ + The method to set the value to allowed_modules + + Parameters: + allowed_modules (list) : An instance of list + """ + + if allowed_modules is not None and not isinstance(allowed_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_modules EXPECTED TYPE: list', None, None) + + self.__allowed_modules = allowed_modules + self.__key_modified['allowed_modules'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HipaaCompliance + except Exception: + from ..fields import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def get_static_values(self): + """ + The method to get the static_values + + Returns: + list: An instance of list + """ + + return self.__static_values + + def set_static_values(self, static_values): + """ + The method to set the value to static_values + + Parameters: + static_values (list) : An instance of list + """ + + if static_values is not None and not isinstance(static_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_values EXPECTED TYPE: list', None, None) + + self.__static_values = static_values + self.__key_modified['static_values'] = 1 + + def get_static_field(self): + """ + The method to get the static_field + + Returns: + bool: A bool representing the static_field + """ + + return self.__static_field + + def set_static_field(self, static_field): + """ + The method to set the value to static_field + + Parameters: + static_field (bool) : A bool representing the static_field + """ + + if static_field is not None and not isinstance(static_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_field EXPECTED TYPE: bool', None, None) + + self.__static_field = static_field + self.__key_modified['static_field'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def get_associated_module(self): + """ + The method to get the associated_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__associated_module + + def set_associated_module(self, associated_module): + """ + The method to set the value to associated_module + + Parameters: + associated_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if associated_module is not None and not isinstance(associated_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__associated_module = associated_module + self.__key_modified['associated_module'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_operation_type(self): + """ + The method to get the operation_type + + Returns: + OperationType: An instance of OperationType + """ + + return self.__operation_type + + def set_operation_type(self, operation_type): + """ + The method to set the value to operation_type + + Parameters: + operation_type (OperationType) : An instance of OperationType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import OperationType + except Exception: + from ..fields import OperationType + + if operation_type is not None and not isinstance(operation_type, OperationType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_type EXPECTED TYPE: OperationType', None, None) + + self.__operation_type = operation_type + self.__key_modified['operation_type'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_virtual_field(self): + """ + The method to get the virtual_field + + Returns: + bool: A bool representing the virtual_field + """ + + return self.__virtual_field + + def set_virtual_field(self, virtual_field): + """ + The method to set the value to virtual_field + + Parameters: + virtual_field (bool) : A bool representing the virtual_field + """ + + if virtual_field is not None and not isinstance(virtual_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: virtual_field EXPECTED TYPE: bool', None, None) + + self.__virtual_field = virtual_field + self.__key_modified['virtual_field'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_customizable_properties(self): + """ + The method to get the customizable_properties + + Returns: + list: An instance of list + """ + + return self.__customizable_properties + + def set_customizable_properties(self, customizable_properties): + """ + The method to set the value to customizable_properties + + Parameters: + customizable_properties (list) : An instance of list + """ + + if customizable_properties is not None and not isinstance(customizable_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable_properties EXPECTED TYPE: list', None, None) + + self.__customizable_properties = customizable_properties + self.__key_modified['customizable_properties'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_businesscard_supported(self): + """ + The method to get the businesscard_supported + + Returns: + bool: A bool representing the businesscard_supported + """ + + return self.__businesscard_supported + + def set_businesscard_supported(self, businesscard_supported): + """ + The method to set the value to businesscard_supported + + Parameters: + businesscard_supported (bool) : A bool representing the businesscard_supported + """ + + if businesscard_supported is not None and not isinstance(businesscard_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: bool', None, None) + + self.__businesscard_supported = businesscard_supported + self.__key_modified['businesscard_supported'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + bool: A bool representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (bool) : A bool representing the display_field + """ + + if display_field is not None and not isinstance(display_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: bool', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_separator(self): + """ + The method to get the separator + + Returns: + bool: A bool representing the separator + """ + + return self.__separator + + def set_separator(self, separator): + """ + The method to set the value to separator + + Parameters: + separator (bool) : A bool representing the separator + """ + + if separator is not None and not isinstance(separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: separator EXPECTED TYPE: bool', None, None) + + self.__separator = separator + self.__key_modified['separator'] = 1 + + def get_searchable(self): + """ + The method to get the searchable + + Returns: + bool: A bool representing the searchable + """ + + return self.__searchable + + def set_searchable(self, searchable): + """ + The method to set the value to searchable + + Parameters: + searchable (bool) : A bool representing the searchable + """ + + if searchable is not None and not isinstance(searchable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: searchable EXPECTED TYPE: bool', None, None) + + self.__searchable = searchable + self.__key_modified['searchable'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_mass_update(self): + """ + The method to get the mass_update + + Returns: + bool: A bool representing the mass_update + """ + + return self.__mass_update + + def set_mass_update(self, mass_update): + """ + The method to set the value to mass_update + + Parameters: + mass_update (bool) : A bool representing the mass_update + """ + + if mass_update is not None and not isinstance(mass_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: bool', None, None) + + self.__mass_update = mass_update + self.__key_modified['mass_update'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_colour_code_enabled_by_system(self): + """ + The method to get the colour_code_enabled_by_system + + Returns: + bool: A bool representing the colour_code_enabled_by_system + """ + + return self.__colour_code_enabled_by_system + + def set_colour_code_enabled_by_system(self, colour_code_enabled_by_system): + """ + The method to set the value to colour_code_enabled_by_system + + Parameters: + colour_code_enabled_by_system (bool) : A bool representing the colour_code_enabled_by_system + """ + + if colour_code_enabled_by_system is not None and not isinstance(colour_code_enabled_by_system, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code_enabled_by_system EXPECTED TYPE: bool', None, None) + + self.__colour_code_enabled_by_system = colour_code_enabled_by_system + self.__key_modified['colour_code_enabled_by_system'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + string: A string representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (string) : A string representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: str', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_email_parser(self): + """ + The method to get the email_parser + + Returns: + EmailParser: An instance of EmailParser + """ + + return self.__email_parser + + def set_email_parser(self, email_parser): + """ + The method to set the value to email_parser + + Parameters: + email_parser (EmailParser) : An instance of EmailParser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import EmailParser + except Exception: + from ..fields import EmailParser + + if email_parser is not None and not isinstance(email_parser, EmailParser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser EXPECTED TYPE: EmailParser', None, None) + + self.__email_parser = email_parser + self.__key_modified['email_parser'] = 1 + + def get_rollup_summary(self): + """ + The method to get the rollup_summary + + Returns: + RollupSummary: An instance of RollupSummary + """ + + return self.__rollup_summary + + def set_rollup_summary(self, rollup_summary): + """ + The method to set the value to rollup_summary + + Parameters: + rollup_summary (RollupSummary) : An instance of RollupSummary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import RollupSummary + except Exception: + from ..fields import RollupSummary + + if rollup_summary is not None and not isinstance(rollup_summary, RollupSummary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_summary EXPECTED TYPE: RollupSummary', None, None) + + self.__rollup_summary = rollup_summary + self.__key_modified['rollup_summary'] = 1 + + def get_refer_from_field(self): + """ + The method to get the refer_from_field + + Returns: + ReferFromField: An instance of ReferFromField + """ + + return self.__refer_from_field + + def set_refer_from_field(self, refer_from_field): + """ + The method to set the value to refer_from_field + + Parameters: + refer_from_field (ReferFromField) : An instance of ReferFromField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ReferFromField + except Exception: + from ..fields import ReferFromField + + if refer_from_field is not None and not isinstance(refer_from_field, ReferFromField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: refer_from_field EXPECTED TYPE: ReferFromField', None, None) + + self.__refer_from_field = refer_from_field + self.__key_modified['refer_from_field'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_show_type(self): + """ + The method to get the show_type + + Returns: + int: An int representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (int) : An int representing the show_type + """ + + if show_type is not None and not isinstance(show_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: int', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ViewType + except Exception: + from ..fields import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Unique + except Exception: + from ..fields import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if sub_module is not None and not isinstance(sub_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import External + except Exception: + from ..fields import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Private + except Exception: + from ..fields import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ConvertMapping + except Exception: + from ..fields import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_autonumber(self): + """ + The method to get the autonumber + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__autonumber + + def set_autonumber(self, autonumber): + """ + The method to set the value to autonumber + + Parameters: + autonumber (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if autonumber is not None and not isinstance(autonumber, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: autonumber EXPECTED TYPE: AutoNumber', None, None) + + self.__autonumber = autonumber + self.__key_modified['autonumber'] = 1 + + def get_auto_number_70(self): + """ + The method to get the auto_number_70 + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number_70 + + def set_auto_number_70(self, auto_number_70): + """ + The method to set the value to auto_number_70 + + Parameters: + auto_number_70 (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if auto_number_70 is not None and not isinstance(auto_number_70, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number_70 EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number_70 = auto_number_70 + self.__key_modified['auto_number'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Crypt + except Exception: + from ..fields import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Tooltip + except Exception: + from ..fields import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + HistoryTracking: An instance of HistoryTracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (HistoryTracking) : An instance of HistoryTracking + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HistoryTracking + except Exception: + from ..fields import HistoryTracking + + if history_tracking is not None and not isinstance(history_tracking, HistoryTracking): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AssociationDetails + except Exception: + from ..fields import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_additional_column(self): + """ + The method to get the additional_column + + Returns: + string: A string representing the additional_column + """ + + return self.__additional_column + + def set_additional_column(self, additional_column): + """ + The method to set the value to additional_column + + Parameters: + additional_column (string) : A string representing the additional_column + """ + + if additional_column is not None and not isinstance(additional_column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: additional_column EXPECTED TYPE: str', None, None) + + self.__additional_column = additional_column + self.__key_modified['additional_column'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_global_picklist(self): + """ + The method to get the global_picklist + + Returns: + Object: A Object representing the global_picklist + """ + + return self.__global_picklist + + def set_global_picklist(self, global_picklist): + """ + The method to set the value to global_picklist + + Parameters: + global_picklist (Object) : A Object representing the global_picklist + """ + + self.__global_picklist = global_picklist + self.__key_modified['global_picklist'] = 1 + + def get_updateexistingrecords(self): + """ + The method to get the updateexistingrecords + + Returns: + bool: A bool representing the updateexistingrecords + """ + + return self.__updateexistingrecords + + def set_updateexistingrecords(self, updateexistingrecords): + """ + The method to set the value to updateexistingrecords + + Parameters: + updateexistingrecords (bool) : A bool representing the updateexistingrecords + """ + + if updateexistingrecords is not None and not isinstance(updateexistingrecords, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updateexistingrecords EXPECTED TYPE: bool', None, None) + + self.__updateexistingrecords = updateexistingrecords + self.__key_modified['_update_existing_records'] = 1 + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + bool: A bool representing the number_separator + """ + + return self.__number_separator + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (bool) : A bool representing the number_separator + """ + + if number_separator is not None and not isinstance(number_separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: bool', None, None) + + self.__number_separator = number_separator + self.__key_modified['number_separator'] = 1 + + def get_textarea(self): + """ + The method to get the textarea + + Returns: + Textarea: An instance of Textarea + """ + + return self.__textarea + + def set_textarea(self, textarea): + """ + The method to set the value to textarea + + Parameters: + textarea (Textarea) : An instance of Textarea + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Textarea + except Exception: + from ..fields import Textarea + + if textarea is not None and not isinstance(textarea, Textarea): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: textarea EXPECTED TYPE: Textarea', None, None) + + self.__textarea = textarea + self.__key_modified['textarea'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/section_subform_field.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/section_subform_field.py new file mode 100644 index 0000000..2bbf525 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/section_subform_field.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SectionSubformField(object): + def __init__(self): + """Creates an instance of SectionSubformField""" + + self.__module = None + self.__id = None + self.__layout = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + MinifiedLayout: An instance of MinifiedLayout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (MinifiedLayout) : An instance of MinifiedLayout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.minified_layout import MinifiedLayout + except Exception: + from .minified_layout import MinifiedLayout + + if layout is not None and not isinstance(layout, MinifiedLayout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: MinifiedLayout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/sections.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/sections.py new file mode 100644 index 0000000..1ccb8df --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/sections.py @@ -0,0 +1,354 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Sections(object): + def __init__(self): + """Creates an instance of Sections""" + + self.__display_label = None + self.__sequence_number = None + self.__issubformsection = None + self.__tab_traversal = None + self.__api_name = None + self.__column_count = None + self.__name = None + self.__generated_type = None + self.__id = None + self.__type = None + self.__fields = None + self.__properties = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_issubformsection(self): + """ + The method to get the issubformsection + + Returns: + bool: A bool representing the issubformsection + """ + + return self.__issubformsection + + 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 get_tab_traversal(self): + """ + The method to get the tab_traversal + + Returns: + string: A string representing the tab_traversal + """ + + return self.__tab_traversal + + def set_tab_traversal(self, tab_traversal): + """ + The method to set the value to tab_traversal + + Parameters: + tab_traversal (string) : A string representing the tab_traversal + """ + + if tab_traversal is not None and not isinstance(tab_traversal, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tab_traversal EXPECTED TYPE: str', None, None) + + self.__tab_traversal = tab_traversal + self.__key_modified['tab_traversal'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_column_count(self): + """ + The method to get the column_count + + Returns: + int: An int representing the column_count + """ + + return self.__column_count + + def set_column_count(self, column_count): + """ + The method to set the value to column_count + + Parameters: + column_count (int) : An int representing the column_count + """ + + if column_count is not None and not isinstance(column_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: int', None, None) + + self.__column_count = column_count + self.__key_modified['column_count'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_generated_type(self): + """ + The method to get the generated_type + + Returns: + string: A string representing the generated_type + """ + + return self.__generated_type + + def set_generated_type(self, generated_type): + """ + The method to set the value to generated_type + + Parameters: + generated_type (string) : A string representing the generated_type + """ + + if generated_type is not None and not isinstance(generated_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: str', None, None) + + self.__generated_type = generated_type + self.__key_modified['generated_type'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + Properties: An instance of Properties + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (Properties) : An instance of Properties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts.properties import Properties + except Exception: + from .properties import Properties + + if properties is not None and not isinstance(properties, Properties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: Properties', None, None) + + self.__properties = properties + self.__key_modified['properties'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/static_values.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/static_values.py new file mode 100644 index 0000000..eeb75ac --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/static_values.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class StaticValues(object): + def __init__(self): + """Creates an instance of StaticValues""" + + self.__sequence_number = None + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/subform_property.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/subform_property.py new file mode 100644 index 0000000..a841ea6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/subform_property.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SubformProperty(object): + def __init__(self): + """Creates an instance of SubformProperty""" + + self.__pinned_column = None + self.__key_modified = dict() + + def get_pinned_column(self): + """ + The method to get the pinned_column + + Returns: + bool: A bool representing the pinned_column + """ + + return self.__pinned_column + + def set_pinned_column(self, pinned_column): + """ + The method to set the value to pinned_column + + Parameters: + pinned_column (bool) : A bool representing the pinned_column + """ + + if pinned_column is not None and not isinstance(pinned_column, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pinned_column EXPECTED TYPE: bool', None, None) + + self.__pinned_column = pinned_column + self.__key_modified['pinned_column'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/success_response.py new file mode 100644 index 0000000..fd7de58 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.layouts.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/layouts/tooltip.py b/zohocrmsdk/src/com/zoho/crm/api/layouts/tooltip.py new file mode 100644 index 0000000..1022c17 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/layouts/tooltip.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Tooltip(object): + def __init__(self): + """Creates an instance of Tooltip""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + Choice: An instance of Choice + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (Choice) : An instance of Choice + """ + + if name is not None and not isinstance(name, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: Choice', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/__init__.py new file mode 100644 index 0000000..f6b10b7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/__init__.py @@ -0,0 +1,20 @@ +from .action_wrapper import ActionWrapper +from .address import Address +from .mail_merge_template import MailMergeTemplate +from .mail_merge import MailMerge +from .sign_mail_merge_wrapper import SignMailMergeWrapper +from .sign_action_handler import SignActionHandler +from .signers import Signers +from .api_exception import APIException +from .action_response import ActionResponse +from .download_mail_merge import DownloadMailMerge +from .download_mail_merge_wrapper import DownloadMailMergeWrapper +from .file_body_wrapper import FileBodyWrapper +from .download_response_handler import DownloadResponseHandler +from .sign_action_response import SignActionResponse +from .success_response import SuccessResponse +from .sign_action_wrapper import SignActionWrapper +from .action_handler import ActionHandler +from .sign_mail_merge import SignMailMerge +from .mail_merge_operations import MailMergeOperations +from .mail_merge_wrapper import MailMergeWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_wrapper.py new file mode 100644 index 0000000..d09068f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__send_mail_merge = None + self.__key_modified = dict() + + def get_send_mail_merge(self): + """ + The method to get the send_mail_merge + + Returns: + list: An instance of list + """ + + return self.__send_mail_merge + + def set_send_mail_merge(self, send_mail_merge): + """ + The method to set the value to send_mail_merge + + Parameters: + send_mail_merge (list) : An instance of list + """ + + if send_mail_merge is not None and not isinstance(send_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: send_mail_merge EXPECTED TYPE: list', None, None) + + self.__send_mail_merge = send_mail_merge + self.__key_modified['send_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/address.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/address.py new file mode 100644 index 0000000..b8f70be --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/address.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__type = None + self.__value = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/api_exception.py new file mode 100644 index 0000000..84ecfd9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_response_handler import DownloadResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_response import SignActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_handler import SignActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .download_response_handler import DownloadResponseHandler + from .sign_action_response import SignActionResponse + from .action_handler import ActionHandler + from .sign_action_handler import SignActionHandler + + +class APIException(ActionHandler, ActionResponse, DownloadResponseHandler, SignActionHandler, SignActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge.py new file mode 100644 index 0000000..1b0b854 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class DownloadMailMerge(object): + def __init__(self): + """Creates an instance of DownloadMailMerge""" + + self.__mail_merge_template = None + self.__output_format = None + self.__file_name = None + self.__password = None + self.__key_modified = dict() + + def get_mail_merge_template(self): + """ + The method to get the mail_merge_template + + Returns: + MailMergeTemplate: An instance of MailMergeTemplate + """ + + return self.__mail_merge_template + + def set_mail_merge_template(self, mail_merge_template): + """ + The method to set the value to mail_merge_template + + Parameters: + mail_merge_template (MailMergeTemplate) : An instance of MailMergeTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_template import MailMergeTemplate + except Exception: + from .mail_merge_template import MailMergeTemplate + + if mail_merge_template is not None and not isinstance(mail_merge_template, MailMergeTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_merge_template EXPECTED TYPE: MailMergeTemplate', None, None) + + self.__mail_merge_template = mail_merge_template + self.__key_modified['mail_merge_template'] = 1 + + def get_output_format(self): + """ + The method to get the output_format + + Returns: + Choice: An instance of Choice + """ + + return self.__output_format + + def set_output_format(self, output_format): + """ + The method to set the value to output_format + + Parameters: + output_format (Choice) : An instance of Choice + """ + + if output_format is not None and not isinstance(output_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: output_format EXPECTED TYPE: Choice', None, None) + + self.__output_format = output_format + self.__key_modified['output_format'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_password(self): + """ + The method to get the password + + Returns: + string: A string representing the password + """ + + return self.__password + + def set_password(self, password): + """ + The method to set the value to password + + Parameters: + password (string) : A string representing the password + """ + + if password is not None and not isinstance(password, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: password EXPECTED TYPE: str', None, None) + + self.__password = password + self.__key_modified['password'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge_wrapper.py new file mode 100644 index 0000000..3c8295f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_mail_merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DownloadMailMergeWrapper(object): + def __init__(self): + """Creates an instance of DownloadMailMergeWrapper""" + + self.__download_mail_merge = None + self.__key_modified = dict() + + def get_download_mail_merge(self): + """ + The method to get the download_mail_merge + + Returns: + list: An instance of list + """ + + return self.__download_mail_merge + + def set_download_mail_merge(self, download_mail_merge): + """ + The method to set the value to download_mail_merge + + Parameters: + download_mail_merge (list) : An instance of list + """ + + if download_mail_merge is not None and not isinstance(download_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: download_mail_merge EXPECTED TYPE: list', None, None) + + self.__download_mail_merge = download_mail_merge + self.__key_modified['download_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_response_handler.py new file mode 100644 index 0000000..3d52e2f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/download_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DownloadResponseHandler(ABC): + def __init__(self): + """Creates an instance of DownloadResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/file_body_wrapper.py new file mode 100644 index 0000000..ff904cc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_response_handler import DownloadResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .download_response_handler import DownloadResponseHandler + + +class FileBodyWrapper(DownloadResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge.py new file mode 100644 index 0000000..d7396c9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge.py @@ -0,0 +1,284 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MailMerge(object): + def __init__(self): + """Creates an instance of MailMerge""" + + self.__mail_merge_template = None + self.__from_address = None + self.__to_address = None + self.__cc_email = None + self.__bcc_email = None + self.__subject = None + self.__message = None + self.__type = None + self.__attachment_name = None + self.__key_modified = dict() + + def get_mail_merge_template(self): + """ + The method to get the mail_merge_template + + Returns: + MailMergeTemplate: An instance of MailMergeTemplate + """ + + return self.__mail_merge_template + + def set_mail_merge_template(self, mail_merge_template): + """ + The method to set the value to mail_merge_template + + Parameters: + mail_merge_template (MailMergeTemplate) : An instance of MailMergeTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_template import MailMergeTemplate + except Exception: + from .mail_merge_template import MailMergeTemplate + + if mail_merge_template is not None and not isinstance(mail_merge_template, MailMergeTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_merge_template EXPECTED TYPE: MailMergeTemplate', None, None) + + self.__mail_merge_template = mail_merge_template + self.__key_modified['mail_merge_template'] = 1 + + def get_from_address(self): + """ + The method to get the from_address + + Returns: + Address: An instance of Address + """ + + return self.__from_address + + def set_from_address(self, from_address): + """ + The method to set the value to from_address + + Parameters: + from_address (Address) : An instance of Address + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.address import Address + except Exception: + from .address import Address + + if from_address is not None and not isinstance(from_address, Address): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_address EXPECTED TYPE: Address', None, None) + + self.__from_address = from_address + self.__key_modified['from_address'] = 1 + + def get_to_address(self): + """ + The method to get the to_address + + Returns: + list: An instance of list + """ + + return self.__to_address + + def set_to_address(self, to_address): + """ + The method to set the value to to_address + + Parameters: + to_address (list) : An instance of list + """ + + if to_address is not None and not isinstance(to_address, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to_address EXPECTED TYPE: list', None, None) + + self.__to_address = to_address + self.__key_modified['to_address'] = 1 + + def get_cc_email(self): + """ + The method to get the cc_email + + Returns: + list: An instance of list + """ + + return self.__cc_email + + def set_cc_email(self, cc_email): + """ + The method to set the value to cc_email + + Parameters: + cc_email (list) : An instance of list + """ + + if cc_email is not None and not isinstance(cc_email, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc_email EXPECTED TYPE: list', None, None) + + self.__cc_email = cc_email + self.__key_modified['cc_email'] = 1 + + def get_bcc_email(self): + """ + The method to get the bcc_email + + Returns: + list: An instance of list + """ + + return self.__bcc_email + + def set_bcc_email(self, bcc_email): + """ + The method to set the value to bcc_email + + Parameters: + bcc_email (list) : An instance of list + """ + + if bcc_email is not None and not isinstance(bcc_email, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc_email EXPECTED TYPE: list', None, None) + + self.__bcc_email = bcc_email + self.__key_modified['bcc_email'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_attachment_name(self): + """ + The method to get the attachment_name + + Returns: + string: A string representing the attachment_name + """ + + return self.__attachment_name + + def set_attachment_name(self, attachment_name): + """ + The method to set the value to attachment_name + + Parameters: + attachment_name (string) : A string representing the attachment_name + """ + + if attachment_name is not None and not isinstance(attachment_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_name EXPECTED TYPE: str', None, None) + + self.__attachment_name = attachment_name + self.__key_modified['attachment_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_operations.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_operations.py new file mode 100644 index 0000000..e7857fa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_operations.py @@ -0,0 +1,150 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class MailMergeOperations(object): + def __init__(self, module, id): + """ + Creates an instance of MailMergeOperations with the given parameters + + Parameters: + module (string) : A string representing the module + id (string) : A string representing the id + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__module = module + self.__id = id + + + def send_mail_merge(self, request): + """ + The method to send mail merge + + Parameters: + request (MailMergeWrapper) : An instance of MailMergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_wrapper import MailMergeWrapper + except Exception: + from .mail_merge_wrapper import MailMergeWrapper + + if request is not None and not isinstance(request, MailMergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MailMergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/send_mail_merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def download_mail_merge(self, request): + """ + The method to download mail merge + + Parameters: + request (DownloadMailMergeWrapper) : An instance of DownloadMailMergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_mail_merge_wrapper import DownloadMailMergeWrapper + except Exception: + from .download_mail_merge_wrapper import DownloadMailMergeWrapper + + if request is not None and not isinstance(request, DownloadMailMergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: DownloadMailMergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/download_mail_merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.download_response_handler import DownloadResponseHandler + except Exception: + from .download_response_handler import DownloadResponseHandler + return handler_instance.api_call(DownloadResponseHandler.__module__, 'application/json') + + def sign_mail_merge(self, request): + """ + The method to sign mail merge + + Parameters: + request (SignMailMergeWrapper) : An instance of SignMailMergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_mail_merge_wrapper import SignMailMergeWrapper + except Exception: + from .sign_mail_merge_wrapper import SignMailMergeWrapper + + if request is not None and not isinstance(request, SignMailMergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: SignMailMergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/sign_mail_merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_handler import SignActionHandler + except Exception: + from .sign_action_handler import SignActionHandler + return handler_instance.api_call(SignActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_template.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_template.py new file mode 100644 index 0000000..92bbfcd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MailMergeTemplate(object): + def __init__(self): + """Creates an instance of MailMergeTemplate""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_wrapper.py new file mode 100644 index 0000000..77957b5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/mail_merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MailMergeWrapper(object): + def __init__(self): + """Creates an instance of MailMergeWrapper""" + + self.__send_mail_merge = None + self.__key_modified = dict() + + def get_send_mail_merge(self): + """ + The method to get the send_mail_merge + + Returns: + list: An instance of list + """ + + return self.__send_mail_merge + + def set_send_mail_merge(self, send_mail_merge): + """ + The method to set the value to send_mail_merge + + Parameters: + send_mail_merge (list) : An instance of list + """ + + if send_mail_merge is not None and not isinstance(send_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: send_mail_merge EXPECTED TYPE: list', None, None) + + self.__send_mail_merge = send_mail_merge + self.__key_modified['send_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_handler.py new file mode 100644 index 0000000..7cf25a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class SignActionHandler(ABC): + def __init__(self): + """Creates an instance of SignActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_response.py new file mode 100644 index 0000000..071ebfa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class SignActionResponse(ABC): + def __init__(self): + """Creates an instance of SignActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.py new file mode 100644 index 0000000..23a9220 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_handler import SignActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .sign_action_handler import SignActionHandler + + +class SignActionWrapper(SignActionHandler): + def __init__(self): + """Creates an instance of SignActionWrapper""" + super().__init__() + + self.__sign_mail_merge = None + self.__key_modified = dict() + + def get_sign_mail_merge(self): + """ + The method to get the sign_mail_merge + + Returns: + list: An instance of list + """ + + return self.__sign_mail_merge + + def set_sign_mail_merge(self, sign_mail_merge): + """ + The method to set the value to sign_mail_merge + + Parameters: + sign_mail_merge (list) : An instance of list + """ + + if sign_mail_merge is not None and not isinstance(sign_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_mail_merge EXPECTED TYPE: list', None, None) + + self.__sign_mail_merge = sign_mail_merge + self.__key_modified['sign_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge.py new file mode 100644 index 0000000..80d9c31 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SignMailMerge(object): + def __init__(self): + """Creates an instance of SignMailMerge""" + + self.__mail_merge_template = None + self.__sign_in_order = None + self.__file_name = None + self.__signers = None + self.__key_modified = dict() + + def get_mail_merge_template(self): + """ + The method to get the mail_merge_template + + Returns: + MailMergeTemplate: An instance of MailMergeTemplate + """ + + return self.__mail_merge_template + + def set_mail_merge_template(self, mail_merge_template): + """ + The method to set the value to mail_merge_template + + Parameters: + mail_merge_template (MailMergeTemplate) : An instance of MailMergeTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.mail_merge_template import MailMergeTemplate + except Exception: + from .mail_merge_template import MailMergeTemplate + + if mail_merge_template is not None and not isinstance(mail_merge_template, MailMergeTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_merge_template EXPECTED TYPE: MailMergeTemplate', None, None) + + self.__mail_merge_template = mail_merge_template + self.__key_modified['mail_merge_template'] = 1 + + def get_sign_in_order(self): + """ + The method to get the sign_in_order + + Returns: + bool: A bool representing the sign_in_order + """ + + return self.__sign_in_order + + def set_sign_in_order(self, sign_in_order): + """ + The method to set the value to sign_in_order + + Parameters: + sign_in_order (bool) : A bool representing the sign_in_order + """ + + if sign_in_order is not None and not isinstance(sign_in_order, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_in_order EXPECTED TYPE: bool', None, None) + + self.__sign_in_order = sign_in_order + self.__key_modified['sign_in_order'] = 1 + + def get_file_name(self): + """ + The method to get the file_name + + Returns: + string: A string representing the file_name + """ + + return self.__file_name + + def set_file_name(self, file_name): + """ + The method to set the value to file_name + + Parameters: + file_name (string) : A string representing the file_name + """ + + if file_name is not None and not isinstance(file_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name EXPECTED TYPE: str', None, None) + + self.__file_name = file_name + self.__key_modified['file_name'] = 1 + + def get_signers(self): + """ + The method to get the signers + + Returns: + list: An instance of list + """ + + return self.__signers + + def set_signers(self, signers): + """ + The method to set the value to signers + + Parameters: + signers (list) : An instance of list + """ + + if signers is not None and not isinstance(signers, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signers EXPECTED TYPE: list', None, None) + + self.__signers = signers + self.__key_modified['signers'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge_wrapper.py new file mode 100644 index 0000000..2f21a4d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/sign_mail_merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SignMailMergeWrapper(object): + def __init__(self): + """Creates an instance of SignMailMergeWrapper""" + + self.__sign_mail_merge = None + self.__key_modified = dict() + + def get_sign_mail_merge(self): + """ + The method to get the sign_mail_merge + + Returns: + list: An instance of list + """ + + return self.__sign_mail_merge + + def set_sign_mail_merge(self, sign_mail_merge): + """ + The method to set the value to sign_mail_merge + + Parameters: + sign_mail_merge (list) : An instance of list + """ + + if sign_mail_merge is not None and not isinstance(sign_mail_merge, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_mail_merge EXPECTED TYPE: list', None, None) + + self.__sign_mail_merge = sign_mail_merge + self.__key_modified['sign_mail_merge'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/signers.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/signers.py new file mode 100644 index 0000000..e447421 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/signers.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Signers(object): + def __init__(self): + """Creates an instance of Signers""" + + self.__recipient_name = None + self.__action_type = None + self.__recipient = None + self.__key_modified = dict() + + def get_recipient_name(self): + """ + The method to get the recipient_name + + Returns: + string: A string representing the recipient_name + """ + + return self.__recipient_name + + def set_recipient_name(self, recipient_name): + """ + The method to set the value to recipient_name + + Parameters: + recipient_name (string) : A string representing the recipient_name + """ + + if recipient_name is not None and not isinstance(recipient_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recipient_name EXPECTED TYPE: str', None, None) + + self.__recipient_name = recipient_name + self.__key_modified['recipient_name'] = 1 + + def get_action_type(self): + """ + The method to get the action_type + + Returns: + Choice: An instance of Choice + """ + + return self.__action_type + + def set_action_type(self, action_type): + """ + The method to set the value to action_type + + Parameters: + action_type (Choice) : An instance of Choice + """ + + if action_type is not None and not isinstance(action_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_type EXPECTED TYPE: Choice', None, None) + + self.__action_type = action_type + self.__key_modified['action_type'] = 1 + + def get_recipient(self): + """ + The method to get the recipient + + Returns: + Address: An instance of Address + """ + + return self.__recipient + + def set_recipient(self, recipient): + """ + The method to set the value to recipient + + Parameters: + recipient (Address) : An instance of Address + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.address import Address + except Exception: + from .address import Address + + if recipient is not None and not isinstance(recipient, Address): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recipient EXPECTED TYPE: Address', None, None) + + self.__recipient = recipient + self.__key_modified['recipient'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mail_merge/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/success_response.py new file mode 100644 index 0000000..81c4fb3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mail_merge/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mail_merge.sign_action_response import SignActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .sign_action_response import SignActionResponse + + +class SuccessResponse(SignActionResponse, ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/__init__.py new file mode 100644 index 0000000..314b0de --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/__init__.py @@ -0,0 +1,14 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .mass_change_owner_operations import MassChangeOwnerOperations, CheckStatusParam +from .criteria import Criteria +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .field import Field +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .status import Status +from .territory import Territory diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_wrapper.py new file mode 100644 index 0000000..231ae5a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/api_exception.py new file mode 100644 index 0000000..d25a43d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/body_wrapper.py new file mode 100644 index 0000000..0410e8e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/body_wrapper.py @@ -0,0 +1,164 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__cvid = None + self.__owner = None + self.__criteria = None + self.__territory = None + self.__key_modified = dict() + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + int: An int representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (int) : An int representing the cvid + """ + + if cvid is not None and not isinstance(cvid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: int', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/criteria.py new file mode 100644 index 0000000..ebc1a77 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/field.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/mass_change_owner_operations.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/mass_change_owner_operations.py new file mode 100644 index 0000000..84a85de --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/mass_change_owner_operations.py @@ -0,0 +1,103 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class MassChangeOwnerOperations(object): + def __init__(self, module): + """ + Creates an instance of MassChangeOwnerOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def change_owner(self, request): + """ + The method to change owner + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def check_status(self, param_instance=None): + """ + The method to check status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_change_owner' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class CheckStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassChangeOwner.CheckStatusParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/owner.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/owner.py new file mode 100644 index 0000000..3a97231 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_wrapper.py new file mode 100644 index 0000000..b045dc4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/status.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/status.py new file mode 100644 index 0000000..ecc33dc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/status.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__failed_count = None + self.__not_updated_count = None + self.__updated_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_not_updated_count(self): + """ + The method to get the not_updated_count + + Returns: + int: An int representing the not_updated_count + """ + + return self.__not_updated_count + + 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 + + def get_updated_count(self): + """ + The method to get the updated_count + + Returns: + int: An int representing the updated_count + """ + + return self.__updated_count + + def set_updated_count(self, updated_count): + """ + The method to set the value to updated_count + + Parameters: + updated_count (int) : An int representing the updated_count + """ + + if updated_count is not None and not isinstance(updated_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updated_count EXPECTED TYPE: int', None, None) + + self.__updated_count = updated_count + self.__key_modified['Updated_Count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/success_response.py new file mode 100644 index 0000000..f24aa51 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/territory.py b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/territory.py new file mode 100644 index 0000000..ea24586 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_change_owner/territory.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__id = None + self.__include_child = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_include_child(self): + """ + The method to get the include_child + + Returns: + bool: A bool representing the include_child + """ + + return self.__include_child + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/__init__.py new file mode 100644 index 0000000..b65ae3e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/__init__.py @@ -0,0 +1,13 @@ +from .portal_user_type import PortalUserType +from .mass_convert_operations import MassConvertOperations, GetJobStatusParam +from .assign_to import AssignTo +from .related_module import RelatedModule +from .body_wrapper import BodyWrapper +from .move_attachments_to import MoveAttachmentsTo +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .status import Status diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/api_exception.py new file mode 100644 index 0000000..8a80bad --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + + +class APIException(ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__details = None + self.__code = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/assign_to.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/assign_to.py new file mode 100644 index 0000000..d09ecab --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/assign_to.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignTo(object): + def __init__(self): + """Creates an instance of AssignTo""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/body_wrapper.py new file mode 100644 index 0000000..09fdd4c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/body_wrapper.py @@ -0,0 +1,269 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__deals = None + self.__move_attachments_to = None + self.__assign_to = None + self.__carry_over_tags = None + self.__related_modules = None + self.__portal_user_type = None + self.__ids = None + self.__apply_assignment_threshold = None + self.__key_modified = dict() + + def get_deals(self): + """ + The method to get the deals + + Returns: + Record: An instance of Record + """ + + return self.__deals + + def set_deals(self, deals): + """ + The method to set the value to deals + + Parameters: + deals (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if deals is not None and not isinstance(deals, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deals EXPECTED TYPE: Record', None, None) + + self.__deals = deals + self.__key_modified['Deals'] = 1 + + def get_move_attachments_to(self): + """ + The method to get the move_attachments_to + + Returns: + MoveAttachmentsTo: An instance of MoveAttachmentsTo + """ + + return self.__move_attachments_to + + def set_move_attachments_to(self, move_attachments_to): + """ + The method to set the value to move_attachments_to + + Parameters: + move_attachments_to (MoveAttachmentsTo) : An instance of MoveAttachmentsTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.move_attachments_to import MoveAttachmentsTo + except Exception: + from .move_attachments_to import MoveAttachmentsTo + + if move_attachments_to is not None and not isinstance(move_attachments_to, MoveAttachmentsTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_attachments_to EXPECTED TYPE: MoveAttachmentsTo', None, None) + + self.__move_attachments_to = move_attachments_to + self.__key_modified['move_attachments_to'] = 1 + + def get_assign_to(self): + """ + The method to get the assign_to + + Returns: + AssignTo: An instance of AssignTo + """ + + return self.__assign_to + + def set_assign_to(self, assign_to): + """ + The method to set the value to assign_to + + Parameters: + assign_to (AssignTo) : An instance of AssignTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.assign_to import AssignTo + except Exception: + from .assign_to import AssignTo + + if assign_to is not None and not isinstance(assign_to, AssignTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assign_to EXPECTED TYPE: AssignTo', None, None) + + self.__assign_to = assign_to + self.__key_modified['assign_to'] = 1 + + def get_carry_over_tags(self): + """ + The method to get the carry_over_tags + + Returns: + list: An instance of list + """ + + return self.__carry_over_tags + + def set_carry_over_tags(self, carry_over_tags): + """ + The method to set the value to carry_over_tags + + Parameters: + carry_over_tags (list) : An instance of list + """ + + if carry_over_tags is not None and not isinstance(carry_over_tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: carry_over_tags EXPECTED TYPE: list', None, None) + + self.__carry_over_tags = carry_over_tags + self.__key_modified['carry_over_tags'] = 1 + + def get_related_modules(self): + """ + The method to get the related_modules + + Returns: + list: An instance of list + """ + + return self.__related_modules + + def set_related_modules(self, related_modules): + """ + The method to set the value to related_modules + + Parameters: + related_modules (list) : An instance of list + """ + + if related_modules is not None and not isinstance(related_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_modules EXPECTED TYPE: list', None, None) + + self.__related_modules = related_modules + self.__key_modified['related_modules'] = 1 + + def get_portal_user_type(self): + """ + The method to get the portal_user_type + + Returns: + PortalUserType: An instance of PortalUserType + """ + + return self.__portal_user_type + + def set_portal_user_type(self, portal_user_type): + """ + The method to set the value to portal_user_type + + Parameters: + portal_user_type (PortalUserType) : An instance of PortalUserType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.portal_user_type import PortalUserType + except Exception: + from .portal_user_type import PortalUserType + + if portal_user_type is not None and not isinstance(portal_user_type, PortalUserType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_user_type EXPECTED TYPE: PortalUserType', None, None) + + self.__portal_user_type = portal_user_type + self.__key_modified['portal_user_type'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_apply_assignment_threshold(self): + """ + The method to get the apply_assignment_threshold + + Returns: + bool: A bool representing the apply_assignment_threshold + """ + + return self.__apply_assignment_threshold + + def set_apply_assignment_threshold(self, apply_assignment_threshold): + """ + The method to set the value to apply_assignment_threshold + + Parameters: + apply_assignment_threshold (bool) : A bool representing the apply_assignment_threshold + """ + + if apply_assignment_threshold is not None and not isinstance(apply_assignment_threshold, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: apply_assignment_threshold EXPECTED TYPE: bool', None, None) + + self.__apply_assignment_threshold = apply_assignment_threshold + self.__key_modified['apply_assignment_threshold'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/error_details.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/mass_convert_operations.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/mass_convert_operations.py new file mode 100644 index 0000000..bc8ae57 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/mass_convert_operations.py @@ -0,0 +1,92 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + + +class MassConvertOperations(object): + def __init__(self): + """Creates an instance of MassConvertOperations""" + pass + + def mass_convert(self, request): + """ + The method to mass convert + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Leads/actions/mass_convert' + 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.set_module_api_name("Deals") + Utility.get_fields("Deals", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def get_job_status(self, param_instance=None): + """ + The method to get job status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Leads/actions/mass_convert' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetJobStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassConvert.GetJobStatusParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/move_attachments_to.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/move_attachments_to.py new file mode 100644 index 0000000..8bd9065 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/move_attachments_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MoveAttachmentsTo(object): + def __init__(self): + """Creates an instance of MoveAttachmentsTo""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/portal_user_type.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/portal_user_type.py new file mode 100644 index 0000000..6ffe1b1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/portal_user_type.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PortalUserType(object): + def __init__(self): + """Creates an instance of PortalUserType""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/related_module.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/related_module.py new file mode 100644 index 0000000..d57a90c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/related_module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedModule(object): + def __init__(self): + """Creates an instance of RelatedModule""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_wrapper.py new file mode 100644 index 0000000..f5571d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/status.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/status.py new file mode 100644 index 0000000..74b244a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/status.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__failed_count = None + self.__not_converted_count = None + self.__total_count = None + self.__converted_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_not_converted_count(self): + """ + The method to get the not_converted_count + + Returns: + int: An int representing the not_converted_count + """ + + return self.__not_converted_count + + def set_not_converted_count(self, not_converted_count): + """ + The method to set the value to not_converted_count + + Parameters: + not_converted_count (int) : An int representing the not_converted_count + """ + + if not_converted_count is not None and not isinstance(not_converted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: not_converted_count EXPECTED TYPE: int', None, None) + + self.__not_converted_count = not_converted_count + self.__key_modified['Not_Converted_Count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def get_converted_count(self): + """ + The method to get the converted_count + + Returns: + int: An int representing the converted_count + """ + + return self.__converted_count + + def set_converted_count(self, converted_count): + """ + The method to set the value to converted_count + + Parameters: + converted_count (int) : An int representing the converted_count + """ + + if converted_count is not None and not isinstance(converted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: converted_count EXPECTED TYPE: int', None, None) + + self.__converted_count = converted_count + self.__key_modified['Converted_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_convert/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/success_response.py new file mode 100644 index 0000000..07ff851 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_convert/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_convert.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/__init__.py new file mode 100644 index 0000000..d51e735 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/__init__.py @@ -0,0 +1,12 @@ +from .mass_delete_cvid_operations import MassDeleteCvidOperations, GetMassDeleteStatusParam +from .record_id_body_wrapper import RecordIdBodyWrapper +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .cvid_body_wrapper import CvidBodyWrapper +from .territory import Territory +from .status import Status diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_wrapper.py new file mode 100644 index 0000000..211b3cb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/api_exception.py new file mode 100644 index 0000000..45376e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/cvid_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/cvid_body_wrapper.py new file mode 100644 index 0000000..71c4704 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/cvid_body_wrapper.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CvidBodyWrapper(object): + def __init__(self): + """Creates an instance of CvidBodyWrapper""" + + self.__cvid = None + self.__territory = None + self.__key_modified = dict() + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + int: An int representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (int) : An int representing the cvid + """ + + if cvid is not None and not isinstance(cvid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: int', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/mass_delete_cvid_operations.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/mass_delete_cvid_operations.py new file mode 100644 index 0000000..4888766 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/mass_delete_cvid_operations.py @@ -0,0 +1,141 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class MassDeleteCvidOperations(object): + def __init__(self, module): + """ + Creates an instance of MassDeleteCvidOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def mass_delete_by_cvid(self, request): + """ + The method to mass delete by cvid + + Parameters: + request (CvidBodyWrapper) : An instance of CvidBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.cvid_body_wrapper import CvidBodyWrapper + except Exception: + from .cvid_body_wrapper import CvidBodyWrapper + + if request is not None and not isinstance(request, CvidBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: CvidBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def mass_delete_by_record_id(self, request): + """ + The method to mass delete by record id + + Parameters: + request (RecordIdBodyWrapper) : An instance of RecordIdBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.record_id_body_wrapper import RecordIdBodyWrapper + except Exception: + from .record_id_body_wrapper import RecordIdBodyWrapper + + if request is not None and not isinstance(request, RecordIdBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RecordIdBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_mass_delete_status(self, param_instance=None): + """ + The method to get mass delete status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/mass_delete' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetMassDeleteStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassDeleteCvid.GetMassDeleteStatusParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/record_id_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/record_id_body_wrapper.py new file mode 100644 index 0000000..462c3a4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/record_id_body_wrapper.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RecordIdBodyWrapper(object): + def __init__(self): + """Creates an instance of RecordIdBodyWrapper""" + + self.__ids = None + self.__territory = None + self.__key_modified = dict() + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_wrapper.py new file mode 100644 index 0000000..a746abb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/status.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/status.py new file mode 100644 index 0000000..8cc718d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/status.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__failed_count = None + self.__deleted_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_deleted_count(self): + """ + The method to get the deleted_count + + Returns: + int: An int representing the deleted_count + """ + + return self.__deleted_count + + def set_deleted_count(self, deleted_count): + """ + The method to set the value to deleted_count + + Parameters: + deleted_count (int) : An int representing the deleted_count + """ + + if deleted_count is not None and not isinstance(deleted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_count EXPECTED TYPE: int', None, None) + + self.__deleted_count = deleted_count + self.__key_modified['Deleted_Count'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/success_response.py new file mode 100644 index 0000000..7c44889 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/territory.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/territory.py new file mode 100644 index 0000000..ea24586 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_cvid/territory.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__id = None + self.__include_child = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_include_child(self): + """ + The method to get the include_child + + Returns: + bool: A bool representing the include_child + """ + + return self.__include_child + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/__init__.py new file mode 100644 index 0000000..fd769ab --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/__init__.py @@ -0,0 +1,12 @@ +from .status_action_response import StatusActionResponse +from .status_response_handler import StatusResponseHandler +from .mass_delete_tags_operations import MassDeleteTagsOperations, GetStatusParam +from .api_exception import APIException +from .action_response import ActionResponse +from .status_response_wrapper import StatusResponseWrapper +from .success_response import SuccessResponse +from .module import Module +from .mass_delete import MassDelete +from .body_wrapper import BodyWrapper +from .tag import Tag +from .mass_delete_details import MassDeleteDetails diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/api_exception.py new file mode 100644 index 0000000..39732db --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_action_response import StatusActionResponse + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_response_handler import StatusResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + from .status_response_handler import StatusResponseHandler + from .action_response import ActionResponse + + +class APIException(StatusActionResponse, ActionResponse, StatusResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__details = None + self.__message = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/body_wrapper.py new file mode 100644 index 0000000..44382be --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__mass_delete = None + self.__key_modified = dict() + + def get_mass_delete(self): + """ + The method to get the mass_delete + + Returns: + list: An instance of list + """ + + return self.__mass_delete + + def set_mass_delete(self, mass_delete): + """ + The method to set the value to mass_delete + + Parameters: + mass_delete (list) : An instance of list + """ + + if mass_delete is not None and not isinstance(mass_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_delete EXPECTED TYPE: list', None, None) + + self.__mass_delete = mass_delete + self.__key_modified['mass_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete.py new file mode 100644 index 0000000..a92389c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MassDelete(object): + def __init__(self): + """Creates an instance of MassDelete""" + + self.__module = None + self.__tags = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_details.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_details.py new file mode 100644 index 0000000..94ff497 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_details.py @@ -0,0 +1,177 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_action_response import StatusActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + + +class MassDeleteDetails(StatusActionResponse): + def __init__(self): + """Creates an instance of MassDeleteDetails""" + super().__init__() + + self.__job_id = None + self.__total_count = None + self.__failed_count = None + self.__deleted_count = None + self.__status = None + self.__key_modified = dict() + + def get_job_id(self): + """ + The method to get the job_id + + Returns: + int: An int representing the job_id + """ + + return self.__job_id + + def set_job_id(self, job_id): + """ + The method to set the value to job_id + + Parameters: + job_id (int) : An int representing the job_id + """ + + if job_id is not None and not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + self.__job_id = job_id + self.__key_modified['job_id'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['total_count'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['failed_count'] = 1 + + def get_deleted_count(self): + """ + The method to get the deleted_count + + Returns: + int: An int representing the deleted_count + """ + + return self.__deleted_count + + def set_deleted_count(self, deleted_count): + """ + The method to set the value to deleted_count + + Parameters: + deleted_count (int) : An int representing the deleted_count + """ + + if deleted_count is not None and not isinstance(deleted_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_count EXPECTED TYPE: int', None, None) + + self.__deleted_count = deleted_count + self.__key_modified['deleted_count'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_tags_operations.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_tags_operations.py new file mode 100644 index 0000000..4264aa1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/mass_delete_tags_operations.py @@ -0,0 +1,89 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class MassDeleteTagsOperations(object): + def __init__(self): + """Creates an instance of MassDeleteTagsOperations""" + pass + + def mass_delete_tags(self, request): + """ + The method to mass delete tags + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/tags/actions/mass_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + return handler_instance.api_call(ActionResponse.__module__, 'application/json') + + def get_status(self, param_instance=None): + """ + The method to get status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/tags/actions/mass_delete' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_response_handler import StatusResponseHandler + except Exception: + from .status_response_handler import StatusResponseHandler + return handler_instance.api_call(StatusResponseHandler.__module__, 'application/json') + + +class GetStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.MassDeleteTags.GetStatusParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/module.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/module.py new file mode 100644 index 0000000..93604c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_action_response.py new file mode 100644 index 0000000..ff1c58b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusActionResponse(ABC): + def __init__(self): + """Creates an instance of StatusActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_handler.py new file mode 100644 index 0000000..5291de4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusResponseHandler(ABC): + def __init__(self): + """Creates an instance of StatusResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_wrapper.py new file mode 100644 index 0000000..8e03dfd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/status_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.status_response_handler import StatusResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .status_response_handler import StatusResponseHandler + + +class StatusResponseWrapper(StatusResponseHandler): + def __init__(self): + """Creates an instance of StatusResponseWrapper""" + super().__init__() + + self.__mass_delete = None + self.__key_modified = dict() + + def get_mass_delete(self): + """ + The method to get the mass_delete + + Returns: + list: An instance of list + """ + + return self.__mass_delete + + def set_mass_delete(self, mass_delete): + """ + The method to set the value to mass_delete + + Parameters: + mass_delete (list) : An instance of list + """ + + if mass_delete is not None and not isinstance(mass_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_delete EXPECTED TYPE: list', None, None) + + self.__mass_delete = mass_delete + self.__key_modified['mass_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/success_response.py new file mode 100644 index 0000000..5ca5f05 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/tag.py b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/tag.py new file mode 100644 index 0000000..8a0eba0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/mass_delete_tags/tag.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tag(object): + def __init__(self): + """Creates an instance of Tag""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/modules/__init__.py new file mode 100644 index 0000000..bea9ffe --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/__init__.py @@ -0,0 +1,21 @@ +from .action_wrapper import ActionWrapper +from .related_list_properties import RelatedListProperties +from .argument import Argument +from .module_field_lookup import ModuleFieldLookup +from .static_subform_properties import StaticSubformProperties +from .lookup_field import LookupField +from .body_wrapper import BodyWrapper +from .static_subform_field import StaticSubformField +from .modules import Modules +from .module_fields import ModuleFields +from .minified_module import MinifiedModule +from .modules_operations import ModulesOperations, GetModulesHeader +from .api_exception import APIException +from .action_response import ActionResponse +from .lookup_field_properties import LookupFieldProperties +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .sharing_properties import SharingProperties +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .territory import Territory diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/modules/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/modules/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/modules/action_wrapper.py new file mode 100644 index 0000000..7c62dbd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__modules = None + self.__key_modified = dict() + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/modules/api_exception.py new file mode 100644 index 0000000..fcff132 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/argument.py b/zohocrmsdk/src/com/zoho/crm/api/modules/argument.py new file mode 100644 index 0000000..ed6a83b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/argument.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Argument(object): + def __init__(self): + """Creates an instance of Argument""" + + self.__name = None + self.__value = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/modules/body_wrapper.py new file mode 100644 index 0000000..f756561 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__modules = None + self.__key_modified = dict() + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field.py b/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field.py new file mode 100644 index 0000000..a34e516 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import MinifiedField +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import MinifiedField + + +class LookupField(MinifiedField): + def __init__(self): + """Creates an instance of LookupField""" + super().__init__() + + self.__sequence_number = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field_properties.py b/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field_properties.py new file mode 100644 index 0000000..4497648 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/lookup_field_properties.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LookupFieldProperties(object): + def __init__(self): + """Creates an instance of LookupFieldProperties""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/minified_module.py b/zohocrmsdk/src/com/zoho/crm/api/modules/minified_module.py new file mode 100644 index 0000000..61a8777 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/minified_module.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedModule(object): + def __init__(self): + """Creates an instance of MinifiedModule""" + + self.__api_name = None + self.__id = None + self.__module_name = None + self.__module = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/module_field_lookup.py b/zohocrmsdk/src/com/zoho/crm/api/modules/module_field_lookup.py new file mode 100644 index 0000000..df1ff17 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/module_field_lookup.py @@ -0,0 +1,237 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import Lookup +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import Lookup + + +class ModuleFieldLookup(Lookup): + def __init__(self): + """Creates an instance of ModuleFieldLookup""" + super().__init__() + + self.__query_details = None + self.__module = None + self.__display_label = None + self.__api_name = None + self.__id = None + self.__revalidate_filter_during_edit = None + self.__show_fields = None + self.__key_modified = dict() + + def get_query_details(self): + """ + The method to get the query_details + + Returns: + QueryDetails: An instance of QueryDetails + """ + + return self.__query_details + + def set_query_details(self, query_details): + """ + The method to set the value to query_details + + Parameters: + query_details (QueryDetails) : An instance of QueryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import QueryDetails + except Exception: + from ..fields import QueryDetails + + if query_details is not None and not isinstance(query_details, QueryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_details EXPECTED TYPE: QueryDetails', None, None) + + self.__query_details = query_details + self.__key_modified['query_details'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_revalidate_filter_during_edit(self): + """ + The method to get the revalidate_filter_during_edit + + Returns: + bool: A bool representing the revalidate_filter_during_edit + """ + + return self.__revalidate_filter_during_edit + + def set_revalidate_filter_during_edit(self, revalidate_filter_during_edit): + """ + The method to set the value to revalidate_filter_during_edit + + Parameters: + revalidate_filter_during_edit (bool) : A bool representing the revalidate_filter_during_edit + """ + + if revalidate_filter_during_edit is not None and not isinstance(revalidate_filter_during_edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: revalidate_filter_during_edit EXPECTED TYPE: bool', None, None) + + self.__revalidate_filter_during_edit = revalidate_filter_during_edit + self.__key_modified['revalidate_filter_during_edit'] = 1 + + def get_show_fields(self): + """ + The method to get the show_fields + + Returns: + list: An instance of list + """ + + return self.__show_fields + + def set_show_fields(self, show_fields): + """ + The method to set the value to show_fields + + Parameters: + show_fields (list) : An instance of list + """ + + if show_fields is not None and not isinstance(show_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_fields EXPECTED TYPE: list', None, None) + + self.__show_fields = show_fields + self.__key_modified['show_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/module_fields.py b/zohocrmsdk/src/com/zoho/crm/api/modules/module_fields.py new file mode 100644 index 0000000..e398061 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/module_fields.py @@ -0,0 +1,2138 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..fields import Fields + + +class ModuleFields(Fields): + def __init__(self): + """Creates an instance of ModuleFields""" + super().__init__() + + self.__blueprint_supported = None + self.__json_type = None + self.__length = None + self.__decimal_place = None + self.__multi_module_lookup = None + self.__sharing_properties = None + self.__currency = None + self.__file_upolad_optionlist = None + self.__lookup = None + self.__subform = None + self.__formula = None + self.__multiselectlookup = None + self.__multiuserlookup = None + self.__pick_list_values = None + self.__allowed_modules = None + self.__hipaa_compliance_enabled = None + self.__hipaa_compliance = None + self.__associated_module = None + self.__data_type = None + self.__operation_type = None + self.__system_mandatory = None + self.__webhook = None + self.__sequence_number = None + self.__default_value = None + self.__virtual_field = None + self.__field_read_only = None + self.__customizable_properties = None + self.__read_only = None + self.__custom_field = None + self.__businesscard_supported = None + self.__filterable = None + self.__visible = None + self.__available_in_user_layout = None + self.__display_field = None + self.__pick_list_values_sorted_lexically = None + self.__sortable = None + self.__layout_associations = None + self.__separator = None + self.__searchable = None + self.__enable_colour_code = None + self.__mass_update = None + self.__created_source = None + self.__type = None + self.__display_label = None + self.__column_name = None + self.__api_name = None + self.__display_type = None + self.__ui_type = None + self.__colour_code_enabled_by_system = None + self.__quick_sequence_number = None + self.__email_parser = None + self.__rollup_summary = None + self.__refer_from_field = None + self.__created_time = None + self.__modified_time = None + self.__show_type = None + self.__category = None + self.__id = None + self.__profiles = None + self.__view_type = None + self.__unique = None + self.__sub_module = None + self.__external = None + self.__private = None + self.__convert_mapping = None + self.__autonumber = None + self.__auto_number_65 = None + self.__crypt = None + self.__tooltip = None + self.__history_tracking = None + self.__association_details = None + self.__additional_column = None + self.__field_label = None + self.__global_picklist = None + self.__updateexistingrecords = None + self.__number_separator = None + self.__textarea = None + self.__static_field = None + self.__key_modified = dict() + + def get_blueprint_supported(self): + """ + The method to get the blueprint_supported + + Returns: + bool: A bool representing the blueprint_supported + """ + + return self.__blueprint_supported + + def set_blueprint_supported(self, blueprint_supported): + """ + The method to set the value to blueprint_supported + + Parameters: + blueprint_supported (bool) : A bool representing the blueprint_supported + """ + + if blueprint_supported is not None and not isinstance(blueprint_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: blueprint_supported EXPECTED TYPE: bool', None, None) + + self.__blueprint_supported = blueprint_supported + self.__key_modified['blueprint_supported'] = 1 + + def get_json_type(self): + """ + The method to get the json_type + + Returns: + string: A string representing the json_type + """ + + return self.__json_type + + def set_json_type(self, json_type): + """ + The method to set the value to json_type + + Parameters: + json_type (string) : A string representing the json_type + """ + + if json_type is not None and not isinstance(json_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_type EXPECTED TYPE: str', None, None) + + self.__json_type = json_type + self.__key_modified['json_type'] = 1 + + def get_length(self): + """ + The method to get the length + + Returns: + int: An int representing the length + """ + + return self.__length + + def set_length(self, length): + """ + The method to set the value to length + + Parameters: + length (int) : An int representing the length + """ + + if length is not None and not isinstance(length, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: length EXPECTED TYPE: int', None, None) + + self.__length = length + self.__key_modified['length'] = 1 + + def get_decimal_place(self): + """ + The method to get the decimal_place + + Returns: + int: An int representing the decimal_place + """ + + return self.__decimal_place + + def set_decimal_place(self, decimal_place): + """ + The method to set the value to decimal_place + + Parameters: + decimal_place (int) : An int representing the decimal_place + """ + + if decimal_place is not None and not isinstance(decimal_place, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_place EXPECTED TYPE: int', None, None) + + self.__decimal_place = decimal_place + self.__key_modified['decimal_place'] = 1 + + def get_multi_module_lookup(self): + """ + The method to get the multi_module_lookup + + Returns: + MultiModuleLookup: An instance of MultiModuleLookup + """ + + return self.__multi_module_lookup + + def set_multi_module_lookup(self, multi_module_lookup): + """ + The method to set the value to multi_module_lookup + + Parameters: + multi_module_lookup (MultiModuleLookup) : An instance of MultiModuleLookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MultiModuleLookup + except Exception: + from ..fields import MultiModuleLookup + + if multi_module_lookup is not None and not isinstance(multi_module_lookup, MultiModuleLookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multi_module_lookup EXPECTED TYPE: MultiModuleLookup', None, None) + + self.__multi_module_lookup = multi_module_lookup + self.__key_modified['multi_module_lookup'] = 1 + + def get_sharing_properties(self): + """ + The method to get the sharing_properties + + Returns: + SharingProperties: An instance of SharingProperties + """ + + return self.__sharing_properties + + def set_sharing_properties(self, sharing_properties): + """ + The method to set the value to sharing_properties + + Parameters: + sharing_properties (SharingProperties) : An instance of SharingProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.sharing_properties import SharingProperties + except Exception: + from .sharing_properties import SharingProperties + + if sharing_properties is not None and not isinstance(sharing_properties, SharingProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_properties EXPECTED TYPE: SharingProperties', None, None) + + self.__sharing_properties = sharing_properties + self.__key_modified['sharing_properties'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + Currency: An instance of Currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (Currency) : An instance of Currency + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Currency + except Exception: + from ..fields import Currency + + if currency is not None and not isinstance(currency, Currency): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: Currency', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_file_upolad_optionlist(self): + """ + The method to get the file_upolad_optionlist + + Returns: + list: An instance of list + """ + + return self.__file_upolad_optionlist + + def set_file_upolad_optionlist(self, file_upolad_optionlist): + """ + The method to set the value to file_upolad_optionlist + + Parameters: + file_upolad_optionlist (list) : An instance of list + """ + + if file_upolad_optionlist is not None and not isinstance(file_upolad_optionlist, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_upolad_optionlist EXPECTED TYPE: list', None, None) + + self.__file_upolad_optionlist = file_upolad_optionlist + self.__key_modified['file_upolad_optionlist'] = 1 + + def get_lookup(self): + """ + The method to get the lookup + + Returns: + Lookup: An instance of Lookup + """ + + return self.__lookup + + def set_lookup(self, lookup): + """ + The method to set the value to lookup + + Parameters: + lookup (Lookup) : An instance of Lookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Lookup + except Exception: + from ..fields import Lookup + + if lookup is not None and not isinstance(lookup, Lookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup EXPECTED TYPE: Lookup', None, None) + + self.__lookup = lookup + self.__key_modified['lookup'] = 1 + + def get_subform(self): + """ + The method to get the subform + + Returns: + Subform: An instance of Subform + """ + + return self.__subform + + def set_subform(self, subform): + """ + The method to set the value to subform + + Parameters: + subform (Subform) : An instance of Subform + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Subform + except Exception: + from ..fields import Subform + + if subform is not None and not isinstance(subform, Subform): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subform EXPECTED TYPE: Subform', None, None) + + self.__subform = subform + self.__key_modified['subform'] = 1 + + def get_formula(self): + """ + The method to get the formula + + Returns: + Formula: An instance of Formula + """ + + return self.__formula + + def set_formula(self, formula): + """ + The method to set the value to formula + + Parameters: + formula (Formula) : An instance of Formula + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Formula + except Exception: + from ..fields import Formula + + if formula is not None and not isinstance(formula, Formula): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: formula EXPECTED TYPE: Formula', None, None) + + self.__formula = formula + self.__key_modified['formula'] = 1 + + def get_multiselectlookup(self): + """ + The method to get the multiselectlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiselectlookup + + def set_multiselectlookup(self, multiselectlookup): + """ + The method to set the value to multiselectlookup + + Parameters: + multiselectlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiselectlookup is not None and not isinstance(multiselectlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiselectlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiselectlookup = multiselectlookup + self.__key_modified['multiselectlookup'] = 1 + + def get_multiuserlookup(self): + """ + The method to get the multiuserlookup + + Returns: + Multiselectlookup: An instance of Multiselectlookup + """ + + return self.__multiuserlookup + + def set_multiuserlookup(self, multiuserlookup): + """ + The method to set the value to multiuserlookup + + Parameters: + multiuserlookup (Multiselectlookup) : An instance of Multiselectlookup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Multiselectlookup + except Exception: + from ..fields import Multiselectlookup + + if multiuserlookup is not None and not isinstance(multiuserlookup, Multiselectlookup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: multiuserlookup EXPECTED TYPE: Multiselectlookup', None, None) + + self.__multiuserlookup = multiuserlookup + self.__key_modified['multiuserlookup'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_allowed_modules(self): + """ + The method to get the allowed_modules + + Returns: + list: An instance of list + """ + + return self.__allowed_modules + + def set_allowed_modules(self, allowed_modules): + """ + The method to set the value to allowed_modules + + Parameters: + allowed_modules (list) : An instance of list + """ + + if allowed_modules is not None and not isinstance(allowed_modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_modules EXPECTED TYPE: list', None, None) + + self.__allowed_modules = allowed_modules + self.__key_modified['allowed_modules'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_hipaa_compliance(self): + """ + The method to get the hipaa_compliance + + Returns: + HipaaCompliance: An instance of HipaaCompliance + """ + + return self.__hipaa_compliance + + def set_hipaa_compliance(self, hipaa_compliance): + """ + The method to set the value to hipaa_compliance + + Parameters: + hipaa_compliance (HipaaCompliance) : An instance of HipaaCompliance + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HipaaCompliance + except Exception: + from ..fields import HipaaCompliance + + if hipaa_compliance is not None and not isinstance(hipaa_compliance, HipaaCompliance): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance EXPECTED TYPE: HipaaCompliance', None, None) + + self.__hipaa_compliance = hipaa_compliance + self.__key_modified['hipaa_compliance'] = 1 + + def get_associated_module(self): + """ + The method to get the associated_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__associated_module + + def set_associated_module(self, associated_module): + """ + The method to set the value to associated_module + + Parameters: + associated_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if associated_module is not None and not isinstance(associated_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__associated_module = associated_module + self.__key_modified['associated_module'] = 1 + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_operation_type(self): + """ + The method to get the operation_type + + Returns: + OperationType: An instance of OperationType + """ + + return self.__operation_type + + def set_operation_type(self, operation_type): + """ + The method to set the value to operation_type + + Parameters: + operation_type (OperationType) : An instance of OperationType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import OperationType + except Exception: + from ..fields import OperationType + + if operation_type is not None and not isinstance(operation_type, OperationType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: operation_type EXPECTED TYPE: OperationType', None, None) + + self.__operation_type = operation_type + self.__key_modified['operation_type'] = 1 + + def get_system_mandatory(self): + """ + The method to get the system_mandatory + + Returns: + bool: A bool representing the system_mandatory + """ + + return self.__system_mandatory + + def set_system_mandatory(self, system_mandatory): + """ + The method to set the value to system_mandatory + + Parameters: + system_mandatory (bool) : A bool representing the system_mandatory + """ + + if system_mandatory is not None and not isinstance(system_mandatory, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_mandatory EXPECTED TYPE: bool', None, None) + + self.__system_mandatory = system_mandatory + self.__key_modified['system_mandatory'] = 1 + + def get_webhook(self): + """ + The method to get the webhook + + Returns: + bool: A bool representing the webhook + """ + + return self.__webhook + + def set_webhook(self, webhook): + """ + The method to set the value to webhook + + Parameters: + webhook (bool) : A bool representing the webhook + """ + + if webhook is not None and not isinstance(webhook, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webhook EXPECTED TYPE: bool', None, None) + + self.__webhook = webhook + self.__key_modified['webhook'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_default_value(self): + """ + The method to get the default_value + + Returns: + string: A string representing the default_value + """ + + return self.__default_value + + def set_default_value(self, default_value): + """ + The method to set the value to default_value + + Parameters: + default_value (string) : A string representing the default_value + """ + + if default_value is not None and not isinstance(default_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_value EXPECTED TYPE: str', None, None) + + self.__default_value = default_value + self.__key_modified['default_value'] = 1 + + def get_virtual_field(self): + """ + The method to get the virtual_field + + Returns: + bool: A bool representing the virtual_field + """ + + return self.__virtual_field + + def set_virtual_field(self, virtual_field): + """ + The method to set the value to virtual_field + + Parameters: + virtual_field (bool) : A bool representing the virtual_field + """ + + if virtual_field is not None and not isinstance(virtual_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: virtual_field EXPECTED TYPE: bool', None, None) + + self.__virtual_field = virtual_field + self.__key_modified['virtual_field'] = 1 + + def get_field_read_only(self): + """ + The method to get the field_read_only + + Returns: + bool: A bool representing the field_read_only + """ + + return self.__field_read_only + + def set_field_read_only(self, field_read_only): + """ + The method to set the value to field_read_only + + Parameters: + field_read_only (bool) : A bool representing the field_read_only + """ + + if field_read_only is not None and not isinstance(field_read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_read_only EXPECTED TYPE: bool', None, None) + + self.__field_read_only = field_read_only + self.__key_modified['field_read_only'] = 1 + + def get_customizable_properties(self): + """ + The method to get the customizable_properties + + Returns: + list: An instance of list + """ + + return self.__customizable_properties + + def set_customizable_properties(self, customizable_properties): + """ + The method to set the value to customizable_properties + + Parameters: + customizable_properties (list) : An instance of list + """ + + if customizable_properties is not None and not isinstance(customizable_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable_properties EXPECTED TYPE: list', None, None) + + self.__customizable_properties = customizable_properties + self.__key_modified['customizable_properties'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_custom_field(self): + """ + The method to get the custom_field + + Returns: + bool: A bool representing the custom_field + """ + + return self.__custom_field + + def set_custom_field(self, custom_field): + """ + The method to set the value to custom_field + + Parameters: + custom_field (bool) : A bool representing the custom_field + """ + + if custom_field is not None and not isinstance(custom_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_field EXPECTED TYPE: bool', None, None) + + self.__custom_field = custom_field + self.__key_modified['custom_field'] = 1 + + def get_businesscard_supported(self): + """ + The method to get the businesscard_supported + + Returns: + bool: A bool representing the businesscard_supported + """ + + return self.__businesscard_supported + + def set_businesscard_supported(self, businesscard_supported): + """ + The method to set the value to businesscard_supported + + Parameters: + businesscard_supported (bool) : A bool representing the businesscard_supported + """ + + if businesscard_supported is not None and not isinstance(businesscard_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: businesscard_supported EXPECTED TYPE: bool', None, None) + + self.__businesscard_supported = businesscard_supported + self.__key_modified['businesscard_supported'] = 1 + + def get_filterable(self): + """ + The method to get the filterable + + Returns: + bool: A bool representing the filterable + """ + + return self.__filterable + + def set_filterable(self, filterable): + """ + The method to set the value to filterable + + Parameters: + filterable (bool) : A bool representing the filterable + """ + + if filterable is not None and not isinstance(filterable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filterable EXPECTED TYPE: bool', None, None) + + self.__filterable = filterable + self.__key_modified['filterable'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_available_in_user_layout(self): + """ + The method to get the available_in_user_layout + + Returns: + bool: A bool representing the available_in_user_layout + """ + + return self.__available_in_user_layout + + def set_available_in_user_layout(self, available_in_user_layout): + """ + The method to set the value to available_in_user_layout + + Parameters: + available_in_user_layout (bool) : A bool representing the available_in_user_layout + """ + + if available_in_user_layout is not None and not isinstance(available_in_user_layout, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available_in_user_layout EXPECTED TYPE: bool', None, None) + + self.__available_in_user_layout = available_in_user_layout + self.__key_modified['available_in_user_layout'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + bool: A bool representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (bool) : A bool representing the display_field + """ + + if display_field is not None and not isinstance(display_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: bool', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_pick_list_values_sorted_lexically(self): + """ + The method to get the pick_list_values_sorted_lexically + + Returns: + bool: A bool representing the pick_list_values_sorted_lexically + """ + + return self.__pick_list_values_sorted_lexically + + def set_pick_list_values_sorted_lexically(self, pick_list_values_sorted_lexically): + """ + The method to set the value to pick_list_values_sorted_lexically + + Parameters: + pick_list_values_sorted_lexically (bool) : A bool representing the pick_list_values_sorted_lexically + """ + + if pick_list_values_sorted_lexically is not None and not isinstance(pick_list_values_sorted_lexically, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values_sorted_lexically EXPECTED TYPE: bool', None, None) + + self.__pick_list_values_sorted_lexically = pick_list_values_sorted_lexically + self.__key_modified['pick_list_values_sorted_lexically'] = 1 + + def get_sortable(self): + """ + The method to get the sortable + + Returns: + bool: A bool representing the sortable + """ + + return self.__sortable + + def set_sortable(self, sortable): + """ + The method to set the value to sortable + + Parameters: + sortable (bool) : A bool representing the sortable + """ + + if sortable is not None and not isinstance(sortable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sortable EXPECTED TYPE: bool', None, None) + + self.__sortable = sortable + self.__key_modified['sortable'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def get_separator(self): + """ + The method to get the separator + + Returns: + bool: A bool representing the separator + """ + + return self.__separator + + def set_separator(self, separator): + """ + The method to set the value to separator + + Parameters: + separator (bool) : A bool representing the separator + """ + + if separator is not None and not isinstance(separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: separator EXPECTED TYPE: bool', None, None) + + self.__separator = separator + self.__key_modified['separator'] = 1 + + def get_searchable(self): + """ + The method to get the searchable + + Returns: + bool: A bool representing the searchable + """ + + return self.__searchable + + def set_searchable(self, searchable): + """ + The method to set the value to searchable + + Parameters: + searchable (bool) : A bool representing the searchable + """ + + if searchable is not None and not isinstance(searchable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: searchable EXPECTED TYPE: bool', None, None) + + self.__searchable = searchable + self.__key_modified['searchable'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_mass_update(self): + """ + The method to get the mass_update + + Returns: + bool: A bool representing the mass_update + """ + + return self.__mass_update + + def set_mass_update(self, mass_update): + """ + The method to set the value to mass_update + + Parameters: + mass_update (bool) : A bool representing the mass_update + """ + + if mass_update is not None and not isinstance(mass_update, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mass_update EXPECTED TYPE: bool', None, None) + + self.__mass_update = mass_update + self.__key_modified['mass_update'] = 1 + + def get_created_source(self): + """ + The method to get the created_source + + Returns: + string: A string representing the created_source + """ + + return self.__created_source + + def set_created_source(self, created_source): + """ + The method to set the value to created_source + + Parameters: + created_source (string) : A string representing the created_source + """ + + if created_source is not None and not isinstance(created_source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_source EXPECTED TYPE: str', None, None) + + self.__created_source = created_source + self.__key_modified['created_source'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_name(self): + """ + The method to get the column_name + + Returns: + string: A string representing the column_name + """ + + return self.__column_name + + def set_column_name(self, column_name): + """ + The method to set the value to column_name + + Parameters: + column_name (string) : A string representing the column_name + """ + + if column_name is not None and not isinstance(column_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_name EXPECTED TYPE: str', None, None) + + self.__column_name = column_name + self.__key_modified['column_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_display_type(self): + """ + The method to get the display_type + + Returns: + int: An int representing the display_type + """ + + return self.__display_type + + def set_display_type(self, display_type): + """ + The method to set the value to display_type + + Parameters: + display_type (int) : An int representing the display_type + """ + + if display_type is not None and not isinstance(display_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_type EXPECTED TYPE: int', None, None) + + self.__display_type = display_type + self.__key_modified['display_type'] = 1 + + def get_ui_type(self): + """ + The method to get the ui_type + + Returns: + int: An int representing the ui_type + """ + + return self.__ui_type + + def set_ui_type(self, ui_type): + """ + The method to set the value to ui_type + + Parameters: + ui_type (int) : An int representing the ui_type + """ + + if ui_type is not None and not isinstance(ui_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ui_type EXPECTED TYPE: int', None, None) + + self.__ui_type = ui_type + self.__key_modified['ui_type'] = 1 + + def get_colour_code_enabled_by_system(self): + """ + The method to get the colour_code_enabled_by_system + + Returns: + bool: A bool representing the colour_code_enabled_by_system + """ + + return self.__colour_code_enabled_by_system + + def set_colour_code_enabled_by_system(self, colour_code_enabled_by_system): + """ + The method to set the value to colour_code_enabled_by_system + + Parameters: + colour_code_enabled_by_system (bool) : A bool representing the colour_code_enabled_by_system + """ + + if colour_code_enabled_by_system is not None and not isinstance(colour_code_enabled_by_system, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code_enabled_by_system EXPECTED TYPE: bool', None, None) + + self.__colour_code_enabled_by_system = colour_code_enabled_by_system + self.__key_modified['colour_code_enabled_by_system'] = 1 + + def get_quick_sequence_number(self): + """ + The method to get the quick_sequence_number + + Returns: + string: A string representing the quick_sequence_number + """ + + return self.__quick_sequence_number + + def set_quick_sequence_number(self, quick_sequence_number): + """ + The method to set the value to quick_sequence_number + + Parameters: + quick_sequence_number (string) : A string representing the quick_sequence_number + """ + + if quick_sequence_number is not None and not isinstance(quick_sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_sequence_number EXPECTED TYPE: str', None, None) + + self.__quick_sequence_number = quick_sequence_number + self.__key_modified['quick_sequence_number'] = 1 + + def get_email_parser(self): + """ + The method to get the email_parser + + Returns: + EmailParser: An instance of EmailParser + """ + + return self.__email_parser + + def set_email_parser(self, email_parser): + """ + The method to set the value to email_parser + + Parameters: + email_parser (EmailParser) : An instance of EmailParser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import EmailParser + except Exception: + from ..fields import EmailParser + + if email_parser is not None and not isinstance(email_parser, EmailParser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser EXPECTED TYPE: EmailParser', None, None) + + self.__email_parser = email_parser + self.__key_modified['email_parser'] = 1 + + def get_rollup_summary(self): + """ + The method to get the rollup_summary + + Returns: + RollupSummary: An instance of RollupSummary + """ + + return self.__rollup_summary + + def set_rollup_summary(self, rollup_summary): + """ + The method to set the value to rollup_summary + + Parameters: + rollup_summary (RollupSummary) : An instance of RollupSummary + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import RollupSummary + except Exception: + from ..fields import RollupSummary + + if rollup_summary is not None and not isinstance(rollup_summary, RollupSummary): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rollup_summary EXPECTED TYPE: RollupSummary', None, None) + + self.__rollup_summary = rollup_summary + self.__key_modified['rollup_summary'] = 1 + + def get_refer_from_field(self): + """ + The method to get the refer_from_field + + Returns: + ReferFromField: An instance of ReferFromField + """ + + return self.__refer_from_field + + def set_refer_from_field(self, refer_from_field): + """ + The method to set the value to refer_from_field + + Parameters: + refer_from_field (ReferFromField) : An instance of ReferFromField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ReferFromField + except Exception: + from ..fields import ReferFromField + + if refer_from_field is not None and not isinstance(refer_from_field, ReferFromField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: refer_from_field EXPECTED TYPE: ReferFromField', None, None) + + self.__refer_from_field = refer_from_field + self.__key_modified['refer_from_field'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_show_type(self): + """ + The method to get the show_type + + Returns: + int: An int representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (int) : An int representing the show_type + """ + + if show_type is not None and not isinstance(show_type, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: int', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + int: An int representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (int) : An int representing the category + """ + + if category is not None and not isinstance(category, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: int', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_view_type(self): + """ + The method to get the view_type + + Returns: + ViewType: An instance of ViewType + """ + + return self.__view_type + + def set_view_type(self, view_type): + """ + The method to set the value to view_type + + Parameters: + view_type (ViewType) : An instance of ViewType + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ViewType + except Exception: + from ..fields import ViewType + + if view_type is not None and not isinstance(view_type, ViewType): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view_type EXPECTED TYPE: ViewType', None, None) + + self.__view_type = view_type + self.__key_modified['view_type'] = 1 + + def get_unique(self): + """ + The method to get the unique + + Returns: + Unique: An instance of Unique + """ + + return self.__unique + + def set_unique(self, unique): + """ + The method to set the value to unique + + Parameters: + unique (Unique) : An instance of Unique + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Unique + except Exception: + from ..fields import Unique + + if unique is not None and not isinstance(unique, Unique): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unique EXPECTED TYPE: Unique', None, None) + + self.__unique = unique + self.__key_modified['unique'] = 1 + + def get_sub_module(self): + """ + The method to get the sub_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__sub_module + + def set_sub_module(self, sub_module): + """ + The method to set the value to sub_module + + Parameters: + sub_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if sub_module is not None and not isinstance(sub_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__sub_module = sub_module + self.__key_modified['sub_module'] = 1 + + def get_external(self): + """ + The method to get the external + + Returns: + External: An instance of External + """ + + return self.__external + + def set_external(self, external): + """ + The method to set the value to external + + Parameters: + external (External) : An instance of External + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import External + except Exception: + from ..fields import External + + if external is not None and not isinstance(external, External): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external EXPECTED TYPE: External', None, None) + + self.__external = external + self.__key_modified['external'] = 1 + + def get_private(self): + """ + The method to get the private + + Returns: + Private: An instance of Private + """ + + return self.__private + + def set_private(self, private): + """ + The method to set the value to private + + Parameters: + private (Private) : An instance of Private + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Private + except Exception: + from ..fields import Private + + if private is not None and not isinstance(private, Private): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: private EXPECTED TYPE: Private', None, None) + + self.__private = private + self.__key_modified['private'] = 1 + + def get_convert_mapping(self): + """ + The method to get the convert_mapping + + Returns: + ConvertMapping: An instance of ConvertMapping + """ + + return self.__convert_mapping + + def set_convert_mapping(self, convert_mapping): + """ + The method to set the value to convert_mapping + + Parameters: + convert_mapping (ConvertMapping) : An instance of ConvertMapping + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import ConvertMapping + except Exception: + from ..fields import ConvertMapping + + if convert_mapping is not None and not isinstance(convert_mapping, ConvertMapping): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convert_mapping EXPECTED TYPE: ConvertMapping', None, None) + + self.__convert_mapping = convert_mapping + self.__key_modified['convert_mapping'] = 1 + + def get_autonumber(self): + """ + The method to get the autonumber + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__autonumber + + def set_autonumber(self, autonumber): + """ + The method to set the value to autonumber + + Parameters: + autonumber (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if autonumber is not None and not isinstance(autonumber, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: autonumber EXPECTED TYPE: AutoNumber', None, None) + + self.__autonumber = autonumber + self.__key_modified['autonumber'] = 1 + + def get_auto_number_65(self): + """ + The method to get the auto_number_65 + + Returns: + AutoNumber: An instance of AutoNumber + """ + + return self.__auto_number_65 + + def set_auto_number_65(self, auto_number_65): + """ + The method to set the value to auto_number_65 + + Parameters: + auto_number_65 (AutoNumber) : An instance of AutoNumber + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AutoNumber + except Exception: + from ..fields import AutoNumber + + if auto_number_65 is not None and not isinstance(auto_number_65, AutoNumber): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_number_65 EXPECTED TYPE: AutoNumber', None, None) + + self.__auto_number_65 = auto_number_65 + self.__key_modified['auto_number'] = 1 + + def get_crypt(self): + """ + The method to get the crypt + + Returns: + Crypt: An instance of Crypt + """ + + return self.__crypt + + def set_crypt(self, crypt): + """ + The method to set the value to crypt + + Parameters: + crypt (Crypt) : An instance of Crypt + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Crypt + except Exception: + from ..fields import Crypt + + if crypt is not None and not isinstance(crypt, Crypt): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crypt EXPECTED TYPE: Crypt', None, None) + + self.__crypt = crypt + self.__key_modified['crypt'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + Tooltip: An instance of Tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (Tooltip) : An instance of Tooltip + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Tooltip + except Exception: + from ..fields import Tooltip + + if tooltip is not None and not isinstance(tooltip, Tooltip): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: Tooltip', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_history_tracking(self): + """ + The method to get the history_tracking + + Returns: + HistoryTracking: An instance of HistoryTracking + """ + + return self.__history_tracking + + def set_history_tracking(self, history_tracking): + """ + The method to set the value to history_tracking + + Parameters: + history_tracking (HistoryTracking) : An instance of HistoryTracking + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import HistoryTracking + except Exception: + from ..fields import HistoryTracking + + if history_tracking is not None and not isinstance(history_tracking, HistoryTracking): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: history_tracking EXPECTED TYPE: HistoryTracking', None, None) + + self.__history_tracking = history_tracking + self.__key_modified['history_tracking'] = 1 + + def get_association_details(self): + """ + The method to get the association_details + + Returns: + AssociationDetails: An instance of AssociationDetails + """ + + return self.__association_details + + def set_association_details(self, association_details): + """ + The method to set the value to association_details + + Parameters: + association_details (AssociationDetails) : An instance of AssociationDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import AssociationDetails + except Exception: + from ..fields import AssociationDetails + + if association_details is not None and not isinstance(association_details, AssociationDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: association_details EXPECTED TYPE: AssociationDetails', None, None) + + self.__association_details = association_details + self.__key_modified['association_details'] = 1 + + def get_additional_column(self): + """ + The method to get the additional_column + + Returns: + string: A string representing the additional_column + """ + + return self.__additional_column + + def set_additional_column(self, additional_column): + """ + The method to set the value to additional_column + + Parameters: + additional_column (string) : A string representing the additional_column + """ + + if additional_column is not None and not isinstance(additional_column, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: additional_column EXPECTED TYPE: str', None, None) + + self.__additional_column = additional_column + self.__key_modified['additional_column'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_global_picklist(self): + """ + The method to get the global_picklist + + Returns: + Object: A Object representing the global_picklist + """ + + return self.__global_picklist + + def set_global_picklist(self, global_picklist): + """ + The method to set the value to global_picklist + + Parameters: + global_picklist (Object) : A Object representing the global_picklist + """ + + self.__global_picklist = global_picklist + self.__key_modified['global_picklist'] = 1 + + def get_updateexistingrecords(self): + """ + The method to get the updateexistingrecords + + Returns: + bool: A bool representing the updateexistingrecords + """ + + return self.__updateexistingrecords + + def set_updateexistingrecords(self, updateexistingrecords): + """ + The method to set the value to updateexistingrecords + + Parameters: + updateexistingrecords (bool) : A bool representing the updateexistingrecords + """ + + if updateexistingrecords is not None and not isinstance(updateexistingrecords, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updateexistingrecords EXPECTED TYPE: bool', None, None) + + self.__updateexistingrecords = updateexistingrecords + self.__key_modified['_update_existing_records'] = 1 + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + bool: A bool representing the number_separator + """ + + return self.__number_separator + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (bool) : A bool representing the number_separator + """ + + if number_separator is not None and not isinstance(number_separator, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: bool', None, None) + + self.__number_separator = number_separator + self.__key_modified['number_separator'] = 1 + + def get_textarea(self): + """ + The method to get the textarea + + Returns: + Textarea: An instance of Textarea + """ + + return self.__textarea + + def set_textarea(self, textarea): + """ + The method to set the value to textarea + + Parameters: + textarea (Textarea) : An instance of Textarea + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Textarea + except Exception: + from ..fields import Textarea + + if textarea is not None and not isinstance(textarea, Textarea): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: textarea EXPECTED TYPE: Textarea', None, None) + + self.__textarea = textarea + self.__key_modified['textarea'] = 1 + + def get_static_field(self): + """ + The method to get the static_field + + Returns: + bool: A bool representing the static_field + """ + + return self.__static_field + + def set_static_field(self, static_field): + """ + The method to set the value to static_field + + Parameters: + static_field (bool) : A bool representing the static_field + """ + + if static_field is not None and not isinstance(static_field, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_field EXPECTED TYPE: bool', None, None) + + self.__static_field = static_field + self.__key_modified['static_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/modules.py b/zohocrmsdk/src/com/zoho/crm/api/modules/modules.py new file mode 100644 index 0000000..3b6badc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/modules.py @@ -0,0 +1,1736 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__has_more_profiles = None + self.__sub_menu_available = None + self.__global_search_supported = None + self.__deletable = None + self.__description = None + self.__creatable = None + self.__recycle_bin_on_delete = None + self.__inventory_template_supported = None + self.__modified_time = None + self.__plural_label = None + self.__presence_sub_menu = None + self.__triggers_supported = None + self.__id = None + self.__chart_view = None + self.__isblueprintsupported = None + self.__visibility = None + self.__visible = None + self.__convertable = None + self.__editable = None + self.__emailtemplate_support = None + self.__email_parser_supported = None + self.__filter_supported = None + self.__show_as_tab = None + self.__web_link = None + self.__sequence_number = None + self.__singular_label = None + self.__viewable = None + self.__api_supported = None + self.__api_name = None + self.__quick_create = None + self.__generated_type = None + self.__feeds_required = None + self.__scoring_supported = None + self.__webform_supported = None + self.__territory = None + self.__arguments = None + self.__module_name = None + self.__chart_view_supported = None + self.__profile_count = None + self.__business_card_field_limit = None + self.__track_current_data = None + self.__modified_by = None + self.__profiles = None + self.__parent_module = None + self.__activity_badge = None + self.__field_states = None + self.__business_card_fields = None + self.__per_page = None + self.__properties = None + self.__on_demand_properties = None + self.__search_layout_fields = None + self.__kanban_view_supported = None + self.__lookup_field_properties = None + self.__kanban_view = None + self.__related_lists = None + self.__filter_status = None + self.__related_list_properties = None + self.__display_field = None + self.__layouts = None + self.__fields = None + self.__custom_view = None + self.__zia_view = None + self.__default_mapping_fields = None + self.__status = None + self.__static_subform_properties = None + self.__layout_associations = None + self.__key_modified = dict() + + def get_has_more_profiles(self): + """ + The method to get the has_more_profiles + + Returns: + bool: A bool representing the has_more_profiles + """ + + return self.__has_more_profiles + + def set_has_more_profiles(self, has_more_profiles): + """ + The method to set the value to has_more_profiles + + Parameters: + has_more_profiles (bool) : A bool representing the has_more_profiles + """ + + if has_more_profiles is not None and not isinstance(has_more_profiles, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_more_profiles EXPECTED TYPE: bool', None, None) + + self.__has_more_profiles = has_more_profiles + self.__key_modified['has_more_profiles'] = 1 + + def get_sub_menu_available(self): + """ + The method to get the sub_menu_available + + Returns: + bool: A bool representing the sub_menu_available + """ + + return self.__sub_menu_available + + def set_sub_menu_available(self, sub_menu_available): + """ + The method to set the value to sub_menu_available + + Parameters: + sub_menu_available (bool) : A bool representing the sub_menu_available + """ + + if sub_menu_available is not None and not isinstance(sub_menu_available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_menu_available EXPECTED TYPE: bool', None, None) + + self.__sub_menu_available = sub_menu_available + self.__key_modified['sub_menu_available'] = 1 + + def get_global_search_supported(self): + """ + The method to get the global_search_supported + + Returns: + bool: A bool representing the global_search_supported + """ + + return self.__global_search_supported + + def set_global_search_supported(self, global_search_supported): + """ + The method to set the value to global_search_supported + + Parameters: + global_search_supported (bool) : A bool representing the global_search_supported + """ + + if global_search_supported is not None and not isinstance(global_search_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: global_search_supported EXPECTED TYPE: bool', None, None) + + self.__global_search_supported = global_search_supported + self.__key_modified['global_search_supported'] = 1 + + def get_deletable(self): + """ + The method to get the deletable + + Returns: + bool: A bool representing the deletable + """ + + return self.__deletable + + def set_deletable(self, deletable): + """ + The method to set the value to deletable + + Parameters: + deletable (bool) : A bool representing the deletable + """ + + if deletable is not None and not isinstance(deletable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deletable EXPECTED TYPE: bool', None, None) + + self.__deletable = deletable + self.__key_modified['deletable'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_creatable(self): + """ + The method to get the creatable + + Returns: + bool: A bool representing the creatable + """ + + return self.__creatable + + def set_creatable(self, creatable): + """ + The method to set the value to creatable + + Parameters: + creatable (bool) : A bool representing the creatable + """ + + if creatable is not None and not isinstance(creatable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: creatable EXPECTED TYPE: bool', None, None) + + self.__creatable = creatable + self.__key_modified['creatable'] = 1 + + def get_recycle_bin_on_delete(self): + """ + The method to get the recycle_bin_on_delete + + Returns: + bool: A bool representing the recycle_bin_on_delete + """ + + return self.__recycle_bin_on_delete + + def set_recycle_bin_on_delete(self, recycle_bin_on_delete): + """ + The method to set the value to recycle_bin_on_delete + + Parameters: + recycle_bin_on_delete (bool) : A bool representing the recycle_bin_on_delete + """ + + if recycle_bin_on_delete is not None and not isinstance(recycle_bin_on_delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recycle_bin_on_delete EXPECTED TYPE: bool', None, None) + + self.__recycle_bin_on_delete = recycle_bin_on_delete + self.__key_modified['recycle_bin_on_delete'] = 1 + + def get_inventory_template_supported(self): + """ + The method to get the inventory_template_supported + + Returns: + bool: A bool representing the inventory_template_supported + """ + + return self.__inventory_template_supported + + def set_inventory_template_supported(self, inventory_template_supported): + """ + The method to set the value to inventory_template_supported + + Parameters: + inventory_template_supported (bool) : A bool representing the inventory_template_supported + """ + + if inventory_template_supported is not None and not isinstance(inventory_template_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_template_supported EXPECTED TYPE: bool', None, None) + + self.__inventory_template_supported = inventory_template_supported + self.__key_modified['inventory_template_supported'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_presence_sub_menu(self): + """ + The method to get the presence_sub_menu + + Returns: + bool: A bool representing the presence_sub_menu + """ + + return self.__presence_sub_menu + + def set_presence_sub_menu(self, presence_sub_menu): + """ + The method to set the value to presence_sub_menu + + Parameters: + presence_sub_menu (bool) : A bool representing the presence_sub_menu + """ + + if presence_sub_menu is not None and not isinstance(presence_sub_menu, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: presence_sub_menu EXPECTED TYPE: bool', None, None) + + self.__presence_sub_menu = presence_sub_menu + self.__key_modified['presence_sub_menu'] = 1 + + def get_triggers_supported(self): + """ + The method to get the triggers_supported + + Returns: + bool: A bool representing the triggers_supported + """ + + return self.__triggers_supported + + def set_triggers_supported(self, triggers_supported): + """ + The method to set the value to triggers_supported + + Parameters: + triggers_supported (bool) : A bool representing the triggers_supported + """ + + if triggers_supported is not None and not isinstance(triggers_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: triggers_supported EXPECTED TYPE: bool', None, None) + + self.__triggers_supported = triggers_supported + self.__key_modified['triggers_supported'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_chart_view(self): + """ + The method to get the chart_view + + Returns: + bool: A bool representing the chart_view + """ + + return self.__chart_view + + def set_chart_view(self, chart_view): + """ + The method to set the value to chart_view + + Parameters: + chart_view (bool) : A bool representing the chart_view + """ + + if chart_view is not None and not isinstance(chart_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_view EXPECTED TYPE: bool', None, None) + + self.__chart_view = chart_view + self.__key_modified['chart_view'] = 1 + + def get_isblueprintsupported(self): + """ + The method to get the isblueprintsupported + + Returns: + bool: A bool representing the isblueprintsupported + """ + + return self.__isblueprintsupported + + def set_isblueprintsupported(self, isblueprintsupported): + """ + The method to set the value to isblueprintsupported + + Parameters: + isblueprintsupported (bool) : A bool representing the isblueprintsupported + """ + + if isblueprintsupported is not None and not isinstance(isblueprintsupported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isblueprintsupported EXPECTED TYPE: bool', None, None) + + self.__isblueprintsupported = isblueprintsupported + self.__key_modified['isBlueprintSupported'] = 1 + + def get_visibility(self): + """ + The method to get the visibility + + Returns: + int: An int representing the visibility + """ + + return self.__visibility + + def set_visibility(self, visibility): + """ + The method to set the value to visibility + + Parameters: + visibility (int) : An int representing the visibility + """ + + if visibility is not None and not isinstance(visibility, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visibility EXPECTED TYPE: int', None, None) + + self.__visibility = visibility + self.__key_modified['visibility'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_convertable(self): + """ + The method to get the convertable + + Returns: + bool: A bool representing the convertable + """ + + return self.__convertable + + def set_convertable(self, convertable): + """ + The method to set the value to convertable + + Parameters: + convertable (bool) : A bool representing the convertable + """ + + if convertable is not None and not isinstance(convertable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: convertable EXPECTED TYPE: bool', None, None) + + self.__convertable = convertable + self.__key_modified['convertable'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['editable'] = 1 + + def get_emailtemplate_support(self): + """ + The method to get the emailtemplate_support + + Returns: + bool: A bool representing the emailtemplate_support + """ + + return self.__emailtemplate_support + + def set_emailtemplate_support(self, emailtemplate_support): + """ + The method to set the value to emailtemplate_support + + Parameters: + emailtemplate_support (bool) : A bool representing the emailtemplate_support + """ + + if emailtemplate_support is not None and not isinstance(emailtemplate_support, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: emailtemplate_support EXPECTED TYPE: bool', None, None) + + self.__emailtemplate_support = emailtemplate_support + self.__key_modified['emailTemplate_support'] = 1 + + def get_email_parser_supported(self): + """ + The method to get the email_parser_supported + + Returns: + bool: A bool representing the email_parser_supported + """ + + return self.__email_parser_supported + + def set_email_parser_supported(self, email_parser_supported): + """ + The method to set the value to email_parser_supported + + Parameters: + email_parser_supported (bool) : A bool representing the email_parser_supported + """ + + if email_parser_supported is not None and not isinstance(email_parser_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_parser_supported EXPECTED TYPE: bool', None, None) + + self.__email_parser_supported = email_parser_supported + self.__key_modified['email_parser_supported'] = 1 + + def get_filter_supported(self): + """ + The method to get the filter_supported + + Returns: + bool: A bool representing the filter_supported + """ + + return self.__filter_supported + + def set_filter_supported(self, filter_supported): + """ + The method to set the value to filter_supported + + Parameters: + filter_supported (bool) : A bool representing the filter_supported + """ + + if filter_supported is not None and not isinstance(filter_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filter_supported EXPECTED TYPE: bool', None, None) + + self.__filter_supported = filter_supported + self.__key_modified['filter_supported'] = 1 + + def get_show_as_tab(self): + """ + The method to get the show_as_tab + + Returns: + bool: A bool representing the show_as_tab + """ + + return self.__show_as_tab + + def set_show_as_tab(self, show_as_tab): + """ + The method to set the value to show_as_tab + + Parameters: + show_as_tab (bool) : A bool representing the show_as_tab + """ + + if show_as_tab is not None and not isinstance(show_as_tab, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_as_tab EXPECTED TYPE: bool', None, None) + + self.__show_as_tab = show_as_tab + self.__key_modified['show_as_tab'] = 1 + + def get_web_link(self): + """ + The method to get the web_link + + Returns: + string: A string representing the web_link + """ + + return self.__web_link + + def set_web_link(self, web_link): + """ + The method to set the value to web_link + + Parameters: + web_link (string) : A string representing the web_link + """ + + if web_link is not None and not isinstance(web_link, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: web_link EXPECTED TYPE: str', None, None) + + self.__web_link = web_link + self.__key_modified['web_link'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_singular_label(self): + """ + The method to get the singular_label + + Returns: + string: A string representing the singular_label + """ + + return self.__singular_label + + def set_singular_label(self, singular_label): + """ + The method to set the value to singular_label + + Parameters: + singular_label (string) : A string representing the singular_label + """ + + if singular_label is not None and not isinstance(singular_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: singular_label EXPECTED TYPE: str', None, None) + + self.__singular_label = singular_label + self.__key_modified['singular_label'] = 1 + + def get_viewable(self): + """ + The method to get the viewable + + Returns: + bool: A bool representing the viewable + """ + + return self.__viewable + + def set_viewable(self, viewable): + """ + The method to set the value to viewable + + Parameters: + viewable (bool) : A bool representing the viewable + """ + + if viewable is not None and not isinstance(viewable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: viewable EXPECTED TYPE: bool', None, None) + + self.__viewable = viewable + self.__key_modified['viewable'] = 1 + + def get_api_supported(self): + """ + The method to get the api_supported + + Returns: + bool: A bool representing the api_supported + """ + + return self.__api_supported + + def set_api_supported(self, api_supported): + """ + The method to set the value to api_supported + + Parameters: + api_supported (bool) : A bool representing the api_supported + """ + + if api_supported is not None and not isinstance(api_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_supported EXPECTED TYPE: bool', None, None) + + self.__api_supported = api_supported + self.__key_modified['api_supported'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_quick_create(self): + """ + The method to get the quick_create + + Returns: + bool: A bool representing the quick_create + """ + + return self.__quick_create + + def set_quick_create(self, quick_create): + """ + The method to set the value to quick_create + + Parameters: + quick_create (bool) : A bool representing the quick_create + """ + + if quick_create is not None and not isinstance(quick_create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: quick_create EXPECTED TYPE: bool', None, None) + + self.__quick_create = quick_create + self.__key_modified['quick_create'] = 1 + + def get_generated_type(self): + """ + The method to get the generated_type + + Returns: + Choice: An instance of Choice + """ + + return self.__generated_type + + def set_generated_type(self, generated_type): + """ + The method to set the value to generated_type + + Parameters: + generated_type (Choice) : An instance of Choice + """ + + if generated_type is not None and not isinstance(generated_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: generated_type EXPECTED TYPE: Choice', None, None) + + self.__generated_type = generated_type + self.__key_modified['generated_type'] = 1 + + def get_feeds_required(self): + """ + The method to get the feeds_required + + Returns: + bool: A bool representing the feeds_required + """ + + return self.__feeds_required + + def set_feeds_required(self, feeds_required): + """ + The method to set the value to feeds_required + + Parameters: + feeds_required (bool) : A bool representing the feeds_required + """ + + if feeds_required is not None and not isinstance(feeds_required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feeds_required EXPECTED TYPE: bool', None, None) + + self.__feeds_required = feeds_required + self.__key_modified['feeds_required'] = 1 + + def get_scoring_supported(self): + """ + The method to get the scoring_supported + + Returns: + bool: A bool representing the scoring_supported + """ + + return self.__scoring_supported + + def set_scoring_supported(self, scoring_supported): + """ + The method to set the value to scoring_supported + + Parameters: + scoring_supported (bool) : A bool representing the scoring_supported + """ + + if scoring_supported is not None and not isinstance(scoring_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_supported EXPECTED TYPE: bool', None, None) + + self.__scoring_supported = scoring_supported + self.__key_modified['scoring_supported'] = 1 + + def get_webform_supported(self): + """ + The method to get the webform_supported + + Returns: + bool: A bool representing the webform_supported + """ + + return self.__webform_supported + + def set_webform_supported(self, webform_supported): + """ + The method to set the value to webform_supported + + Parameters: + webform_supported (bool) : A bool representing the webform_supported + """ + + if webform_supported is not None and not isinstance(webform_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webform_supported EXPECTED TYPE: bool', None, None) + + self.__webform_supported = webform_supported + self.__key_modified['webform_supported'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + Territory: An instance of Territory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (Territory) : An instance of Territory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.territory import Territory + except Exception: + from .territory import Territory + + if territory is not None and not isinstance(territory, Territory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: Territory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def get_arguments(self): + """ + The method to get the arguments + + Returns: + list: An instance of list + """ + + return self.__arguments + + def set_arguments(self, arguments): + """ + The method to set the value to arguments + + Parameters: + arguments (list) : An instance of list + """ + + if arguments is not None and not isinstance(arguments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: arguments EXPECTED TYPE: list', None, None) + + self.__arguments = arguments + self.__key_modified['arguments'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def get_chart_view_supported(self): + """ + The method to get the chart_view_supported + + Returns: + bool: A bool representing the chart_view_supported + """ + + return self.__chart_view_supported + + def set_chart_view_supported(self, chart_view_supported): + """ + The method to set the value to chart_view_supported + + Parameters: + chart_view_supported (bool) : A bool representing the chart_view_supported + """ + + if chart_view_supported is not None and not isinstance(chart_view_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_view_supported EXPECTED TYPE: bool', None, None) + + self.__chart_view_supported = chart_view_supported + self.__key_modified['chart_view_supported'] = 1 + + def get_profile_count(self): + """ + The method to get the profile_count + + Returns: + int: An int representing the profile_count + """ + + return self.__profile_count + + def set_profile_count(self, profile_count): + """ + The method to set the value to profile_count + + Parameters: + profile_count (int) : An int representing the profile_count + """ + + if profile_count is not None and not isinstance(profile_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profile_count EXPECTED TYPE: int', None, None) + + self.__profile_count = profile_count + self.__key_modified['profile_count'] = 1 + + def get_business_card_field_limit(self): + """ + The method to get the business_card_field_limit + + Returns: + int: An int representing the business_card_field_limit + """ + + return self.__business_card_field_limit + + def set_business_card_field_limit(self, business_card_field_limit): + """ + The method to set the value to business_card_field_limit + + Parameters: + business_card_field_limit (int) : An int representing the business_card_field_limit + """ + + if business_card_field_limit is not None and not isinstance(business_card_field_limit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_card_field_limit EXPECTED TYPE: int', None, None) + + self.__business_card_field_limit = business_card_field_limit + self.__key_modified['business_card_field_limit'] = 1 + + def get_track_current_data(self): + """ + The method to get the track_current_data + + Returns: + bool: A bool representing the track_current_data + """ + + return self.__track_current_data + + def set_track_current_data(self, track_current_data): + """ + The method to set the value to track_current_data + + Parameters: + track_current_data (bool) : A bool representing the track_current_data + """ + + if track_current_data is not None and not isinstance(track_current_data, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: track_current_data EXPECTED TYPE: bool', None, None) + + self.__track_current_data = track_current_data + self.__key_modified['track_current_data'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_parent_module(self): + """ + The method to get the parent_module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__parent_module + + def set_parent_module(self, parent_module): + """ + The method to set the value to parent_module + + Parameters: + parent_module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except Exception: + from .minified_module import MinifiedModule + + if parent_module is not None and not isinstance(parent_module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_module EXPECTED TYPE: MinifiedModule', None, None) + + self.__parent_module = parent_module + self.__key_modified['parent_module'] = 1 + + def get_activity_badge(self): + """ + The method to get the activity_badge + + Returns: + Choice: An instance of Choice + """ + + return self.__activity_badge + + def set_activity_badge(self, activity_badge): + """ + The method to set the value to activity_badge + + Parameters: + activity_badge (Choice) : An instance of Choice + """ + + if activity_badge is not None and not isinstance(activity_badge, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: activity_badge EXPECTED TYPE: Choice', None, None) + + self.__activity_badge = activity_badge + self.__key_modified['activity_badge'] = 1 + + def get_field_states(self): + """ + The method to get the field_states + + Returns: + list: An instance of list + """ + + return self.__field_states + + def set_field_states(self, field_states): + """ + The method to set the value to field_states + + Parameters: + field_states (list) : An instance of list + """ + + if field_states is not None and not isinstance(field_states, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_states EXPECTED TYPE: list', None, None) + + self.__field_states = field_states + self.__key_modified['$field_states'] = 1 + + def get_business_card_fields(self): + """ + The method to get the business_card_fields + + Returns: + list: An instance of list + """ + + return self.__business_card_fields + + def set_business_card_fields(self, business_card_fields): + """ + The method to set the value to business_card_fields + + Parameters: + business_card_fields (list) : An instance of list + """ + + if business_card_fields is not None and not isinstance(business_card_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_card_fields EXPECTED TYPE: list', None, None) + + self.__business_card_fields = business_card_fields + self.__key_modified['business_card_fields'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_properties(self): + """ + The method to get the properties + + Returns: + list: An instance of list + """ + + return self.__properties + + def set_properties(self, properties): + """ + The method to set the value to properties + + Parameters: + properties (list) : An instance of list + """ + + if properties is not None and not isinstance(properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: properties EXPECTED TYPE: list', None, None) + + self.__properties = properties + self.__key_modified['$properties'] = 1 + + def get_on_demand_properties(self): + """ + The method to get the on_demand_properties + + Returns: + list: An instance of list + """ + + return self.__on_demand_properties + + def set_on_demand_properties(self, on_demand_properties): + """ + The method to set the value to on_demand_properties + + Parameters: + on_demand_properties (list) : An instance of list + """ + + if on_demand_properties is not None and not isinstance(on_demand_properties, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: on_demand_properties EXPECTED TYPE: list', None, None) + + self.__on_demand_properties = on_demand_properties + self.__key_modified['$on_demand_properties'] = 1 + + def get_search_layout_fields(self): + """ + The method to get the search_layout_fields + + Returns: + list: An instance of list + """ + + return self.__search_layout_fields + + def set_search_layout_fields(self, search_layout_fields): + """ + The method to set the value to search_layout_fields + + Parameters: + search_layout_fields (list) : An instance of list + """ + + if search_layout_fields is not None and not isinstance(search_layout_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: search_layout_fields EXPECTED TYPE: list', None, None) + + self.__search_layout_fields = search_layout_fields + self.__key_modified['search_layout_fields'] = 1 + + def get_kanban_view_supported(self): + """ + The method to get the kanban_view_supported + + Returns: + bool: A bool representing the kanban_view_supported + """ + + return self.__kanban_view_supported + + def set_kanban_view_supported(self, kanban_view_supported): + """ + The method to set the value to kanban_view_supported + + Parameters: + kanban_view_supported (bool) : A bool representing the kanban_view_supported + """ + + if kanban_view_supported is not None and not isinstance(kanban_view_supported, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: kanban_view_supported EXPECTED TYPE: bool', None, None) + + self.__kanban_view_supported = kanban_view_supported + self.__key_modified['kanban_view_supported'] = 1 + + def get_lookup_field_properties(self): + """ + The method to get the lookup_field_properties + + Returns: + LookupFieldProperties: An instance of LookupFieldProperties + """ + + return self.__lookup_field_properties + + def set_lookup_field_properties(self, lookup_field_properties): + """ + The method to set the value to lookup_field_properties + + Parameters: + lookup_field_properties (LookupFieldProperties) : An instance of LookupFieldProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.lookup_field_properties import LookupFieldProperties + except Exception: + from .lookup_field_properties import LookupFieldProperties + + if lookup_field_properties is not None and not isinstance(lookup_field_properties, LookupFieldProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lookup_field_properties EXPECTED TYPE: LookupFieldProperties', None, None) + + self.__lookup_field_properties = lookup_field_properties + self.__key_modified['lookup_field_properties'] = 1 + + def get_kanban_view(self): + """ + The method to get the kanban_view + + Returns: + bool: A bool representing the kanban_view + """ + + return self.__kanban_view + + def set_kanban_view(self, kanban_view): + """ + The method to set the value to kanban_view + + Parameters: + kanban_view (bool) : A bool representing the kanban_view + """ + + if kanban_view is not None and not isinstance(kanban_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: kanban_view EXPECTED TYPE: bool', None, None) + + self.__kanban_view = kanban_view + self.__key_modified['kanban_view'] = 1 + + def get_related_lists(self): + """ + The method to get the related_lists + + Returns: + list: An instance of list + """ + + return self.__related_lists + + def set_related_lists(self, related_lists): + """ + The method to set the value to related_lists + + Parameters: + related_lists (list) : An instance of list + """ + + if related_lists is not None and not isinstance(related_lists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_lists EXPECTED TYPE: list', None, None) + + self.__related_lists = related_lists + self.__key_modified['related_lists'] = 1 + + def get_filter_status(self): + """ + The method to get the filter_status + + Returns: + bool: A bool representing the filter_status + """ + + return self.__filter_status + + def set_filter_status(self, filter_status): + """ + The method to set the value to filter_status + + Parameters: + filter_status (bool) : A bool representing the filter_status + """ + + if filter_status is not None and not isinstance(filter_status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filter_status EXPECTED TYPE: bool', None, None) + + self.__filter_status = filter_status + self.__key_modified['filter_status'] = 1 + + def get_related_list_properties(self): + """ + The method to get the related_list_properties + + Returns: + RelatedListProperties: An instance of RelatedListProperties + """ + + return self.__related_list_properties + + def set_related_list_properties(self, related_list_properties): + """ + The method to set the value to related_list_properties + + Parameters: + related_list_properties (RelatedListProperties) : An instance of RelatedListProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.related_list_properties import RelatedListProperties + except Exception: + from .related_list_properties import RelatedListProperties + + if related_list_properties is not None and not isinstance(related_list_properties, RelatedListProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_list_properties EXPECTED TYPE: RelatedListProperties', None, None) + + self.__related_list_properties = related_list_properties + self.__key_modified['related_list_properties'] = 1 + + def get_display_field(self): + """ + The method to get the display_field + + Returns: + string: A string representing the display_field + """ + + return self.__display_field + + def set_display_field(self, display_field): + """ + The method to set the value to display_field + + Parameters: + display_field (string) : A string representing the display_field + """ + + if display_field is not None and not isinstance(display_field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_field EXPECTED TYPE: str', None, None) + + self.__display_field = display_field + self.__key_modified['display_field'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_custom_view(self): + """ + The method to get the custom_view + + Returns: + CustomViews: An instance of CustomViews + """ + + return self.__custom_view + + def set_custom_view(self, custom_view): + """ + The method to set the value to custom_view + + Parameters: + custom_view (CustomViews) : An instance of CustomViews + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.custom_views import CustomViews + except Exception: + from ..custom_views import CustomViews + + if custom_view is not None and not isinstance(custom_view, CustomViews): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_view EXPECTED TYPE: CustomViews', None, None) + + self.__custom_view = custom_view + self.__key_modified['custom_view'] = 1 + + def get_zia_view(self): + """ + The method to get the zia_view + + Returns: + bool: A bool representing the zia_view + """ + + return self.__zia_view + + def set_zia_view(self, zia_view): + """ + The method to set the value to zia_view + + Parameters: + zia_view (bool) : A bool representing the zia_view + """ + + if zia_view is not None and not isinstance(zia_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_view EXPECTED TYPE: bool', None, None) + + self.__zia_view = zia_view + self.__key_modified['zia_view'] = 1 + + def get_default_mapping_fields(self): + """ + The method to get the default_mapping_fields + + Returns: + list: An instance of list + """ + + return self.__default_mapping_fields + + def set_default_mapping_fields(self, default_mapping_fields): + """ + The method to set the value to default_mapping_fields + + Parameters: + default_mapping_fields (list) : An instance of list + """ + + if default_mapping_fields is not None and not isinstance(default_mapping_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default_mapping_fields EXPECTED TYPE: list', None, None) + + self.__default_mapping_fields = default_mapping_fields + self.__key_modified['default_mapping_fields'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_static_subform_properties(self): + """ + The method to get the static_subform_properties + + Returns: + StaticSubformProperties: An instance of StaticSubformProperties + """ + + return self.__static_subform_properties + + def set_static_subform_properties(self, static_subform_properties): + """ + The method to set the value to static_subform_properties + + Parameters: + static_subform_properties (StaticSubformProperties) : An instance of StaticSubformProperties + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.static_subform_properties import StaticSubformProperties + except Exception: + from .static_subform_properties import StaticSubformProperties + + if static_subform_properties is not None and not isinstance(static_subform_properties, StaticSubformProperties): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: static_subform_properties EXPECTED TYPE: StaticSubformProperties', None, None) + + self.__static_subform_properties = static_subform_properties + self.__key_modified['static_subform_properties'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/modules_operations.py b/zohocrmsdk/src/com/zoho/crm/api/modules/modules_operations.py new file mode 100644 index 0000000..f64d3b7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/modules_operations.py @@ -0,0 +1,196 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class ModulesOperations(object): + def __init__(self): + """Creates an instance of ModulesOperations""" + pass + + def get_modules(self, header_instance=None): + """ + The method to get modules + + Parameters: + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/modules' + 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.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_module_by_api_name(self, api_name): + """ + The method to get module by api name + + Parameters: + api_name (string) : A string representing the api_name + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/modules/' + api_path = api_path + str(api_name) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_module_by_api_name(self, api_name, request): + """ + The method to update module by api name + + Parameters: + api_name (string) : A string representing the api_name + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', 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/v7/settings/modules/' + api_path = api_path + str(api_name) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_module(self, id): + """ + The method to get module + + 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/v7/settings/modules/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_module(self, id, request): + """ + The method to update module + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/modules/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetModulesHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Modules.GetModulesHeader') diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/related_list_properties.py b/zohocrmsdk/src/com/zoho/crm/api/modules/related_list_properties.py new file mode 100644 index 0000000..3a8d66f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/related_list_properties.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedListProperties(object): + def __init__(self): + """Creates an instance of RelatedListProperties""" + + self.__sort_by = None + self.__fields = None + self.__sort_order = None + self.__key_modified = dict() + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + MinifiedField: An instance of MinifiedField + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (MinifiedField) : An instance of MinifiedField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import MinifiedField + except Exception: + from ..fields import MinifiedField + + if sort_by is not None and not isinstance(sort_by, MinifiedField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: MinifiedField', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/modules/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/modules/response_wrapper.py new file mode 100644 index 0000000..e4f6217 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__modules = None + self.__key_modified = dict() + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/sharing_properties.py b/zohocrmsdk/src/com/zoho/crm/api/modules/sharing_properties.py new file mode 100644 index 0000000..aeb4540 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/sharing_properties.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SharingProperties(object): + def __init__(self): + """Creates an instance of SharingProperties""" + + self.__scheduler_status = None + self.__share_preference_enabled = None + self.__share_permission = None + self.__key_modified = dict() + + def get_scheduler_status(self): + """ + The method to get the scheduler_status + + Returns: + string: A string representing the scheduler_status + """ + + return self.__scheduler_status + + def set_scheduler_status(self, scheduler_status): + """ + The method to set the value to scheduler_status + + Parameters: + scheduler_status (string) : A string representing the scheduler_status + """ + + if scheduler_status is not None and not isinstance(scheduler_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduler_status EXPECTED TYPE: str', None, None) + + self.__scheduler_status = scheduler_status + self.__key_modified['scheduler_status'] = 1 + + def get_share_preference_enabled(self): + """ + The method to get the share_preference_enabled + + Returns: + bool: A bool representing the share_preference_enabled + """ + + return self.__share_preference_enabled + + def set_share_preference_enabled(self, share_preference_enabled): + """ + The method to set the value to share_preference_enabled + + Parameters: + share_preference_enabled (bool) : A bool representing the share_preference_enabled + """ + + if share_preference_enabled is not None and not isinstance(share_preference_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_preference_enabled EXPECTED TYPE: bool', None, None) + + self.__share_preference_enabled = share_preference_enabled + self.__key_modified['share_preference_enabled'] = 1 + + def get_share_permission(self): + """ + The method to get the share_permission + + Returns: + Choice: An instance of Choice + """ + + return self.__share_permission + + def set_share_permission(self, share_permission): + """ + The method to set the value to share_permission + + Parameters: + share_permission (Choice) : An instance of Choice + """ + + if share_permission is not None and not isinstance(share_permission, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_permission EXPECTED TYPE: Choice', None, None) + + self.__share_permission = share_permission + self.__key_modified['share_permission'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_field.py b/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_field.py new file mode 100644 index 0000000..0872276 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class StaticSubformField(object): + def __init__(self): + """Creates an instance of StaticSubformField""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_properties.py b/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_properties.py new file mode 100644 index 0000000..8914085 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/static_subform_properties.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class StaticSubformProperties(object): + def __init__(self): + """Creates an instance of StaticSubformProperties""" + + self.__fields = None + self.__key_modified = dict() + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/modules/success_response.py new file mode 100644 index 0000000..18ceaa6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.modules.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/modules/territory.py b/zohocrmsdk/src/com/zoho/crm/api/modules/territory.py new file mode 100644 index 0000000..3c74f4f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/modules/territory.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__name = None + self.__id = None + self.__subordinates = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/notes/__init__.py new file mode 100644 index 0000000..5dcffb8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/__init__.py @@ -0,0 +1,12 @@ +from .action_wrapper import ActionWrapper +from .note import Note +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .notes_operations import NotesOperations, GetNotesParam, GetNotesHeader, DeleteNotesParam, GetNoteParam, GetNoteHeader +from .success_response import SuccessResponse +from .parent_id import ParentId +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/notes/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/notes/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/notes/action_wrapper.py new file mode 100644 index 0000000..3079ec3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/notes/api_exception.py new file mode 100644 index 0000000..f9735b2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/notes/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/info.py b/zohocrmsdk/src/com/zoho/crm/api/notes/info.py new file mode 100644 index 0000000..0f34975 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/info.py @@ -0,0 +1,276 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__sort_by = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__sort_order = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/note.py b/zohocrmsdk/src/com/zoho/crm/api/notes/note.py new file mode 100644 index 0000000..bfbd7d4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/note.py @@ -0,0 +1,473 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Note(object): + def __init__(self): + """Creates an instance of Note""" + + self.__modified_time = None + self.__attachments = None + self.__owner = None + self.__created_time = None + self.__parent_id = None + self.__editable = None + self.__is_shared_to_client = None + self.__sharing_permission = None + self.__modified_by = None + self.__size = None + self.__state = None + self.__voice_note = None + self.__id = None + self.__created_by = None + self.__note_title = None + self.__note_content = None + self.__key_modified = dict() + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['$attachments'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['Owner'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['Created_Time'] = 1 + + def get_parent_id(self): + """ + The method to get the parent_id + + Returns: + ParentId: An instance of ParentId + """ + + return self.__parent_id + + def set_parent_id(self, parent_id): + """ + The method to set the value to parent_id + + Parameters: + parent_id (ParentId) : An instance of ParentId + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.parent_id import ParentId + except Exception: + from .parent_id import ParentId + + if parent_id is not None and not isinstance(parent_id, ParentId): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_id EXPECTED TYPE: ParentId', None, None) + + self.__parent_id = parent_id + self.__key_modified['Parent_Id'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['$editable'] = 1 + + def get_is_shared_to_client(self): + """ + The method to get the is_shared_to_client + + Returns: + bool: A bool representing the is_shared_to_client + """ + + return self.__is_shared_to_client + + def set_is_shared_to_client(self, is_shared_to_client): + """ + The method to set the value to is_shared_to_client + + Parameters: + is_shared_to_client (bool) : A bool representing the is_shared_to_client + """ + + if is_shared_to_client is not None and not isinstance(is_shared_to_client, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_shared_to_client EXPECTED TYPE: bool', None, None) + + self.__is_shared_to_client = is_shared_to_client + self.__key_modified['$is_shared_to_client'] = 1 + + def get_sharing_permission(self): + """ + The method to get the sharing_permission + + Returns: + string: A string representing the sharing_permission + """ + + return self.__sharing_permission + + def set_sharing_permission(self, sharing_permission): + """ + The method to set the value to sharing_permission + + Parameters: + sharing_permission (string) : A string representing the sharing_permission + """ + + if sharing_permission is not None and not isinstance(sharing_permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: str', None, None) + + self.__sharing_permission = sharing_permission + self.__key_modified['$sharing_permission'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['Modified_By'] = 1 + + def get_size(self): + """ + The method to get the size + + Returns: + string: A string representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (string) : A string representing the size + """ + + if size is not None and not isinstance(size, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: str', None, None) + + self.__size = size + self.__key_modified['$size'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['$state'] = 1 + + def get_voice_note(self): + """ + The method to get the voice_note + + Returns: + bool: A bool representing the voice_note + """ + + return self.__voice_note + + def set_voice_note(self, voice_note): + """ + The method to set the value to voice_note + + Parameters: + voice_note (bool) : A bool representing the voice_note + """ + + if voice_note is not None and not isinstance(voice_note, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: voice_note EXPECTED TYPE: bool', None, None) + + self.__voice_note = voice_note + self.__key_modified['$voice_note'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['Created_By'] = 1 + + def get_note_title(self): + """ + The method to get the note_title + + Returns: + string: A string representing the note_title + """ + + return self.__note_title + + def set_note_title(self, note_title): + """ + The method to set the value to note_title + + Parameters: + note_title (string) : A string representing the note_title + """ + + if note_title is not None and not isinstance(note_title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: note_title EXPECTED TYPE: str', None, None) + + self.__note_title = note_title + self.__key_modified['Note_Title'] = 1 + + def get_note_content(self): + """ + The method to get the note_content + + Returns: + string: A string representing the note_content + """ + + return self.__note_content + + def set_note_content(self, note_content): + """ + The method to set the value to note_content + + Parameters: + note_content (string) : A string representing the note_content + """ + + if note_content is not None and not isinstance(note_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: note_content EXPECTED TYPE: str', None, None) + + self.__note_content = note_content + self.__key_modified['Note_Content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/notes_operations.py b/zohocrmsdk/src/com/zoho/crm/api/notes/notes_operations.py new file mode 100644 index 0000000..7024659 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/notes_operations.py @@ -0,0 +1,316 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class NotesOperations(object): + def __init__(self): + """Creates an instance of NotesOperations""" + pass + + def get_notes(self, param_instance=None, header_instance=None): + """ + The method to get notes + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Notes' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_notes(self, request): + """ + The method to create notes + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Notes' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_notes(self, request): + """ + The method to update notes + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Notes' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_notes(self, param_instance=None): + """ + The method to delete notes + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Notes' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_note(self, id, param_instance=None, header_instance=None): + """ + The method to get note + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/Notes/' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_note(self, id, request): + """ + The method to update note + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/Notes/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_note(self, id): + """ + The method to delete note + + 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/v7/Notes/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetNotesParam(object): + page = Param('page', 'com.zoho.crm.api.Notes.GetNotesParam') + per_page = Param('per_page', 'com.zoho.crm.api.Notes.GetNotesParam') + fields = Param('fields', 'com.zoho.crm.api.Notes.GetNotesParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.Notes.GetNotesParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.Notes.GetNotesParam') + ids = Param('ids', 'com.zoho.crm.api.Notes.GetNotesParam') + + +class GetNotesHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Notes.GetNotesHeader') + + +class DeleteNotesParam(object): + ids = Param('ids', 'com.zoho.crm.api.Notes.DeleteNotesParam') + + +class GetNoteParam(object): + fields = Param('fields', 'com.zoho.crm.api.Notes.GetNoteParam') + + +class GetNoteHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Notes.GetNoteHeader') diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/parent_id.py b/zohocrmsdk/src/com/zoho/crm/api/notes/parent_id.py new file mode 100644 index 0000000..e546117 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/parent_id.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ParentId(object): + def __init__(self): + """Creates an instance of ParentId""" + + self.__module = None + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/notes/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/notes/response_wrapper.py new file mode 100644 index 0000000..b3a5be8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notes.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notes/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/notes/success_response.py new file mode 100644 index 0000000..e96d791 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notes/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notes.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/__init__.py new file mode 100644 index 0000000..b299543 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .notifications_operations import NotificationsOperations, GetNotificationsParam, DeleteNotificationParam +from .criteria import Criteria +from .module import Module +from .body_wrapper import BodyWrapper +from .notification_condition import NotificationCondition +from .notification import Notification +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .field import Field +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .event import Event +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/action_wrapper.py new file mode 100644 index 0000000..a1d86e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__watch = None + self.__key_modified = dict() + + def get_watch(self): + """ + The method to get the watch + + Returns: + list: An instance of list + """ + + return self.__watch + + def set_watch(self, watch): + """ + The method to set the value to watch + + Parameters: + watch (list) : An instance of list + """ + + if watch is not None and not isinstance(watch, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: list', None, None) + + self.__watch = watch + self.__key_modified['watch'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/api_exception.py new file mode 100644 index 0000000..4d11572 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.notifications.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/body_wrapper.py new file mode 100644 index 0000000..7979836 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__watch = None + self.__key_modified = dict() + + def get_watch(self): + """ + The method to get the watch + + Returns: + list: An instance of list + """ + + return self.__watch + + def set_watch(self, watch): + """ + The method to set the value to watch + + Parameters: + watch (list) : An instance of list + """ + + if watch is not None and not isinstance(watch, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: list', None, None) + + self.__watch = watch + self.__key_modified['watch'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/criteria.py new file mode 100644 index 0000000..f1c146d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/event.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/event.py new file mode 100644 index 0000000..6e90a88 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/event.py @@ -0,0 +1,201 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Event(object): + def __init__(self): + """Creates an instance of Event""" + + self.__resource_name = None + self.__channel_expiry = None + self.__resource_id = None + self.__resource_uri = None + self.__channel_id = None + self.__notification_condition = None + self.__key_modified = dict() + + def get_resource_name(self): + """ + The method to get the resource_name + + Returns: + string: A string representing the resource_name + """ + + return self.__resource_name + + def set_resource_name(self, resource_name): + """ + The method to set the value to resource_name + + Parameters: + resource_name (string) : A string representing the resource_name + """ + + if resource_name is not None and not isinstance(resource_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_name EXPECTED TYPE: str', None, None) + + self.__resource_name = resource_name + self.__key_modified['resource_name'] = 1 + + def get_channel_expiry(self): + """ + The method to get the channel_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__channel_expiry + + 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 get_resource_id(self): + """ + The method to get the resource_id + + Returns: + int: An int representing the resource_id + """ + + return self.__resource_id + + def set_resource_id(self, resource_id): + """ + The method to set the value to resource_id + + Parameters: + resource_id (int) : An int representing the resource_id + """ + + if resource_id is not None and not isinstance(resource_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_id EXPECTED TYPE: int', None, None) + + self.__resource_id = resource_id + self.__key_modified['resource_id'] = 1 + + def get_resource_uri(self): + """ + The method to get the resource_uri + + Returns: + string: A string representing the resource_uri + """ + + return self.__resource_uri + + def set_resource_uri(self, resource_uri): + """ + The method to set the value to resource_uri + + Parameters: + resource_uri (string) : A string representing the resource_uri + """ + + if resource_uri is not None and not isinstance(resource_uri, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_uri EXPECTED TYPE: str', None, None) + + self.__resource_uri = resource_uri + self.__key_modified['resource_uri'] = 1 + + def get_channel_id(self): + """ + The method to get the channel_id + + Returns: + string: A string representing the channel_id + """ + + return self.__channel_id + + def set_channel_id(self, channel_id): + """ + The method to set the value to channel_id + + Parameters: + channel_id (string) : A string representing the channel_id + """ + + if channel_id is not None and not isinstance(channel_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: channel_id EXPECTED TYPE: str', None, None) + + self.__channel_id = channel_id + self.__key_modified['channel_id'] = 1 + + def get_notification_condition(self): + """ + The method to get the notification_condition + + Returns: + list: An instance of list + """ + + return self.__notification_condition + + def set_notification_condition(self, notification_condition): + """ + The method to set the value to notification_condition + + Parameters: + notification_condition (list) : An instance of list + """ + + if notification_condition is not None and not isinstance(notification_condition, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notification_condition EXPECTED TYPE: list', None, None) + + self.__notification_condition = notification_condition + self.__key_modified['notification_condition'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/field.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/info.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/info.py new file mode 100644 index 0000000..3c2ee76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/module.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/notification.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/notification.py new file mode 100644 index 0000000..4985b67 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/notification.py @@ -0,0 +1,379 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.event import Event +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .event import Event + + +class Notification(Event): + def __init__(self): + """Creates an instance of Notification""" + super().__init__() + + self.__channel_id = None + self.__notify_url = None + self.__events = None + self.__token = None + self.__fields = None + self.__notify_on_related_action = None + self.__return_affected_field_values = None + self.__deleteevents = None + self.__resource_name = None + self.__channel_expiry = None + self.__resource_id = None + self.__resource_uri = None + self.__notification_condition = None + self.__key_modified = dict() + + def get_channel_id(self): + """ + The method to get the channel_id + + Returns: + string: A string representing the channel_id + """ + + return self.__channel_id + + def set_channel_id(self, channel_id): + """ + The method to set the value to channel_id + + Parameters: + channel_id (string) : A string representing the channel_id + """ + + if channel_id is not None and not isinstance(channel_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: channel_id EXPECTED TYPE: str', None, None) + + self.__channel_id = channel_id + self.__key_modified['channel_id'] = 1 + + def get_notify_url(self): + """ + The method to get the notify_url + + Returns: + string: A string representing the notify_url + """ + + return self.__notify_url + + def set_notify_url(self, notify_url): + """ + The method to set the value to notify_url + + Parameters: + notify_url (string) : A string representing the notify_url + """ + + if notify_url is not None and not isinstance(notify_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_url EXPECTED TYPE: str', None, None) + + self.__notify_url = notify_url + self.__key_modified['notify_url'] = 1 + + def get_events(self): + """ + The method to get the events + + Returns: + list: An instance of list + """ + + return self.__events + + def set_events(self, events): + """ + The method to set the value to events + + Parameters: + events (list) : An instance of list + """ + + if events is not None and not isinstance(events, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: events EXPECTED TYPE: list', None, None) + + self.__events = events + self.__key_modified['events'] = 1 + + def get_token(self): + """ + The method to get the token + + Returns: + string: A string representing the token + """ + + return self.__token + + def set_token(self, token): + """ + The method to set the value to token + + Parameters: + token (string) : A string representing the token + """ + + if token is not None and not isinstance(token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: token EXPECTED TYPE: str', None, None) + + self.__token = token + self.__key_modified['token'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + dict: An instance of dict + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (dict) : An instance of dict + """ + + if fields is not None and not isinstance(fields, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: dict', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_notify_on_related_action(self): + """ + The method to get the notify_on_related_action + + Returns: + bool: A bool representing the notify_on_related_action + """ + + return self.__notify_on_related_action + + def set_notify_on_related_action(self, notify_on_related_action): + """ + The method to set the value to notify_on_related_action + + Parameters: + notify_on_related_action (bool) : A bool representing the notify_on_related_action + """ + + if notify_on_related_action is not None and not isinstance(notify_on_related_action, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_on_related_action EXPECTED TYPE: bool', None, None) + + self.__notify_on_related_action = notify_on_related_action + self.__key_modified['notify_on_related_action'] = 1 + + def get_return_affected_field_values(self): + """ + The method to get the return_affected_field_values + + Returns: + bool: A bool representing the return_affected_field_values + """ + + return self.__return_affected_field_values + + def set_return_affected_field_values(self, return_affected_field_values): + """ + The method to set the value to return_affected_field_values + + Parameters: + return_affected_field_values (bool) : A bool representing the return_affected_field_values + """ + + if return_affected_field_values is not None and not isinstance(return_affected_field_values, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: return_affected_field_values EXPECTED TYPE: bool', None, None) + + self.__return_affected_field_values = return_affected_field_values + self.__key_modified['return_affected_field_values'] = 1 + + def get_deleteevents(self): + """ + The method to get the deleteevents + + Returns: + Choice: An instance of Choice + """ + + return self.__deleteevents + + def set_deleteevents(self, deleteevents): + """ + The method to set the value to deleteevents + + Parameters: + deleteevents (Choice) : An instance of Choice + """ + + if deleteevents is not None and not isinstance(deleteevents, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleteevents EXPECTED TYPE: Choice', None, None) + + self.__deleteevents = deleteevents + self.__key_modified['_delete_events'] = 1 + + def get_resource_name(self): + """ + The method to get the resource_name + + Returns: + string: A string representing the resource_name + """ + + return self.__resource_name + + def set_resource_name(self, resource_name): + """ + The method to set the value to resource_name + + Parameters: + resource_name (string) : A string representing the resource_name + """ + + if resource_name is not None and not isinstance(resource_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_name EXPECTED TYPE: str', None, None) + + self.__resource_name = resource_name + self.__key_modified['resource_name'] = 1 + + def get_channel_expiry(self): + """ + The method to get the channel_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__channel_expiry + + 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 get_resource_id(self): + """ + The method to get the resource_id + + Returns: + int: An int representing the resource_id + """ + + return self.__resource_id + + def set_resource_id(self, resource_id): + """ + The method to set the value to resource_id + + Parameters: + resource_id (int) : An int representing the resource_id + """ + + if resource_id is not None and not isinstance(resource_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_id EXPECTED TYPE: int', None, None) + + self.__resource_id = resource_id + self.__key_modified['resource_id'] = 1 + + def get_resource_uri(self): + """ + The method to get the resource_uri + + Returns: + string: A string representing the resource_uri + """ + + return self.__resource_uri + + def set_resource_uri(self, resource_uri): + """ + The method to set the value to resource_uri + + Parameters: + resource_uri (string) : A string representing the resource_uri + """ + + if resource_uri is not None and not isinstance(resource_uri, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource_uri EXPECTED TYPE: str', None, None) + + self.__resource_uri = resource_uri + self.__key_modified['resource_uri'] = 1 + + def get_notification_condition(self): + """ + The method to get the notification_condition + + Returns: + list: An instance of list + """ + + return self.__notification_condition + + def set_notification_condition(self, notification_condition): + """ + The method to set the value to notification_condition + + Parameters: + notification_condition (list) : An instance of list + """ + + if notification_condition is not None and not isinstance(notification_condition, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notification_condition EXPECTED TYPE: list', None, None) + + self.__notification_condition = notification_condition + self.__key_modified['notification_condition'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/notification_condition.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/notification_condition.py new file mode 100644 index 0000000..cadb891 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/notification_condition.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NotificationCondition(object): + def __init__(self): + """Creates an instance of NotificationCondition""" + + self.__type = None + self.__module = None + self.__field_selection = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_field_selection(self): + """ + The method to get the field_selection + + Returns: + Criteria: An instance of Criteria + """ + + return self.__field_selection + + def set_field_selection(self, field_selection): + """ + The method to set the value to field_selection + + Parameters: + field_selection (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.criteria import Criteria + except Exception: + from .criteria import Criteria + + if field_selection is not None and not isinstance(field_selection, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_selection EXPECTED TYPE: Criteria', None, None) + + self.__field_selection = field_selection + self.__key_modified['field_selection'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/notifications_operations.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/notifications_operations.py new file mode 100644 index 0000000..6a77ed6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/notifications_operations.py @@ -0,0 +1,242 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class NotificationsOperations(object): + def __init__(self): + """Creates an instance of NotificationsOperations""" + pass + + def get_notifications(self, param_instance=None): + """ + The method to get notifications + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/actions/watch' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def enable_notifications(self, request): + """ + The method to enable notifications + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_notifications(self, request): + """ + The method to update notifications + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_notification(self, request): + """ + The method to update notification + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def disable_notification(self, request): + """ + The method to disable notification + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/actions/watch' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_notification(self, param_instance=None): + """ + The method to delete notification + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/actions/watch' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetNotificationsParam(object): + page = Param('page', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + per_page = Param('per_page', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + channel_id = Param('channel_id', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + module = Param('module', 'com.zoho.crm.api.Notifications.GetNotificationsParam') + + +class DeleteNotificationParam(object): + channel_ids = Param('channel_ids', 'com.zoho.crm.api.Notifications.DeleteNotificationParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/response_wrapper.py new file mode 100644 index 0000000..c8d87d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__watch = None + self.__info = None + self.__key_modified = dict() + + def get_watch(self): + """ + The method to get the watch + + Returns: + list: An instance of list + """ + + return self.__watch + + def set_watch(self, watch): + """ + The method to set the value to watch + + Parameters: + watch (list) : An instance of list + """ + + if watch is not None and not isinstance(watch, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: watch EXPECTED TYPE: list', None, None) + + self.__watch = watch + self.__key_modified['watch'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.notifications.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/notifications/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/notifications/success_response.py new file mode 100644 index 0000000..7544ce9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/notifications/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.notifications.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/org/__init__.py new file mode 100644 index 0000000..883c2f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .hierarchy_preferences import HierarchyPreferences +from .resource import Resource +from .org import Org +from .checkin_preferences import CheckinPreferences +from .license_details import LicenseDetails +from .api_exception import APIException +from .response_handler import ResponseHandler +from .feature import Feature +from .success_response import SuccessResponse +from .file_body_wrapper import FileBodyWrapper +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .org_operations import OrgOperations, GetOrganizationHeader diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/org/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/org/action_wrapper.py new file mode 100644 index 0000000..d4c66be --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__org = None + self.__key_modified = dict() + + def get_org(self): + """ + The method to get the org + + Returns: + list: An instance of list + """ + + return self.__org + + def set_org(self, org): + """ + The method to set the value to org + + Parameters: + org (list) : An instance of list + """ + + if org is not None and not isinstance(org, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org EXPECTED TYPE: list', None, None) + + self.__org = org + self.__key_modified['org'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/org/api_exception.py new file mode 100644 index 0000000..c88828c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/api_exception.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + self.__api_name = None + self.__json_path = None + self.__features = None + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def get_features(self): + """ + The method to get the features + + Returns: + list: An instance of list + """ + + return self.__features + + def set_features(self, features): + """ + The method to set the value to features + + Parameters: + features (list) : An instance of list + """ + + if features is not None and not isinstance(features, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: features EXPECTED TYPE: list', None, None) + + self.__features = features + self.__key_modified['features'] = 1 diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/checkin_preferences.py b/zohocrmsdk/src/com/zoho/crm/api/org/checkin_preferences.py new file mode 100644 index 0000000..b76db6b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/checkin_preferences.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CheckinPreferences(object): + def __init__(self): + """Creates an instance of CheckinPreferences""" + + self.__restricted_event_types = None + self.__key_modified = dict() + + def get_restricted_event_types(self): + """ + The method to get the restricted_event_types + + Returns: + string: A string representing the restricted_event_types + """ + + return self.__restricted_event_types + + def set_restricted_event_types(self, restricted_event_types): + """ + The method to set the value to restricted_event_types + + Parameters: + restricted_event_types (string) : A string representing the restricted_event_types + """ + + if restricted_event_types is not None and not isinstance(restricted_event_types, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_event_types EXPECTED TYPE: str', None, None) + + self.__restricted_event_types = restricted_event_types + self.__key_modified['restricted_event_types'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/feature.py b/zohocrmsdk/src/com/zoho/crm/api/org/feature.py new file mode 100644 index 0000000..5830e65 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/feature.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Feature(object): + def __init__(self): + """Creates an instance of Feature""" + + self.__name = None + self.__resources = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/org/file_body_wrapper.py new file mode 100644 index 0000000..4c06736 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/hierarchy_preferences.py b/zohocrmsdk/src/com/zoho/crm/api/org/hierarchy_preferences.py new file mode 100644 index 0000000..a75b4e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/hierarchy_preferences.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class HierarchyPreferences(object): + def __init__(self): + """Creates an instance of HierarchyPreferences""" + + self.__type = None + self.__strictly_reporting = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_strictly_reporting(self): + """ + The method to get the strictly_reporting + + Returns: + bool: A bool representing the strictly_reporting + """ + + return self.__strictly_reporting + + def set_strictly_reporting(self, strictly_reporting): + """ + The method to set the value to strictly_reporting + + Parameters: + strictly_reporting (bool) : A bool representing the strictly_reporting + """ + + if strictly_reporting is not None and not isinstance(strictly_reporting, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: strictly_reporting EXPECTED TYPE: bool', None, None) + + self.__strictly_reporting = strictly_reporting + self.__key_modified['strictly_reporting'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/license_details.py b/zohocrmsdk/src/com/zoho/crm/api/org/license_details.py new file mode 100644 index 0000000..40bcf25 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/license_details.py @@ -0,0 +1,226 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LicenseDetails(object): + def __init__(self): + """Creates an instance of LicenseDetails""" + + self.__paid_expiry = None + self.__users_license_purchased = None + self.__trial_type = None + self.__trial_expiry = None + self.__paid = None + self.__paid_type = None + self.__trial_action = None + self.__key_modified = dict() + + def get_paid_expiry(self): + """ + The method to get the paid_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__paid_expiry + + def set_paid_expiry(self, paid_expiry): + """ + The method to set the value to paid_expiry + + Parameters: + paid_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if paid_expiry is not None and not isinstance(paid_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paid_expiry EXPECTED TYPE: datetime', None, None) + + self.__paid_expiry = paid_expiry + self.__key_modified['paid_expiry'] = 1 + + def get_users_license_purchased(self): + """ + The method to get the users_license_purchased + + Returns: + int: An int representing the users_license_purchased + """ + + return self.__users_license_purchased + + def set_users_license_purchased(self, users_license_purchased): + """ + The method to set the value to users_license_purchased + + Parameters: + users_license_purchased (int) : An int representing the users_license_purchased + """ + + if users_license_purchased is not None and not isinstance(users_license_purchased, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_license_purchased EXPECTED TYPE: int', None, None) + + self.__users_license_purchased = users_license_purchased + self.__key_modified['users_license_purchased'] = 1 + + def get_trial_type(self): + """ + The method to get the trial_type + + Returns: + string: A string representing the trial_type + """ + + return self.__trial_type + + def set_trial_type(self, trial_type): + """ + The method to set the value to trial_type + + Parameters: + trial_type (string) : A string representing the trial_type + """ + + if trial_type is not None and not isinstance(trial_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trial_type EXPECTED TYPE: str', None, None) + + self.__trial_type = trial_type + self.__key_modified['trial_type'] = 1 + + def get_trial_expiry(self): + """ + The method to get the trial_expiry + + Returns: + string: A string representing the trial_expiry + """ + + return self.__trial_expiry + + def set_trial_expiry(self, trial_expiry): + """ + The method to set the value to trial_expiry + + Parameters: + trial_expiry (string) : A string representing the trial_expiry + """ + + if trial_expiry is not None and not isinstance(trial_expiry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trial_expiry EXPECTED TYPE: str', None, None) + + self.__trial_expiry = trial_expiry + self.__key_modified['trial_expiry'] = 1 + + def get_paid(self): + """ + The method to get the paid + + Returns: + bool: A bool representing the paid + """ + + return self.__paid + + def set_paid(self, paid): + """ + The method to set the value to paid + + Parameters: + paid (bool) : A bool representing the paid + """ + + if paid is not None and not isinstance(paid, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paid EXPECTED TYPE: bool', None, None) + + self.__paid = paid + self.__key_modified['paid'] = 1 + + def get_paid_type(self): + """ + The method to get the paid_type + + Returns: + string: A string representing the paid_type + """ + + return self.__paid_type + + def set_paid_type(self, paid_type): + """ + The method to set the value to paid_type + + Parameters: + paid_type (string) : A string representing the paid_type + """ + + if paid_type is not None and not isinstance(paid_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: paid_type EXPECTED TYPE: str', None, None) + + self.__paid_type = paid_type + self.__key_modified['paid_type'] = 1 + + def get_trial_action(self): + """ + The method to get the trial_action + + Returns: + string: A string representing the trial_action + """ + + return self.__trial_action + + def set_trial_action(self, trial_action): + """ + The method to set the value to trial_action + + Parameters: + trial_action (string) : A string representing the trial_action + """ + + if trial_action is not None and not isinstance(trial_action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trial_action EXPECTED TYPE: str', None, None) + + self.__trial_action = trial_action + self.__key_modified['trial_action'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/org.py b/zohocrmsdk/src/com/zoho/crm/api/org/org.py new file mode 100644 index 0000000..d7a3de1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/org.py @@ -0,0 +1,1138 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Org(object): + def __init__(self): + """Creates an instance of Org""" + + self.__country = None + self.__photo_id = None + self.__city = None + self.__description = None + self.__mc_status = None + self.__gapps_enabled = None + self.__translation_enabled = None + self.__street = None + self.__domain_name = None + self.__alias = None + self.__currency = None + self.__id = None + self.__state = None + self.__fax = None + self.__zip = None + self.__employee_count = None + self.__website = None + self.__currency_symbol = None + self.__mobile = None + self.__currency_locale = None + self.__primary_zuid = None + self.__zia_portal_id = None + self.__time_zone = None + self.__zgid = None + self.__country_code = None + self.__deletable_org_account = None + self.__license_details = None + self.__hierarchy_preferences = None + self.__phone = None + self.__company_name = None + self.__privacy_settings = None + self.__primary_email = None + self.__iso_code = None + self.__hipaa_compliance_enabled = None + self.__lite_users_enabled = None + self.__max_per_page = None + self.__ezgid = None + self.__call_icon = None + self.__oauth_presence = None + self.__zia_zgid = None + self.__checkin_preferences = None + self.__type = None + self.__created_time = None + self.__key_modified = dict() + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.__country + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.__country = country + self.__key_modified['country'] = 1 + + def get_photo_id(self): + """ + The method to get the photo_id + + Returns: + string: A string representing the photo_id + """ + + return self.__photo_id + + def set_photo_id(self, photo_id): + """ + The method to set the value to photo_id + + Parameters: + photo_id (string) : A string representing the photo_id + """ + + if photo_id is not None and not isinstance(photo_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: photo_id EXPECTED TYPE: str', None, None) + + self.__photo_id = photo_id + self.__key_modified['photo_id'] = 1 + + def get_city(self): + """ + The method to get the city + + Returns: + string: A string representing the city + """ + + return self.__city + + def set_city(self, city): + """ + The method to set the value to city + + Parameters: + city (string) : A string representing the city + """ + + if city is not None and not isinstance(city, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: city EXPECTED TYPE: str', None, None) + + self.__city = city + self.__key_modified['city'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_mc_status(self): + """ + The method to get the mc_status + + Returns: + bool: A bool representing the mc_status + """ + + return self.__mc_status + + def set_mc_status(self, mc_status): + """ + The method to set the value to mc_status + + Parameters: + mc_status (bool) : A bool representing the mc_status + """ + + if mc_status is not None and not isinstance(mc_status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mc_status EXPECTED TYPE: bool', None, None) + + self.__mc_status = mc_status + self.__key_modified['mc_status'] = 1 + + def get_gapps_enabled(self): + """ + The method to get the gapps_enabled + + Returns: + bool: A bool representing the gapps_enabled + """ + + return self.__gapps_enabled + + def set_gapps_enabled(self, gapps_enabled): + """ + The method to set the value to gapps_enabled + + Parameters: + gapps_enabled (bool) : A bool representing the gapps_enabled + """ + + if gapps_enabled is not None and not isinstance(gapps_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: gapps_enabled EXPECTED TYPE: bool', None, None) + + self.__gapps_enabled = gapps_enabled + self.__key_modified['gapps_enabled'] = 1 + + def get_translation_enabled(self): + """ + The method to get the translation_enabled + + Returns: + bool: A bool representing the translation_enabled + """ + + return self.__translation_enabled + + def set_translation_enabled(self, translation_enabled): + """ + The method to set the value to translation_enabled + + Parameters: + translation_enabled (bool) : A bool representing the translation_enabled + """ + + if translation_enabled is not None and not isinstance(translation_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: translation_enabled EXPECTED TYPE: bool', None, None) + + self.__translation_enabled = translation_enabled + self.__key_modified['translation_enabled'] = 1 + + def get_street(self): + """ + The method to get the street + + Returns: + string: A string representing the street + """ + + return self.__street + + def set_street(self, street): + """ + The method to set the value to street + + Parameters: + street (string) : A string representing the street + """ + + if street is not None and not isinstance(street, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: street EXPECTED TYPE: str', None, None) + + self.__street = street + self.__key_modified['street'] = 1 + + def get_domain_name(self): + """ + The method to get the domain_name + + Returns: + string: A string representing the domain_name + """ + + return self.__domain_name + + def set_domain_name(self, domain_name): + """ + The method to set the value to domain_name + + Parameters: + domain_name (string) : A string representing the domain_name + """ + + if domain_name is not None and not isinstance(domain_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: domain_name EXPECTED TYPE: str', None, None) + + self.__domain_name = domain_name + self.__key_modified['domain_name'] = 1 + + def get_alias(self): + """ + The method to get the alias + + Returns: + string: A string representing the alias + """ + + return self.__alias + + def set_alias(self, alias): + """ + The method to set the value to alias + + Parameters: + alias (string) : A string representing the alias + """ + + if alias is not None and not isinstance(alias, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alias EXPECTED TYPE: str', None, None) + + self.__alias = alias + self.__key_modified['alias'] = 1 + + def get_currency(self): + """ + The method to get the currency + + Returns: + string: A string representing the currency + """ + + return self.__currency + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (string) : A string representing the currency + """ + + if currency is not None and not isinstance(currency, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: str', None, None) + + self.__currency = currency + self.__key_modified['currency'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_fax(self): + """ + The method to get the fax + + Returns: + string: A string representing the fax + """ + + return self.__fax + + def set_fax(self, fax): + """ + The method to set the value to fax + + Parameters: + fax (string) : A string representing the fax + """ + + if fax is not None and not isinstance(fax, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fax EXPECTED TYPE: str', None, None) + + self.__fax = fax + self.__key_modified['fax'] = 1 + + def get_zip(self): + """ + The method to get the zip + + Returns: + string: A string representing the zip + """ + + return self.__zip + + def set_zip(self, zip): + """ + The method to set the value to zip + + Parameters: + zip (string) : A string representing the zip + """ + + if zip is not None and not isinstance(zip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zip EXPECTED TYPE: str', None, None) + + self.__zip = zip + self.__key_modified['zip'] = 1 + + def get_employee_count(self): + """ + The method to get the employee_count + + Returns: + string: A string representing the employee_count + """ + + return self.__employee_count + + def set_employee_count(self, employee_count): + """ + The method to set the value to employee_count + + Parameters: + employee_count (string) : A string representing the employee_count + """ + + if employee_count is not None and not isinstance(employee_count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: employee_count EXPECTED TYPE: str', None, None) + + self.__employee_count = employee_count + self.__key_modified['employee_count'] = 1 + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_currency_symbol(self): + """ + The method to get the currency_symbol + + Returns: + string: A string representing the currency_symbol + """ + + return self.__currency_symbol + + def set_currency_symbol(self, currency_symbol): + """ + The method to set the value to currency_symbol + + Parameters: + currency_symbol (string) : A string representing the currency_symbol + """ + + if currency_symbol is not None and not isinstance(currency_symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency_symbol EXPECTED TYPE: str', None, None) + + self.__currency_symbol = currency_symbol + self.__key_modified['currency_symbol'] = 1 + + def get_mobile(self): + """ + The method to get the mobile + + Returns: + string: A string representing the mobile + """ + + return self.__mobile + + def set_mobile(self, mobile): + """ + The method to set the value to mobile + + Parameters: + mobile (string) : A string representing the mobile + """ + + if mobile is not None and not isinstance(mobile, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mobile EXPECTED TYPE: str', None, None) + + self.__mobile = mobile + self.__key_modified['mobile'] = 1 + + def get_currency_locale(self): + """ + The method to get the currency_locale + + Returns: + string: A string representing the currency_locale + """ + + return self.__currency_locale + + def set_currency_locale(self, currency_locale): + """ + The method to set the value to currency_locale + + Parameters: + currency_locale (string) : A string representing the currency_locale + """ + + if currency_locale is not None and not isinstance(currency_locale, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency_locale EXPECTED TYPE: str', None, None) + + self.__currency_locale = currency_locale + self.__key_modified['currency_locale'] = 1 + + def get_primary_zuid(self): + """ + The method to get the primary_zuid + + Returns: + string: A string representing the primary_zuid + """ + + return self.__primary_zuid + + def set_primary_zuid(self, primary_zuid): + """ + The method to set the value to primary_zuid + + Parameters: + primary_zuid (string) : A string representing the primary_zuid + """ + + if primary_zuid is not None and not isinstance(primary_zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_zuid EXPECTED TYPE: str', None, None) + + self.__primary_zuid = primary_zuid + self.__key_modified['primary_zuid'] = 1 + + def get_zia_portal_id(self): + """ + The method to get the zia_portal_id + + Returns: + string: A string representing the zia_portal_id + """ + + return self.__zia_portal_id + + def set_zia_portal_id(self, zia_portal_id): + """ + The method to set the value to zia_portal_id + + Parameters: + zia_portal_id (string) : A string representing the zia_portal_id + """ + + if zia_portal_id is not None and not isinstance(zia_portal_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_portal_id EXPECTED TYPE: str', None, None) + + self.__zia_portal_id = zia_portal_id + self.__key_modified['zia_portal_id'] = 1 + + def get_time_zone(self): + """ + The method to get the time_zone + + Returns: + string: A string representing the time_zone + """ + + return self.__time_zone + + def set_time_zone(self, time_zone): + """ + The method to set the value to time_zone + + Parameters: + time_zone (string) : A string representing the time_zone + """ + + self.__time_zone = time_zone + self.__key_modified['time_zone'] = 1 + + def get_zgid(self): + """ + The method to get the zgid + + Returns: + string: A string representing the zgid + """ + + return self.__zgid + + def set_zgid(self, zgid): + """ + The method to set the value to zgid + + Parameters: + zgid (string) : A string representing the zgid + """ + + if zgid is not None and not isinstance(zgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zgid EXPECTED TYPE: str', None, None) + + self.__zgid = zgid + self.__key_modified['zgid'] = 1 + + def get_country_code(self): + """ + The method to get the country_code + + Returns: + string: A string representing the country_code + """ + + return self.__country_code + + def set_country_code(self, country_code): + """ + The method to set the value to country_code + + Parameters: + country_code (string) : A string representing the country_code + """ + + if country_code is not None and not isinstance(country_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country_code EXPECTED TYPE: str', None, None) + + self.__country_code = country_code + self.__key_modified['country_code'] = 1 + + def get_deletable_org_account(self): + """ + The method to get the deletable_org_account + + Returns: + bool: A bool representing the deletable_org_account + """ + + return self.__deletable_org_account + + def set_deletable_org_account(self, deletable_org_account): + """ + The method to set the value to deletable_org_account + + Parameters: + deletable_org_account (bool) : A bool representing the deletable_org_account + """ + + if deletable_org_account is not None and not isinstance(deletable_org_account, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deletable_org_account EXPECTED TYPE: bool', None, None) + + self.__deletable_org_account = deletable_org_account + self.__key_modified['deletable_org_account'] = 1 + + def get_license_details(self): + """ + The method to get the license_details + + Returns: + LicenseDetails: An instance of LicenseDetails + """ + + return self.__license_details + + def set_license_details(self, license_details): + """ + The method to set the value to license_details + + Parameters: + license_details (LicenseDetails) : An instance of LicenseDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.license_details import LicenseDetails + except Exception: + from .license_details import LicenseDetails + + if license_details is not None and not isinstance(license_details, LicenseDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: license_details EXPECTED TYPE: LicenseDetails', None, None) + + self.__license_details = license_details + self.__key_modified['license_details'] = 1 + + def get_hierarchy_preferences(self): + """ + The method to get the hierarchy_preferences + + Returns: + HierarchyPreferences: An instance of HierarchyPreferences + """ + + return self.__hierarchy_preferences + + def set_hierarchy_preferences(self, hierarchy_preferences): + """ + The method to set the value to hierarchy_preferences + + Parameters: + hierarchy_preferences (HierarchyPreferences) : An instance of HierarchyPreferences + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.hierarchy_preferences import HierarchyPreferences + except Exception: + from .hierarchy_preferences import HierarchyPreferences + + if hierarchy_preferences is not None and not isinstance(hierarchy_preferences, HierarchyPreferences): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hierarchy_preferences EXPECTED TYPE: HierarchyPreferences', None, None) + + self.__hierarchy_preferences = hierarchy_preferences + self.__key_modified['hierarchy_preferences'] = 1 + + def get_phone(self): + """ + The method to get the phone + + Returns: + string: A string representing the phone + """ + + return self.__phone + + def set_phone(self, phone): + """ + The method to set the value to phone + + Parameters: + phone (string) : A string representing the phone + """ + + if phone is not None and not isinstance(phone, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: phone EXPECTED TYPE: str', None, None) + + self.__phone = phone + self.__key_modified['phone'] = 1 + + def get_company_name(self): + """ + The method to get the company_name + + Returns: + string: A string representing the company_name + """ + + return self.__company_name + + def set_company_name(self, company_name): + """ + The method to set the value to company_name + + Parameters: + company_name (string) : A string representing the company_name + """ + + if company_name is not None and not isinstance(company_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company_name EXPECTED TYPE: str', None, None) + + self.__company_name = company_name + self.__key_modified['company_name'] = 1 + + def get_privacy_settings(self): + """ + The method to get the privacy_settings + + Returns: + bool: A bool representing the privacy_settings + """ + + return self.__privacy_settings + + def set_privacy_settings(self, privacy_settings): + """ + The method to set the value to privacy_settings + + Parameters: + privacy_settings (bool) : A bool representing the privacy_settings + """ + + if privacy_settings is not None and not isinstance(privacy_settings, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacy_settings EXPECTED TYPE: bool', None, None) + + self.__privacy_settings = privacy_settings + self.__key_modified['privacy_settings'] = 1 + + def get_primary_email(self): + """ + The method to get the primary_email + + Returns: + string: A string representing the primary_email + """ + + return self.__primary_email + + def set_primary_email(self, primary_email): + """ + The method to set the value to primary_email + + Parameters: + primary_email (string) : A string representing the primary_email + """ + + if primary_email is not None and not isinstance(primary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_email EXPECTED TYPE: str', None, None) + + self.__primary_email = primary_email + self.__key_modified['primary_email'] = 1 + + def get_iso_code(self): + """ + The method to get the iso_code + + Returns: + string: A string representing the iso_code + """ + + return self.__iso_code + + def set_iso_code(self, iso_code): + """ + The method to set the value to iso_code + + Parameters: + iso_code (string) : A string representing the iso_code + """ + + if iso_code is not None and not isinstance(iso_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iso_code EXPECTED TYPE: str', None, None) + + self.__iso_code = iso_code + self.__key_modified['iso_code'] = 1 + + def get_hipaa_compliance_enabled(self): + """ + The method to get the hipaa_compliance_enabled + + Returns: + bool: A bool representing the hipaa_compliance_enabled + """ + + return self.__hipaa_compliance_enabled + + def set_hipaa_compliance_enabled(self, hipaa_compliance_enabled): + """ + The method to set the value to hipaa_compliance_enabled + + Parameters: + hipaa_compliance_enabled (bool) : A bool representing the hipaa_compliance_enabled + """ + + if hipaa_compliance_enabled is not None and not isinstance(hipaa_compliance_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hipaa_compliance_enabled EXPECTED TYPE: bool', None, None) + + self.__hipaa_compliance_enabled = hipaa_compliance_enabled + self.__key_modified['hipaa_compliance_enabled'] = 1 + + def get_lite_users_enabled(self): + """ + The method to get the lite_users_enabled + + Returns: + bool: A bool representing the lite_users_enabled + """ + + return self.__lite_users_enabled + + def set_lite_users_enabled(self, lite_users_enabled): + """ + The method to set the value to lite_users_enabled + + Parameters: + lite_users_enabled (bool) : A bool representing the lite_users_enabled + """ + + if lite_users_enabled is not None and not isinstance(lite_users_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lite_users_enabled EXPECTED TYPE: bool', None, None) + + self.__lite_users_enabled = lite_users_enabled + self.__key_modified['lite_users_enabled'] = 1 + + def get_max_per_page(self): + """ + The method to get the max_per_page + + Returns: + int: An int representing the max_per_page + """ + + return self.__max_per_page + + def set_max_per_page(self, max_per_page): + """ + The method to set the value to max_per_page + + Parameters: + max_per_page (int) : An int representing the max_per_page + """ + + if max_per_page is not None and not isinstance(max_per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: max_per_page EXPECTED TYPE: int', None, None) + + self.__max_per_page = max_per_page + self.__key_modified['max_per_page'] = 1 + + def get_ezgid(self): + """ + The method to get the ezgid + + Returns: + string: A string representing the ezgid + """ + + return self.__ezgid + + def set_ezgid(self, ezgid): + """ + The method to set the value to ezgid + + Parameters: + ezgid (string) : A string representing the ezgid + """ + + if ezgid is not None and not isinstance(ezgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ezgid EXPECTED TYPE: str', None, None) + + self.__ezgid = ezgid + self.__key_modified['ezgid'] = 1 + + def get_call_icon(self): + """ + The method to get the call_icon + + Returns: + string: A string representing the call_icon + """ + + return self.__call_icon + + def set_call_icon(self, call_icon): + """ + The method to set the value to call_icon + + Parameters: + call_icon (string) : A string representing the call_icon + """ + + if call_icon is not None and not isinstance(call_icon, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call_icon EXPECTED TYPE: str', None, None) + + self.__call_icon = call_icon + self.__key_modified['call_icon'] = 1 + + def get_oauth_presence(self): + """ + The method to get the oauth_presence + + Returns: + bool: A bool representing the oauth_presence + """ + + return self.__oauth_presence + + def set_oauth_presence(self, oauth_presence): + """ + The method to set the value to oauth_presence + + Parameters: + oauth_presence (bool) : A bool representing the oauth_presence + """ + + if oauth_presence is not None and not isinstance(oauth_presence, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: oauth_presence EXPECTED TYPE: bool', None, None) + + self.__oauth_presence = oauth_presence + self.__key_modified['oauth_presence'] = 1 + + def get_zia_zgid(self): + """ + The method to get the zia_zgid + + Returns: + int: An int representing the zia_zgid + """ + + return self.__zia_zgid + + def set_zia_zgid(self, zia_zgid): + """ + The method to set the value to zia_zgid + + Parameters: + zia_zgid (int) : An int representing the zia_zgid + """ + + if zia_zgid is not None and not isinstance(zia_zgid, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_zgid EXPECTED TYPE: int', None, None) + + self.__zia_zgid = zia_zgid + self.__key_modified['zia_zgid'] = 1 + + def get_checkin_preferences(self): + """ + The method to get the checkin_preferences + + Returns: + CheckinPreferences: An instance of CheckinPreferences + """ + + return self.__checkin_preferences + + def set_checkin_preferences(self, checkin_preferences): + """ + The method to set the value to checkin_preferences + + Parameters: + checkin_preferences (CheckinPreferences) : An instance of CheckinPreferences + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.checkin_preferences import CheckinPreferences + except Exception: + from .checkin_preferences import CheckinPreferences + + if checkin_preferences is not None and not isinstance(checkin_preferences, CheckinPreferences): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: checkin_preferences EXPECTED TYPE: CheckinPreferences', None, None) + + self.__checkin_preferences = checkin_preferences + self.__key_modified['checkin_preferences'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/org_operations.py b/zohocrmsdk/src/com/zoho/crm/api/org/org_operations.py new file mode 100644 index 0000000..6616c90 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/org_operations.py @@ -0,0 +1,122 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class OrgOperations(object): + def __init__(self): + """Creates an instance of OrgOperations""" + pass + + def get_organization(self): + """ + The method to get organization + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_org_photo(self): + """ + The method to get org photo + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/photo' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'image/png') + + def upload_organization_photo(self, request): + """ + The method to upload organization photo + + Parameters: + request (FileBodyWrapper) : An instance of FileBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.org.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/photo' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_organization_photo(self): + """ + The method to delete organization photo + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/photo' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetOrganizationHeader(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/resource.py b/zohocrmsdk/src/com/zoho/crm/api/org/resource.py new file mode 100644 index 0000000..503885e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/org/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/org/response_wrapper.py new file mode 100644 index 0000000..4e2482e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__org = None + self.__key_modified = dict() + + def get_org(self): + """ + The method to get the org + + Returns: + list: An instance of list + """ + + return self.__org + + def set_org(self, org): + """ + The method to set the value to org + + Parameters: + org (list) : An instance of list + """ + + if org is not None and not isinstance(org, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org EXPECTED TYPE: list', None, None) + + self.__org = org + self.__key_modified['org'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/org/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/org/success_response.py new file mode 100644 index 0000000..ff16ce4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/org/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.org.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class SuccessResponse(ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/param.py b/zohocrmsdk/src/com/zoho/crm/api/param.py new file mode 100755 index 0000000..0356b81 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/param.py @@ -0,0 +1,19 @@ + +class Param(object): + + """ + This class represents the HTTP parameter. + """ + + def __init__(self, name, class_name=None): + + """ + Creates an Param class instance with the following parameters + + Parameters: + name (str) : A string containing the parameter name. + class_name (str) : A string containing the parameter class name. + """ + + self.name = name + self.class_name = class_name diff --git a/zohocrmsdk/src/com/zoho/crm/api/parameter_map.py b/zohocrmsdk/src/com/zoho/crm/api/parameter_map.py new file mode 100755 index 0000000..616d88b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/parameter_map.py @@ -0,0 +1,69 @@ +try: + import logging + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.header_param_validator import HeaderParamValidator +except Exception: + import logging + from .util.constants import Constants + from .util.header_param_validator import HeaderParamValidator + from .util.datatype_converter import DataTypeConverter + from .param import Param + from ..api.exception import SDKException + + +class ParameterMap(object): + """ + This class represents the HTTP parameter name and value. + """ + + def __init__(self): + """Creates an instance of ParameterMap Class""" + + self.request_parameters = dict() + + def add(self, param, value): + + """ + The method to add parameter name and value. + + Parameters: + param (Param): A Param class instance. + value (object): An object containing the parameter value. + """ + + if param is None: + raise SDKException(Constants.PARAMETER_NONE_ERROR, Constants.PARAM_INSTANCE_NONE_ERROR) + + param_name = param.name + + if param_name is None: + raise SDKException(Constants.PARAM_NAME_NONE_ERROR, Constants.PARAM_NAME_NONE_ERROR_MESSAGE) + + if value is None: + raise SDKException(Constants.PARAMETER_NONE_ERROR, param_name + Constants.NONE_VALUE_ERROR_MESSAGE) + + try: + class_name = param.class_name + parsed_param_value = None + if class_name is not None: + parsed_param_value = HeaderParamValidator().validate(param_name, class_name, value) + else: + try: + parsed_param_value = DataTypeConverter.post_convert(value, value.__class__.__name__) + except Exception as e: + parsed_param_value = str(value) + if param_name not in self.request_parameters: + self.request_parameters[param_name] = str(parsed_param_value) + else: + param_value = self.request_parameters[param_name] + self.request_parameters[param_name] = param_value + ',' + str(parsed_param_value) + except SDKException as e: + logging.getLogger('SDKLogger').error(Constants.PARAM_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + logging.getLogger('SDKLogger').error(Constants.PARAM_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/__init__.py new file mode 100644 index 0000000..f86ff39 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .layout_association import LayoutAssociation +from .pick_list_values_operations import PickListValuesOperations, GetPickListValuesParam +from .response_wrapper import ResponseWrapper +from .pick_list_values import PickListValues diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/api_exception.py new file mode 100644 index 0000000..cacfa0c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pick_list_values.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/layout_association.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/layout_association.py new file mode 100644 index 0000000..b7df3da --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/layout_association.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LayoutAssociation(object): + def __init__(self): + """Creates an instance of LayoutAssociation""" + + self.__api_name = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values.py new file mode 100644 index 0000000..dda52a0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values.py @@ -0,0 +1,249 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PickListValues(object): + def __init__(self): + """Creates an instance of PickListValues""" + + self.__sequence_number = None + self.__display_value = None + self.__reference_value = None + self.__colour_code = None + self.__actual_value = None + self.__id = None + self.__type = None + self.__layout_associations = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_reference_value(self): + """ + The method to get the reference_value + + Returns: + string: A string representing the reference_value + """ + + return self.__reference_value + + def set_reference_value(self, reference_value): + """ + The method to set the value to reference_value + + Parameters: + reference_value (string) : A string representing the reference_value + """ + + if reference_value is not None and not isinstance(reference_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reference_value EXPECTED TYPE: str', None, None) + + self.__reference_value = reference_value + self.__key_modified['reference_value'] = 1 + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_layout_associations(self): + """ + The method to get the layout_associations + + Returns: + list: An instance of list + """ + + return self.__layout_associations + + def set_layout_associations(self, layout_associations): + """ + The method to set the value to layout_associations + + Parameters: + layout_associations (list) : An instance of list + """ + + if layout_associations is not None and not isinstance(layout_associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_associations EXPECTED TYPE: list', None, None) + + self.__layout_associations = layout_associations + self.__key_modified['layout_associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values_operations.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values_operations.py new file mode 100644 index 0000000..6576c0f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/pick_list_values_operations.py @@ -0,0 +1,59 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class PickListValuesOperations(object): + def __init__(self, field_id, module=None): + """ + Creates an instance of PickListValuesOperations with the given parameters + + Parameters: + field_id (int) : An int representing the field_id + module (string) : A string representing the module + """ + + if not isinstance(field_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_id EXPECTED TYPE: int', None, None) + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__field_id = field_id + self.__module = module + + + def get_pick_list_values(self): + """ + The method to get pick list values + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/fields/' + api_path = api_path + str(self.__field_id) + api_path = api_path + '/pick_list_values' + 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.PickListValues.GetPickListValuesParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.pick_list_values.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetPickListValuesParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_wrapper.py new file mode 100644 index 0000000..8c18ba8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pick_list_values/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pick_list_values.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__pick_list_values = None + self.__key_modified = dict() + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/__init__.py new file mode 100644 index 0000000..cc946de --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/__init__.py @@ -0,0 +1,24 @@ +from .action_wrapper import ActionWrapper +from .transfer_pipeline_action_handler import TransferPipelineActionHandler +from .maps import Maps +from .transfer_pipeline_action_wrapper import TransferPipelineActionWrapper +from .forecast_category import ForecastCategory +from .body_wrapper import BodyWrapper +from .transfer_pipeline_wrapper import TransferPipelineWrapper +from .delete import Delete +from .pipeline_operations import PipelineOperations, GetPipelinesParam, CreatePipelineParam, UpdatePipelinesParam, GetPipelineParam, UpdatePipelineParam, DeletePipelineParam, TransferPipelinesParam +from .pipeline import Pipeline +from .api_exception import APIException +from .transfer_pipeline import TransferPipeline +from .t_pipeline import TPipeline +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .transfer_pipeline_action_response import TransferPipelineActionResponse +from .d_pipeline_wrapper import DPipelineWrapper +from .d_pipeline import DPipeline +from .success_response import SuccessResponse +from .transfer_pipeline_success_response import TransferPipelineSuccessResponse +from .stages import Stages +from .json_details import JsonDetails +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_wrapper.py new file mode 100644 index 0000000..8a37be4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/api_exception.py new file mode 100644 index 0000000..7d87b11 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_handler import TransferPipelineActionHandler + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_response import TransferPipelineActionResponse + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .transfer_pipeline_action_handler import TransferPipelineActionHandler + from .transfer_pipeline_action_response import TransferPipelineActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, TransferPipelineActionResponse, ResponseHandler, ActionHandler, TransferPipelineActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/body_wrapper.py new file mode 100644 index 0000000..8223940 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline.py new file mode 100644 index 0000000..4d9b656 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DPipeline(object): + def __init__(self): + """Creates an instance of DPipeline""" + + self.__delete = None + self.__key_modified = dict() + + def get_delete(self): + """ + The method to get the delete + + Returns: + Delete: An instance of Delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (Delete) : An instance of Delete + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.delete import Delete + except Exception: + from .delete import Delete + + if delete is not None and not isinstance(delete, Delete): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: Delete', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline_wrapper.py new file mode 100644 index 0000000..aa912c7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/d_pipeline_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DPipelineWrapper(object): + def __init__(self): + """Creates an instance of DPipelineWrapper""" + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/delete.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/delete.py new file mode 100644 index 0000000..81d54eb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/delete.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Delete(object): + def __init__(self): + """Creates an instance of Delete""" + + self.__permanent = None + self.__key_modified = dict() + + def get_permanent(self): + """ + The method to get the permanent + + Returns: + bool: A bool representing the permanent + """ + + return self.__permanent + + def set_permanent(self, permanent): + """ + The method to set the value to permanent + + Parameters: + permanent (bool) : A bool representing the permanent + """ + + if permanent is not None and not isinstance(permanent, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permanent EXPECTED TYPE: bool', None, None) + + self.__permanent = permanent + self.__key_modified['permanent'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/forecast_category.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/forecast_category.py new file mode 100644 index 0000000..cc2b2e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/forecast_category.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ForecastCategory(object): + def __init__(self): + """Creates an instance of ForecastCategory""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/json_details.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/json_details.py new file mode 100644 index 0000000..aaf7438 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/json_details.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class JsonDetails(object): + def __init__(self): + """Creates an instance of JsonDetails""" + + self.__api_name = None + self.__json_path = None + self.__expected_data_type = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def get_expected_data_type(self): + """ + The method to get the expected_data_type + + Returns: + string: A string representing the expected_data_type + """ + + return self.__expected_data_type + + def set_expected_data_type(self, expected_data_type): + """ + The method to set the value to expected_data_type + + Parameters: + expected_data_type (string) : A string representing the expected_data_type + """ + + if expected_data_type is not None and not isinstance(expected_data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: expected_data_type EXPECTED TYPE: str', None, None) + + self.__expected_data_type = expected_data_type + self.__key_modified['expected_data_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/maps.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/maps.py new file mode 100644 index 0000000..fee84a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/maps.py @@ -0,0 +1,254 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Maps(object): + def __init__(self): + """Creates an instance of Maps""" + + self.__display_value = None + self.__sequence_number = None + self.__forecast_category = None + self.__delete = None + self.__actual_value = None + self.__id = None + self.__colour_code = None + self.__forecast_type = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_forecast_category(self): + """ + The method to get the forecast_category + + Returns: + ForecastCategory: An instance of ForecastCategory + """ + + return self.__forecast_category + + def set_forecast_category(self, forecast_category): + """ + The method to set the value to forecast_category + + Parameters: + forecast_category (ForecastCategory) : An instance of ForecastCategory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.forecast_category import ForecastCategory + except Exception: + from .forecast_category import ForecastCategory + + if forecast_category is not None and not isinstance(forecast_category, ForecastCategory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_category EXPECTED TYPE: ForecastCategory', None, None) + + self.__forecast_category = forecast_category + self.__key_modified['forecast_category'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_forecast_type(self): + """ + The method to get the forecast_type + + Returns: + string: A string representing the forecast_type + """ + + return self.__forecast_type + + def set_forecast_type(self, forecast_type): + """ + The method to set the value to forecast_type + + Parameters: + forecast_type (string) : A string representing the forecast_type + """ + + if forecast_type is not None and not isinstance(forecast_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_type EXPECTED TYPE: str', None, None) + + self.__forecast_type = forecast_type + self.__key_modified['forecast_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline.py new file mode 100644 index 0000000..d5ef467 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Pipeline(object): + def __init__(self): + """Creates an instance of Pipeline""" + + self.__display_value = None + self.__default = None + self.__maps = None + self.__actual_value = None + self.__id = None + self.__child_available = None + self.__parent = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_maps(self): + """ + The method to get the maps + + Returns: + list: An instance of list + """ + + return self.__maps + + def set_maps(self, maps): + """ + The method to set the value to maps + + Parameters: + maps (list) : An instance of list + """ + + if maps is not None and not isinstance(maps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: maps EXPECTED TYPE: list', None, None) + + self.__maps = maps + self.__key_modified['maps'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_child_available(self): + """ + The method to get the child_available + + Returns: + bool: A bool representing the child_available + """ + + return self.__child_available + + def set_child_available(self, child_available): + """ + The method to set the value to child_available + + Parameters: + child_available (bool) : A bool representing the child_available + """ + + if child_available is not None and not isinstance(child_available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: child_available EXPECTED TYPE: bool', None, None) + + self.__child_available = child_available + self.__key_modified['child_available'] = 1 + + def get_parent(self): + """ + The method to get the parent + + Returns: + Pipeline: An instance of Pipeline + """ + + return self.__parent + + def set_parent(self, parent): + """ + The method to set the value to parent + + Parameters: + parent (Pipeline) : An instance of Pipeline + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.pipeline import Pipeline + except Exception: + from .pipeline import Pipeline + + if parent is not None and not isinstance(parent, Pipeline): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent EXPECTED TYPE: Pipeline', None, None) + + self.__parent = parent + self.__key_modified['parent'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline_operations.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline_operations.py new file mode 100644 index 0000000..05de9eb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/pipeline_operations.py @@ -0,0 +1,304 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class PipelineOperations(object): + def __init__(self, layout_id=None): + """ + Creates an instance of PipelineOperations with the given parameters + + Parameters: + layout_id (int) : An int representing the layout_id + """ + + if layout_id is not None and not isinstance(layout_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: int', None, None) + + self.__layout_id = layout_id + + + def get_pipelines(self): + """ + The method to get pipelines + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/pipeline' + 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('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelinesParam'), self.__layout_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_pipeline(self, request): + """ + The method to create pipeline + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/pipeline' + 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.CreatePipelineParam'), self.__layout_id) + try: + from zohocrmsdk.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 update_pipelines(self, request): + """ + The method to update pipelines + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/pipeline' + 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.set_mandatory_checker(True) + handler_instance.add_param(Param('layout_id', 'com.zoho.crm.api.Pipeline.UpdatePipelinesParam'), self.__layout_id) + try: + from zohocrmsdk.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 get_pipeline(self, id): + """ + The method to get pipeline + + 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/v7/settings/pipeline/' + 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('layout_id', 'com.zoho.crm.api.Pipeline.GetPipelineParam'), self.__layout_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_pipeline(self, id, request): + """ + The method to update pipeline + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/pipeline/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + 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 zohocrmsdk.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 delete_pipeline(self, id, request): + """ + The method to delete pipeline + + Parameters: + id (int) : An int representing the id + request (DPipelineWrapper) : An instance of DPipelineWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.d_pipeline_wrapper import DPipelineWrapper + except Exception: + from .d_pipeline_wrapper import DPipelineWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, DPipelineWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: DPipelineWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/pipeline/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PATCH) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.add_param(Param('layout_id', 'com.zoho.crm.api.Pipeline.DeletePipelineParam'), self.__layout_id) + try: + from zohocrmsdk.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_pipelines(self, request): + """ + The method to transfer pipelines + + Parameters: + request (TransferPipelineWrapper) : An instance of TransferPipelineWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_wrapper import TransferPipelineWrapper + except Exception: + from .transfer_pipeline_wrapper import TransferPipelineWrapper + + if request is not None and not isinstance(request, TransferPipelineWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferPipelineWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/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_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.add_param(Param('layout_id', 'com.zoho.crm.api.Pipeline.TransferPipelinesParam'), self.__layout_id) + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_handler import TransferPipelineActionHandler + except Exception: + from .transfer_pipeline_action_handler import TransferPipelineActionHandler + return handler_instance.api_call(TransferPipelineActionHandler.__module__, 'application/json') + + +class GetPipelinesParam(object): + pass + + +class CreatePipelineParam(object): + pass + + +class UpdatePipelinesParam(object): + pass + + +class GetPipelineParam(object): + pass + + +class UpdatePipelineParam(object): + pass + + +class DeletePipelineParam(object): + pass + + +class TransferPipelinesParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_wrapper.py new file mode 100644 index 0000000..845b68b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__pipeline = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + list: An instance of list + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (list) : An instance of list + """ + + if pipeline is not None and not isinstance(pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: list', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/stages.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/stages.py new file mode 100644 index 0000000..12d8f42 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/stages.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Stages(object): + def __init__(self): + """Creates an instance of Stages""" + + self.__from_1 = None + self.__to = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + int: An int representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (int) : An int representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: int', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + int: An int representing the to + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (int) : An int representing the to + """ + + if to is not None and not isinstance(to, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: int', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/success_response.py new file mode 100644 index 0000000..a309c71 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/t_pipeline.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/t_pipeline.py new file mode 100644 index 0000000..d95d03b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/t_pipeline.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TPipeline(object): + def __init__(self): + """Creates an instance of TPipeline""" + + self.__from_1 = None + self.__to = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + int: An int representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (int) : An int representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: int', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + int: An int representing the to + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (int) : An int representing the to + """ + + if to is not None and not isinstance(to, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: int', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline.py new file mode 100644 index 0000000..64e904b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferPipeline(object): + def __init__(self): + """Creates an instance of TransferPipeline""" + + self.__pipeline = None + self.__stages = None + self.__key_modified = dict() + + def get_pipeline(self): + """ + The method to get the pipeline + + Returns: + TPipeline: An instance of TPipeline + """ + + return self.__pipeline + + def set_pipeline(self, pipeline): + """ + The method to set the value to pipeline + + Parameters: + pipeline (TPipeline) : An instance of TPipeline + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.pipeline.t_pipeline import TPipeline + except Exception: + from .t_pipeline import TPipeline + + if pipeline is not None and not isinstance(pipeline, TPipeline): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pipeline EXPECTED TYPE: TPipeline', None, None) + + self.__pipeline = pipeline + self.__key_modified['pipeline'] = 1 + + def get_stages(self): + """ + The method to get the stages + + Returns: + list: An instance of list + """ + + return self.__stages + + def set_stages(self, stages): + """ + The method to set the value to stages + + Parameters: + stages (list) : An instance of list + """ + + if stages is not None and not isinstance(stages, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: stages EXPECTED TYPE: list', None, None) + + self.__stages = stages + self.__key_modified['stages'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_handler.py new file mode 100644 index 0000000..a4a50cc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferPipelineActionHandler(ABC): + def __init__(self): + """Creates an instance of TransferPipelineActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_response.py new file mode 100644 index 0000000..df59812 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferPipelineActionResponse(ABC): + def __init__(self): + """Creates an instance of TransferPipelineActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.py new file mode 100644 index 0000000..e40141f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_handler import TransferPipelineActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .transfer_pipeline_action_handler import TransferPipelineActionHandler + + +class TransferPipelineActionWrapper(TransferPipelineActionHandler): + def __init__(self): + """Creates an instance of TransferPipelineActionWrapper""" + super().__init__() + + self.__transfer_pipeline = None + self.__key_modified = dict() + + def get_transfer_pipeline(self): + """ + The method to get the transfer_pipeline + + Returns: + list: An instance of list + """ + + return self.__transfer_pipeline + + def set_transfer_pipeline(self, transfer_pipeline): + """ + The method to set the value to transfer_pipeline + + Parameters: + transfer_pipeline (list) : An instance of list + """ + + if transfer_pipeline is not None and not isinstance(transfer_pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_pipeline EXPECTED TYPE: list', None, None) + + self.__transfer_pipeline = transfer_pipeline + self.__key_modified['transfer_pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_success_response.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_success_response.py new file mode 100644 index 0000000..60b660b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.pipeline.transfer_pipeline_action_response import TransferPipelineActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .transfer_pipeline_action_response import TransferPipelineActionResponse + + +class TransferPipelineSuccessResponse(TransferPipelineActionResponse): + def __init__(self): + """Creates an instance of TransferPipelineSuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_wrapper.py new file mode 100644 index 0000000..8e5c470 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/pipeline/transfer_pipeline_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferPipelineWrapper(object): + def __init__(self): + """Creates an instance of TransferPipelineWrapper""" + + self.__transfer_pipeline = None + self.__key_modified = dict() + + def get_transfer_pipeline(self): + """ + The method to get the transfer_pipeline + + Returns: + list: An instance of list + """ + + return self.__transfer_pipeline + + def set_transfer_pipeline(self, transfer_pipeline): + """ + The method to set the value to transfer_pipeline + + Parameters: + transfer_pipeline (list) : An instance of list + """ + + if transfer_pipeline is not None and not isinstance(transfer_pipeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_pipeline EXPECTED TYPE: list', None, None) + + self.__transfer_pipeline = transfer_pipeline + self.__key_modified['transfer_pipeline'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/__init__.py new file mode 100644 index 0000000..6337197 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/__init__.py @@ -0,0 +1,12 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .job_response import JobResponse +from .action_response import ActionResponse +from .data import Data +from .portal_invite_operations import PortalInviteOperations, InviteUsersParam +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .portal_invite import PortalInvite +from .portal import Portal diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_wrapper.py new file mode 100644 index 0000000..e5460f1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__portal_invite = None + self.__key_modified = dict() + + def get_portal_invite(self): + """ + The method to get the portal_invite + + Returns: + list: An instance of list + """ + + return self.__portal_invite + + def set_portal_invite(self, portal_invite): + """ + The method to set the value to portal_invite + + Parameters: + portal_invite (list) : An instance of list + """ + + if portal_invite is not None and not isinstance(portal_invite, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_invite EXPECTED TYPE: list', None, None) + + self.__portal_invite = portal_invite + self.__key_modified['portal_invite'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/api_exception.py new file mode 100644 index 0000000..80e903b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.data import Data + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .data import Data + from .action_handler import ActionHandler + + +class APIException(Data, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/body_wrapper.py new file mode 100644 index 0000000..ea05a80 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__portal_invite = None + self.__key_modified = dict() + + def get_portal_invite(self): + """ + The method to get the portal_invite + + Returns: + list: An instance of list + """ + + return self.__portal_invite + + def set_portal_invite(self, portal_invite): + """ + The method to set the value to portal_invite + + Parameters: + portal_invite (list) : An instance of list + """ + + if portal_invite is not None and not isinstance(portal_invite, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_invite EXPECTED TYPE: list', None, None) + + self.__portal_invite = portal_invite + self.__key_modified['portal_invite'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/data.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/data.py new file mode 100644 index 0000000..ef0f3f6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/data.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class Data(ABC): + def __init__(self): + """Creates an instance of Data""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/job_response.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/job_response.py new file mode 100644 index 0000000..bf41daf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/job_response.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class JobResponse(object): + def __init__(self): + """Creates an instance of JobResponse""" + + self.__data = None + self.__job_id = None + self.__status = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_job_id(self): + """ + The method to get the job_id + + Returns: + int: An int representing the job_id + """ + + return self.__job_id + + def set_job_id(self, job_id): + """ + The method to set the value to job_id + + Parameters: + job_id (int) : An int representing the job_id + """ + + if job_id is not None and not isinstance(job_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_id EXPECTED TYPE: int', None, None) + + self.__job_id = job_id + self.__key_modified['job_id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal.py new file mode 100644 index 0000000..243dabd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Portal(object): + def __init__(self): + """Creates an instance of Portal""" + + self.__id = None + self.__user_type_id = None + self.__type = None + self.__language = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_user_type_id(self): + """ + The method to get the user_type_id + + Returns: + int: An int representing the user_type_id + """ + + return self.__user_type_id + + def set_user_type_id(self, user_type_id): + """ + The method to set the value to user_type_id + + Parameters: + user_type_id (int) : An int representing the user_type_id + """ + + if user_type_id is not None and not isinstance(user_type_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: int', None, None) + + self.__user_type_id = user_type_id + self.__key_modified['user_type_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_language(self): + """ + The method to get the language + + Returns: + Choice: An instance of Choice + """ + + return self.__language + + def set_language(self, language): + """ + The method to set the value to language + + Parameters: + language (Choice) : An instance of Choice + """ + + if language is not None and not isinstance(language, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: language EXPECTED TYPE: Choice', None, None) + + self.__language = language + self.__key_modified['language'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite.py new file mode 100644 index 0000000..1dbb541 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PortalInvite(object): + def __init__(self): + """Creates an instance of PortalInvite""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite_operations.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite_operations.py new file mode 100644 index 0000000..1c65438 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/portal_invite_operations.py @@ -0,0 +1,73 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class PortalInviteOperations(object): + def __init__(self, module): + """ + Creates an instance of PortalInviteOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def invite_users(self, record, param_instance=None): + """ + The method to invite users + + Parameters: + record (int) : An int representing the record + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: int', None, None) + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(record) + api_path = api_path + '/actions/portal_invite' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class InviteUsersParam(object): + user_type_id = Param('user_type_id', 'com.zoho.crm.api.PortalInvite.InviteUsersParam') + type = Param('type', 'com.zoho.crm.api.PortalInvite.InviteUsersParam') + language = Param('language', 'com.zoho.crm.api.PortalInvite.InviteUsersParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/response_wrapper.py new file mode 100644 index 0000000..cbe2b7f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__portal_invite = None + self.__key_modified = dict() + + def get_portal_invite(self): + """ + The method to get the portal_invite + + Returns: + list: An instance of list + """ + + return self.__portal_invite + + def set_portal_invite(self, portal_invite): + """ + The method to set the value to portal_invite + + Parameters: + portal_invite (list) : An instance of list + """ + + if portal_invite is not None and not isinstance(portal_invite, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_invite EXPECTED TYPE: list', None, None) + + self.__portal_invite = portal_invite + self.__key_modified['portal_invite'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_invite/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/success_response.py new file mode 100644 index 0000000..be3370b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_invite/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portal_invite.data import Data +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .data import Data + + +class SuccessResponse(Data, ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/__init__.py new file mode 100644 index 0000000..b536a16 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .owner import Owner +from .body_wrapper import BodyWrapper +from .filters import Filters +from .layouts import Layouts +from .modules import Modules +from .portal_user_type_operations import PortalUserTypeOperations, GetUserTypesParam +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .user_type import UserType +from .success_response import SuccessResponse +from .permissions import Permissions +from .personality_module import PersonalityModule +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .fields import Fields +from .views import Views diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_wrapper.py new file mode 100644 index 0000000..f8fd7f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__user_type = None + self.__key_modified = dict() + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + list: An instance of list + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (list) : An instance of list + """ + + if user_type is not None and not isinstance(user_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: list', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/api_exception.py new file mode 100644 index 0000000..635068f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/body_wrapper.py new file mode 100644 index 0000000..96c5477 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__user_type = None + self.__key_modified = dict() + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + list: An instance of list + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (list) : An instance of list + """ + + if user_type is not None and not isinstance(user_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: list', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/fields.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/fields.py new file mode 100644 index 0000000..652da8c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/fields.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__read_only = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/filters.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/filters.py new file mode 100644 index 0000000..b232969 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/filters.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Filters(object): + def __init__(self): + """Creates an instance of Filters""" + + self.__display_label = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/layouts.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/layouts.py new file mode 100644 index 0000000..6b994bd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/layouts.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layouts(object): + def __init__(self): + """Creates an instance of Layouts""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__defaultview = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_defaultview(self): + """ + The method to get the defaultview + + Returns: + Views: An instance of Views + """ + + return self.__defaultview + + def set_defaultview(self, defaultview): + """ + The method to set the value to defaultview + + Parameters: + defaultview (Views) : An instance of Views + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.views import Views + except Exception: + from .views import Views + + if defaultview is not None and not isinstance(defaultview, Views): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: Views', None, None) + + self.__defaultview = defaultview + self.__key_modified['_default_view'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/modules.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/modules.py new file mode 100644 index 0000000..bc50f54 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/modules.py @@ -0,0 +1,284 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__id = None + self.__plural_label = None + self.__shared_type = None + self.__api_name = None + self.__filters = None + self.__fields = None + self.__layouts = None + self.__views = None + self.__permissions = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_shared_type(self): + """ + The method to get the shared_type + + Returns: + string: A string representing the shared_type + """ + + return self.__shared_type + + def set_shared_type(self, shared_type): + """ + The method to set the value to shared_type + + Parameters: + shared_type (string) : A string representing the shared_type + """ + + if shared_type is not None and not isinstance(shared_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_type EXPECTED TYPE: str', None, None) + + self.__shared_type = shared_type + self.__key_modified['shared_type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_filters(self): + """ + The method to get the filters + + Returns: + list: An instance of list + """ + + return self.__filters + + def set_filters(self, filters): + """ + The method to set the value to filters + + Parameters: + filters (list) : An instance of list + """ + + if filters is not None and not isinstance(filters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: list', None, None) + + self.__filters = filters + self.__key_modified['filters'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_views(self): + """ + The method to get the views + + Returns: + Views: An instance of Views + """ + + return self.__views + + def set_views(self, views): + """ + The method to set the value to views + + Parameters: + views (Views) : An instance of Views + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.views import Views + except Exception: + from .views import Views + + if views is not None and not isinstance(views, Views): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: views EXPECTED TYPE: Views', None, None) + + self.__views = views + self.__key_modified['views'] = 1 + + def get_permissions(self): + """ + The method to get the permissions + + Returns: + Permissions: An instance of Permissions + """ + + return self.__permissions + + def set_permissions(self, permissions): + """ + The method to set the value to permissions + + Parameters: + permissions (Permissions) : An instance of Permissions + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.permissions import Permissions + except Exception: + from .permissions import Permissions + + if permissions is not None and not isinstance(permissions, Permissions): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions EXPECTED TYPE: Permissions', None, None) + + self.__permissions = permissions + self.__key_modified['permissions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/owner.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/permissions.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/permissions.py new file mode 100644 index 0000000..0cac9cd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/permissions.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Permissions(object): + def __init__(self): + """Creates an instance of Permissions""" + + self.__view = None + self.__edit = None + self.__edit_shared_records = None + self.__create = None + self.__delete = None + self.__delete_attachment = None + self.__create_attachment = None + self.__key_modified = dict() + + def get_view(self): + """ + The method to get the view + + Returns: + bool: A bool representing the view + """ + + return self.__view + + def set_view(self, view): + """ + The method to set the value to view + + Parameters: + view (bool) : A bool representing the view + """ + + if view is not None and not isinstance(view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: view EXPECTED TYPE: bool', None, None) + + self.__view = view + self.__key_modified['view'] = 1 + + def get_edit(self): + """ + The method to get the edit + + Returns: + bool: A bool representing the edit + """ + + return self.__edit + + def set_edit(self, edit): + """ + The method to set the value to edit + + Parameters: + edit (bool) : A bool representing the edit + """ + + if edit is not None and not isinstance(edit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit EXPECTED TYPE: bool', None, None) + + self.__edit = edit + self.__key_modified['edit'] = 1 + + def get_edit_shared_records(self): + """ + The method to get the edit_shared_records + + Returns: + bool: A bool representing the edit_shared_records + """ + + return self.__edit_shared_records + + def set_edit_shared_records(self, edit_shared_records): + """ + The method to set the value to edit_shared_records + + Parameters: + edit_shared_records (bool) : A bool representing the edit_shared_records + """ + + if edit_shared_records is not None and not isinstance(edit_shared_records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: edit_shared_records EXPECTED TYPE: bool', None, None) + + self.__edit_shared_records = edit_shared_records + self.__key_modified['edit_shared_records'] = 1 + + def get_create(self): + """ + The method to get the create + + Returns: + bool: A bool representing the create + """ + + return self.__create + + def set_create(self, create): + """ + The method to set the value to create + + Parameters: + create (bool) : A bool representing the create + """ + + if create is not None and not isinstance(create, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create EXPECTED TYPE: bool', None, None) + + self.__create = create + self.__key_modified['create'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['delete'] = 1 + + def get_delete_attachment(self): + """ + The method to get the delete_attachment + + Returns: + bool: A bool representing the delete_attachment + """ + + return self.__delete_attachment + + def set_delete_attachment(self, delete_attachment): + """ + The method to set the value to delete_attachment + + Parameters: + delete_attachment (bool) : A bool representing the delete_attachment + """ + + if delete_attachment is not None and not isinstance(delete_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete_attachment EXPECTED TYPE: bool', None, None) + + self.__delete_attachment = delete_attachment + self.__key_modified['delete_attachment'] = 1 + + def get_create_attachment(self): + """ + The method to get the create_attachment + + Returns: + bool: A bool representing the create_attachment + """ + + return self.__create_attachment + + def set_create_attachment(self, create_attachment): + """ + The method to set the value to create_attachment + + Parameters: + create_attachment (bool) : A bool representing the create_attachment + """ + + if create_attachment is not None and not isinstance(create_attachment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create_attachment EXPECTED TYPE: bool', None, None) + + self.__create_attachment = create_attachment + self.__key_modified['create_attachment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/personality_module.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/personality_module.py new file mode 100644 index 0000000..234efeb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/personality_module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PersonalityModule(object): + def __init__(self): + """Creates an instance of PersonalityModule""" + + self.__api_name = None + self.__id = None + self.__plural_label = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/portal_user_type_operations.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/portal_user_type_operations.py new file mode 100644 index 0000000..0c7d155 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/portal_user_type_operations.py @@ -0,0 +1,212 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class PortalUserTypeOperations(object): + def __init__(self, portal): + """ + Creates an instance of PortalUserTypeOperations with the given parameters + + Parameters: + portal (string) : A string representing the portal + """ + + if not isinstance(portal, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal EXPECTED TYPE: str', None, None) + + self.__portal = portal + + + def get_user_types(self, param_instance=None): + """ + The method to get user types + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_user_type(self, request): + """ + The method to create user type + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_user_type(self, user_type_id): + """ + The method to get user type + + Parameters: + user_type_id (string) : A string representing the user_type_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user_type_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type/' + api_path = api_path + str(user_type_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_user_type(self, user_type_id, request): + """ + The method to update user type + + Parameters: + user_type_id (string) : A string representing the user_type_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(user_type_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: str', 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/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type/' + api_path = api_path + str(user_type_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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_user_type(self, user_type_id): + """ + The method to delete user type + + Parameters: + user_type_id (string) : A string representing the user_type_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user_type_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals/' + api_path = api_path + str(self.__portal) + api_path = api_path + '/user_type/' + api_path = api_path + str(user_type_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetUserTypesParam(object): + include = Param('include', 'com.zoho.crm.api.PortalUserType.GetUserTypesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_wrapper.py new file mode 100644 index 0000000..6f42258 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__user_type = None + self.__key_modified = dict() + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + list: An instance of list + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (list) : An instance of list + """ + + if user_type is not None and not isinstance(user_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: list', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/success_response.py new file mode 100644 index 0000000..236fc01 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/user_type.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/user_type.py new file mode 100644 index 0000000..71c0f9c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/user_type.py @@ -0,0 +1,343 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UserType(object): + def __init__(self): + """Creates an instance of UserType""" + + self.__personality_module = None + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__created_by = None + self.__name = None + self.__active = None + self.__default = None + self.__no_of_users = None + self.__id = None + self.__modules = None + self.__key_modified = dict() + + def get_personality_module(self): + """ + The method to get the personality_module + + Returns: + PersonalityModule: An instance of PersonalityModule + """ + + return self.__personality_module + + def set_personality_module(self, personality_module): + """ + The method to set the value to personality_module + + Parameters: + personality_module (PersonalityModule) : An instance of PersonalityModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.personality_module import PersonalityModule + except Exception: + from .personality_module import PersonalityModule + + if personality_module is not None and not isinstance(personality_module, PersonalityModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: personality_module EXPECTED TYPE: PersonalityModule', None, None) + + self.__personality_module = personality_module + self.__key_modified['personality_module'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portal_user_type.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_no_of_users(self): + """ + The method to get the no_of_users + + Returns: + int: An int representing the no_of_users + """ + + return self.__no_of_users + + def set_no_of_users(self, no_of_users): + """ + The method to set the value to no_of_users + + Parameters: + no_of_users (int) : An int representing the no_of_users + """ + + if no_of_users is not None and not isinstance(no_of_users, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: no_of_users EXPECTED TYPE: int', None, None) + + self.__no_of_users = no_of_users + self.__key_modified['no_of_users'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_modules(self): + """ + The method to get the modules + + Returns: + list: An instance of list + """ + + return self.__modules + + def set_modules(self, modules): + """ + The method to set the value to modules + + Parameters: + modules (list) : An instance of list + """ + + if modules is not None and not isinstance(modules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modules EXPECTED TYPE: list', None, None) + + self.__modules = modules + self.__key_modified['modules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/views.py b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/views.py new file mode 100644 index 0000000..29004af --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portal_user_type/views.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Views(object): + def __init__(self): + """Creates an instance of Views""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/portals/__init__.py new file mode 100644 index 0000000..e5a4788 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/__init__.py @@ -0,0 +1,11 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .portals_operations import PortalsOperations +from .success_response import SuccessResponse +from .portals import Portals +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/portals/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/portals/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portals/action_wrapper.py new file mode 100644 index 0000000..b492d5b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__portals = None + self.__key_modified = dict() + + def get_portals(self): + """ + The method to get the portals + + Returns: + list: An instance of list + """ + + return self.__portals + + def set_portals(self, portals): + """ + The method to set the value to portals + + Parameters: + portals (list) : An instance of list + """ + + if portals is not None and not isinstance(portals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portals EXPECTED TYPE: list', None, None) + + self.__portals = portals + self.__key_modified['portals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/portals/api_exception.py new file mode 100644 index 0000000..e1d7d55 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portals/body_wrapper.py new file mode 100644 index 0000000..11039bc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__portals = None + self.__key_modified = dict() + + def get_portals(self): + """ + The method to get the portals + + Returns: + list: An instance of list + """ + + return self.__portals + + def set_portals(self, portals): + """ + The method to set the value to portals + + Parameters: + portals (list) : An instance of list + """ + + if portals is not None and not isinstance(portals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portals EXPECTED TYPE: list', None, None) + + self.__portals = portals + self.__key_modified['portals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/owner.py b/zohocrmsdk/src/com/zoho/crm/api/portals/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/portals.py b/zohocrmsdk/src/com/zoho/crm/api/portals/portals.py new file mode 100644 index 0000000..c7c6c19 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/portals.py @@ -0,0 +1,238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Portals(object): + def __init__(self): + """Creates an instance of Portals""" + + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__created_by = None + self.__zaid = None + self.__name = None + self.__active = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_zaid(self): + """ + The method to get the zaid + + Returns: + string: A string representing the zaid + """ + + return self.__zaid + + def set_zaid(self, zaid): + """ + The method to set the value to zaid + + Parameters: + zaid (string) : A string representing the zaid + """ + + if zaid is not None and not isinstance(zaid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zaid EXPECTED TYPE: str', None, None) + + self.__zaid = zaid + self.__key_modified['zaid'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/portals_operations.py b/zohocrmsdk/src/com/zoho/crm/api/portals/portals_operations.py new file mode 100644 index 0000000..d05fb1c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/portals_operations.py @@ -0,0 +1,144 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class PortalsOperations(object): + def __init__(self): + """Creates an instance of PortalsOperations""" + pass + + def get_portals(self): + """ + The method to get portals + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_portal(self, request): + """ + The method to create portal + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/portals' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_portal(self, portal_name): + """ + The method to get portal + + Parameters: + portal_name (string) : A string representing the portal_name + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(portal_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_name EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/portals/' + api_path = api_path + str(portal_name) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_portal(self, portal_name, request): + """ + The method to update portal + + Parameters: + portal_name (string) : A string representing the portal_name + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(portal_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_name EXPECTED TYPE: str', 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/v7/settings/portals/' + api_path = api_path + str(portal_name) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.portals.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/portals/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portals/response_wrapper.py new file mode 100644 index 0000000..954b450 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__portals = None + self.__key_modified = dict() + + def get_portals(self): + """ + The method to get the portals + + Returns: + list: An instance of list + """ + + return self.__portals + + def set_portals(self, portals): + """ + The method to set the value to portals + + Parameters: + portals (list) : An instance of list + """ + + if portals is not None and not isinstance(portals, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portals EXPECTED TYPE: list', None, None) + + self.__portals = portals + self.__key_modified['portals'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/portals/success_response.py new file mode 100644 index 0000000..717e097 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.portals.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/__init__.py new file mode 100644 index 0000000..8a4366a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/__init__.py @@ -0,0 +1,6 @@ +from .related_lists import RelatedLists +from .wrapper import Wrapper +from .filters import Filters +from .layouts import Layouts +from .views import Views +from .modules import Modules diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/filters.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/filters.py new file mode 100644 index 0000000..b232969 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/filters.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Filters(object): + def __init__(self): + """Creates an instance of Filters""" + + self.__display_label = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/layouts.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/layouts.py new file mode 100644 index 0000000..244f14d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/layouts.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layouts(object): + def __init__(self): + """Creates an instance of Layouts""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/modules.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/modules.py new file mode 100644 index 0000000..41d7cbe --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/modules.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Modules(object): + def __init__(self): + """Creates an instance of Modules""" + + self.__plural_label = None + self.__shared_type = None + self.__api_name = None + self.__id = None + self.__filters = None + self.__layouts = None + self.__views = None + self.__key_modified = dict() + + def get_plural_label(self): + """ + The method to get the plural_label + + Returns: + string: A string representing the plural_label + """ + + return self.__plural_label + + def set_plural_label(self, plural_label): + """ + The method to set the value to plural_label + + Parameters: + plural_label (string) : A string representing the plural_label + """ + + if plural_label is not None and not isinstance(plural_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: plural_label EXPECTED TYPE: str', None, None) + + self.__plural_label = plural_label + self.__key_modified['plural_label'] = 1 + + def get_shared_type(self): + """ + The method to get the shared_type + + Returns: + string: A string representing the shared_type + """ + + return self.__shared_type + + def set_shared_type(self, shared_type): + """ + The method to set the value to shared_type + + Parameters: + shared_type (string) : A string representing the shared_type + """ + + if shared_type is not None and not isinstance(shared_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_type EXPECTED TYPE: str', None, None) + + self.__shared_type = shared_type + self.__key_modified['shared_type'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_filters(self): + """ + The method to get the filters + + Returns: + list: An instance of list + """ + + return self.__filters + + def set_filters(self, filters): + """ + The method to set the value to filters + + Parameters: + filters (list) : An instance of list + """ + + if filters is not None and not isinstance(filters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: list', None, None) + + self.__filters = filters + self.__key_modified['filters'] = 1 + + def get_layouts(self): + """ + The method to get the layouts + + Returns: + list: An instance of list + """ + + return self.__layouts + + def set_layouts(self, layouts): + """ + The method to set the value to layouts + + Parameters: + layouts (list) : An instance of list + """ + + if layouts is not None and not isinstance(layouts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layouts EXPECTED TYPE: list', None, None) + + self.__layouts = layouts + self.__key_modified['layouts'] = 1 + + def get_views(self): + """ + The method to get the views + + Returns: + list: An instance of list + """ + + return self.__views + + def set_views(self, views): + """ + The method to set the value to views + + Parameters: + views (list) : An instance of list + """ + + if views is not None and not isinstance(views, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: views EXPECTED TYPE: list', None, None) + + self.__views = views + self.__key_modified['views'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/related_lists.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/related_lists.py new file mode 100644 index 0000000..abaea27 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/related_lists.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedLists(object): + def __init__(self): + """Creates an instance of RelatedLists""" + + self.__module = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Modules: An instance of Modules + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.portals_meta.modules import Modules + except Exception: + from .modules import Modules + + if module is not None and not isinstance(module, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Modules', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/views.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/views.py new file mode 100644 index 0000000..29004af --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/views.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Views(object): + def __init__(self): + """Creates an instance of Views""" + + self.__display_label = None + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/portals_meta/wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/wrapper.py new file mode 100644 index 0000000..68063bb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/portals_meta/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__related_lists = None + self.__key_modified = dict() + + def get_related_lists(self): + """ + The method to get the related_lists + + Returns: + list: An instance of list + """ + + return self.__related_lists + + def set_related_lists(self, related_lists): + """ + The method to set the value to related_lists + + Parameters: + related_lists (list) : An instance of list + """ + + if related_lists is not None and not isinstance(related_lists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_lists EXPECTED TYPE: list', None, None) + + self.__related_lists = related_lists + self.__key_modified['related_lists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/__init__.py new file mode 100644 index 0000000..853cf3d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/__init__.py @@ -0,0 +1,2 @@ +from .wrapper import Wrapper +from .apps import Apps diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/apps.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/apps.py new file mode 100644 index 0000000..e396575 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/apps.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Apps(object): + def __init__(self): + """Creates an instance of Apps""" + + self.__name = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/wrapper.py new file mode 100644 index 0000000..3953f43 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_configurable_apps/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__privacy_configurable_apps = None + self.__key_modified = dict() + + def get_privacy_configurable_apps(self): + """ + The method to get the privacy_configurable_apps + + Returns: + list: An instance of list + """ + + return self.__privacy_configurable_apps + + def set_privacy_configurable_apps(self, privacy_configurable_apps): + """ + The method to set the value to privacy_configurable_apps + + Parameters: + privacy_configurable_apps (list) : An instance of list + """ + + if privacy_configurable_apps is not None and not isinstance(privacy_configurable_apps, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacy_configurable_apps EXPECTED TYPE: list', None, None) + + self.__privacy_configurable_apps = privacy_configurable_apps + self.__key_modified['privacy_configurable_apps'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/__init__.py new file mode 100644 index 0000000..7f71e2c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/__init__.py @@ -0,0 +1,7 @@ +from .privacy_preference import PrivacyPreference +from .preference import Preference +from .tpt import Tpt +from .wrapper import Wrapper +from .section import Section +from .config import Config +from .option import Option diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/config.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/config.py new file mode 100644 index 0000000..32418d2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/config.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Config(object): + def __init__(self): + """Creates an instance of Config""" + + self.__tpt = None + self.__section = None + self.__zoho_integ = None + self.__key_modified = dict() + + def get_tpt(self): + """ + The method to get the tpt + + Returns: + list: An instance of list + """ + + return self.__tpt + + def set_tpt(self, tpt): + """ + The method to set the value to tpt + + Parameters: + tpt (list) : An instance of list + """ + + if tpt is not None and not isinstance(tpt, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tpt EXPECTED TYPE: list', None, None) + + self.__tpt = tpt + self.__key_modified['tpt'] = 1 + + def get_section(self): + """ + The method to get the section + + Returns: + list: An instance of list + """ + + return self.__section + + def set_section(self, section): + """ + The method to set the value to section + + Parameters: + section (list) : An instance of list + """ + + if section is not None and not isinstance(section, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: section EXPECTED TYPE: list', None, None) + + self.__section = section + self.__key_modified['section'] = 1 + + def get_zoho_integ(self): + """ + The method to get the zoho_integ + + Returns: + list: An instance of list + """ + + return self.__zoho_integ + + def set_zoho_integ(self, zoho_integ): + """ + The method to set the value to zoho_integ + + Parameters: + zoho_integ (list) : An instance of list + """ + + if zoho_integ is not None and not isinstance(zoho_integ, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zoho_integ EXPECTED TYPE: list', None, None) + + self.__zoho_integ = zoho_integ + self.__key_modified['zoho_integ'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/option.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/option.py new file mode 100644 index 0000000..cbaddf0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/option.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Option(object): + def __init__(self): + """Creates an instance of Option""" + + self.__name = None + self.__tooltip = None + self.__type = None + self.__suboptions = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + string: A string representing the tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (string) : A string representing the tooltip + """ + + if tooltip is not None and not isinstance(tooltip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: str', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_suboptions(self): + """ + The method to get the suboptions + + Returns: + list: An instance of list + """ + + return self.__suboptions + + def set_suboptions(self, suboptions): + """ + The method to set the value to suboptions + + Parameters: + suboptions (list) : An instance of list + """ + + if suboptions is not None and not isinstance(suboptions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suboptions EXPECTED TYPE: list', None, None) + + self.__suboptions = suboptions + self.__key_modified['suboptions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/preference.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/preference.py new file mode 100644 index 0000000..3fe96d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/preference.py @@ -0,0 +1,599 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Preference(object): + def __init__(self): + """Creates an instance of Preference""" + + self.__consent_modules = None + self.__restrict_tpt_fields = None + self.__exclude_api_zoho = None + self.__awaiting_period = None + self.__consent_mail_send = None + self.__exclude_export_fields = None + self.__limit_actions = None + self.__exclude_export = None + self.__restrict_zoho_integ = None + self.__exclude_api_zoho_fields = None + self.__duration_timing = None + self.__data_processing_duration = None + self.__restrict_tpt_services = None + self.__exclude_api_tpt_fields = None + self.__restrict_zoho_integ_services = None + self.__privacy_setting_status = None + self.__double_opt_in = None + self.__restrict_zoho_integ_fields = None + self.__exclude_api_tpt = None + self.__block_list = None + self.__restrict_tpt = None + self.__actions_while_awaiting = None + self.__key_modified = dict() + + def get_consent_modules(self): + """ + The method to get the consent_modules + + Returns: + string: A string representing the consent_modules + """ + + return self.__consent_modules + + def set_consent_modules(self, consent_modules): + """ + The method to set the value to consent_modules + + Parameters: + consent_modules (string) : A string representing the consent_modules + """ + + if consent_modules is not None and not isinstance(consent_modules, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_modules EXPECTED TYPE: str', None, None) + + self.__consent_modules = consent_modules + self.__key_modified['consent_modules'] = 1 + + def get_restrict_tpt_fields(self): + """ + The method to get the restrict_tpt_fields + + Returns: + string: A string representing the restrict_tpt_fields + """ + + return self.__restrict_tpt_fields + + def set_restrict_tpt_fields(self, restrict_tpt_fields): + """ + The method to set the value to restrict_tpt_fields + + Parameters: + restrict_tpt_fields (string) : A string representing the restrict_tpt_fields + """ + + if restrict_tpt_fields is not None and not isinstance(restrict_tpt_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_tpt_fields EXPECTED TYPE: str', None, None) + + self.__restrict_tpt_fields = restrict_tpt_fields + self.__key_modified['restrict_tpt_fields'] = 1 + + def get_exclude_api_zoho(self): + """ + The method to get the exclude_api_zoho + + Returns: + string: A string representing the exclude_api_zoho + """ + + return self.__exclude_api_zoho + + def set_exclude_api_zoho(self, exclude_api_zoho): + """ + The method to set the value to exclude_api_zoho + + Parameters: + exclude_api_zoho (string) : A string representing the exclude_api_zoho + """ + + if exclude_api_zoho is not None and not isinstance(exclude_api_zoho, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_zoho EXPECTED TYPE: str', None, None) + + self.__exclude_api_zoho = exclude_api_zoho + self.__key_modified['exclude_api_zoho'] = 1 + + def get_awaiting_period(self): + """ + The method to get the awaiting_period + + Returns: + string: A string representing the awaiting_period + """ + + return self.__awaiting_period + + def set_awaiting_period(self, awaiting_period): + """ + The method to set the value to awaiting_period + + Parameters: + awaiting_period (string) : A string representing the awaiting_period + """ + + if awaiting_period is not None and not isinstance(awaiting_period, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: awaiting_period EXPECTED TYPE: str', None, None) + + self.__awaiting_period = awaiting_period + self.__key_modified['awaiting_period'] = 1 + + def get_consent_mail_send(self): + """ + The method to get the consent_mail_send + + Returns: + string: A string representing the consent_mail_send + """ + + return self.__consent_mail_send + + def set_consent_mail_send(self, consent_mail_send): + """ + The method to set the value to consent_mail_send + + Parameters: + consent_mail_send (string) : A string representing the consent_mail_send + """ + + if consent_mail_send is not None and not isinstance(consent_mail_send, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_mail_send EXPECTED TYPE: str', None, None) + + self.__consent_mail_send = consent_mail_send + self.__key_modified['consent_mail_send'] = 1 + + def get_exclude_export_fields(self): + """ + The method to get the exclude_export_fields + + Returns: + string: A string representing the exclude_export_fields + """ + + return self.__exclude_export_fields + + def set_exclude_export_fields(self, exclude_export_fields): + """ + The method to set the value to exclude_export_fields + + Parameters: + exclude_export_fields (string) : A string representing the exclude_export_fields + """ + + if exclude_export_fields is not None and not isinstance(exclude_export_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_export_fields EXPECTED TYPE: str', None, None) + + self.__exclude_export_fields = exclude_export_fields + self.__key_modified['exclude_export_fields'] = 1 + + def get_limit_actions(self): + """ + The method to get the limit_actions + + Returns: + string: A string representing the limit_actions + """ + + return self.__limit_actions + + def set_limit_actions(self, limit_actions): + """ + The method to set the value to limit_actions + + Parameters: + limit_actions (string) : A string representing the limit_actions + """ + + if limit_actions is not None and not isinstance(limit_actions, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: limit_actions EXPECTED TYPE: str', None, None) + + self.__limit_actions = limit_actions + self.__key_modified['limit_actions'] = 1 + + def get_exclude_export(self): + """ + The method to get the exclude_export + + Returns: + string: A string representing the exclude_export + """ + + return self.__exclude_export + + def set_exclude_export(self, exclude_export): + """ + The method to set the value to exclude_export + + Parameters: + exclude_export (string) : A string representing the exclude_export + """ + + if exclude_export is not None and not isinstance(exclude_export, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_export EXPECTED TYPE: str', None, None) + + self.__exclude_export = exclude_export + self.__key_modified['exclude_export'] = 1 + + def get_restrict_zoho_integ(self): + """ + The method to get the restrict_zoho_integ + + Returns: + string: A string representing the restrict_zoho_integ + """ + + return self.__restrict_zoho_integ + + def set_restrict_zoho_integ(self, restrict_zoho_integ): + """ + The method to set the value to restrict_zoho_integ + + Parameters: + restrict_zoho_integ (string) : A string representing the restrict_zoho_integ + """ + + if restrict_zoho_integ is not None and not isinstance(restrict_zoho_integ, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_zoho_integ EXPECTED TYPE: str', None, None) + + self.__restrict_zoho_integ = restrict_zoho_integ + self.__key_modified['restrict_zoho_integ'] = 1 + + def get_exclude_api_zoho_fields(self): + """ + The method to get the exclude_api_zoho_fields + + Returns: + string: A string representing the exclude_api_zoho_fields + """ + + return self.__exclude_api_zoho_fields + + def set_exclude_api_zoho_fields(self, exclude_api_zoho_fields): + """ + The method to set the value to exclude_api_zoho_fields + + Parameters: + exclude_api_zoho_fields (string) : A string representing the exclude_api_zoho_fields + """ + + if exclude_api_zoho_fields is not None and not isinstance(exclude_api_zoho_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_zoho_fields EXPECTED TYPE: str', None, None) + + self.__exclude_api_zoho_fields = exclude_api_zoho_fields + self.__key_modified['exclude_api_zoho_fields'] = 1 + + def get_duration_timing(self): + """ + The method to get the duration_timing + + Returns: + string: A string representing the duration_timing + """ + + return self.__duration_timing + + def set_duration_timing(self, duration_timing): + """ + The method to set the value to duration_timing + + Parameters: + duration_timing (string) : A string representing the duration_timing + """ + + if duration_timing is not None and not isinstance(duration_timing, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duration_timing EXPECTED TYPE: str', None, None) + + self.__duration_timing = duration_timing + self.__key_modified['duration_timing'] = 1 + + def get_data_processing_duration(self): + """ + The method to get the data_processing_duration + + Returns: + string: A string representing the data_processing_duration + """ + + return self.__data_processing_duration + + def set_data_processing_duration(self, data_processing_duration): + """ + The method to set the value to data_processing_duration + + Parameters: + data_processing_duration (string) : A string representing the data_processing_duration + """ + + if data_processing_duration is not None and not isinstance(data_processing_duration, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_processing_duration EXPECTED TYPE: str', None, None) + + self.__data_processing_duration = data_processing_duration + self.__key_modified['data_processing_duration'] = 1 + + def get_restrict_tpt_services(self): + """ + The method to get the restrict_tpt_services + + Returns: + string: A string representing the restrict_tpt_services + """ + + return self.__restrict_tpt_services + + def set_restrict_tpt_services(self, restrict_tpt_services): + """ + The method to set the value to restrict_tpt_services + + Parameters: + restrict_tpt_services (string) : A string representing the restrict_tpt_services + """ + + if restrict_tpt_services is not None and not isinstance(restrict_tpt_services, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_tpt_services EXPECTED TYPE: str', None, None) + + self.__restrict_tpt_services = restrict_tpt_services + self.__key_modified['restrict_tpt_services'] = 1 + + def get_exclude_api_tpt_fields(self): + """ + The method to get the exclude_api_tpt_fields + + Returns: + string: A string representing the exclude_api_tpt_fields + """ + + return self.__exclude_api_tpt_fields + + def set_exclude_api_tpt_fields(self, exclude_api_tpt_fields): + """ + The method to set the value to exclude_api_tpt_fields + + Parameters: + exclude_api_tpt_fields (string) : A string representing the exclude_api_tpt_fields + """ + + if exclude_api_tpt_fields is not None and not isinstance(exclude_api_tpt_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_tpt_fields EXPECTED TYPE: str', None, None) + + self.__exclude_api_tpt_fields = exclude_api_tpt_fields + self.__key_modified['exclude_api_tpt_fields'] = 1 + + def get_restrict_zoho_integ_services(self): + """ + The method to get the restrict_zoho_integ_services + + Returns: + string: A string representing the restrict_zoho_integ_services + """ + + return self.__restrict_zoho_integ_services + + def set_restrict_zoho_integ_services(self, restrict_zoho_integ_services): + """ + The method to set the value to restrict_zoho_integ_services + + Parameters: + restrict_zoho_integ_services (string) : A string representing the restrict_zoho_integ_services + """ + + if restrict_zoho_integ_services is not None and not isinstance(restrict_zoho_integ_services, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_zoho_integ_services EXPECTED TYPE: str', None, None) + + self.__restrict_zoho_integ_services = restrict_zoho_integ_services + self.__key_modified['restrict_zoho_integ_services'] = 1 + + def get_privacy_setting_status(self): + """ + The method to get the privacy_setting_status + + Returns: + string: A string representing the privacy_setting_status + """ + + return self.__privacy_setting_status + + def set_privacy_setting_status(self, privacy_setting_status): + """ + The method to set the value to privacy_setting_status + + Parameters: + privacy_setting_status (string) : A string representing the privacy_setting_status + """ + + if privacy_setting_status is not None and not isinstance(privacy_setting_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacy_setting_status EXPECTED TYPE: str', None, None) + + self.__privacy_setting_status = privacy_setting_status + self.__key_modified['privacy_setting_status'] = 1 + + def get_double_opt_in(self): + """ + The method to get the double_opt_in + + Returns: + string: A string representing the double_opt_in + """ + + return self.__double_opt_in + + def set_double_opt_in(self, double_opt_in): + """ + The method to set the value to double_opt_in + + Parameters: + double_opt_in (string) : A string representing the double_opt_in + """ + + if double_opt_in is not None and not isinstance(double_opt_in, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: double_opt_in EXPECTED TYPE: str', None, None) + + self.__double_opt_in = double_opt_in + self.__key_modified['double_opt_in'] = 1 + + def get_restrict_zoho_integ_fields(self): + """ + The method to get the restrict_zoho_integ_fields + + Returns: + string: A string representing the restrict_zoho_integ_fields + """ + + return self.__restrict_zoho_integ_fields + + def set_restrict_zoho_integ_fields(self, restrict_zoho_integ_fields): + """ + The method to set the value to restrict_zoho_integ_fields + + Parameters: + restrict_zoho_integ_fields (string) : A string representing the restrict_zoho_integ_fields + """ + + if restrict_zoho_integ_fields is not None and not isinstance(restrict_zoho_integ_fields, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_zoho_integ_fields EXPECTED TYPE: str', None, None) + + self.__restrict_zoho_integ_fields = restrict_zoho_integ_fields + self.__key_modified['restrict_zoho_integ_fields'] = 1 + + def get_exclude_api_tpt(self): + """ + The method to get the exclude_api_tpt + + Returns: + string: A string representing the exclude_api_tpt + """ + + return self.__exclude_api_tpt + + def set_exclude_api_tpt(self, exclude_api_tpt): + """ + The method to set the value to exclude_api_tpt + + Parameters: + exclude_api_tpt (string) : A string representing the exclude_api_tpt + """ + + if exclude_api_tpt is not None and not isinstance(exclude_api_tpt, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_api_tpt EXPECTED TYPE: str', None, None) + + self.__exclude_api_tpt = exclude_api_tpt + self.__key_modified['exclude_api_tpt'] = 1 + + def get_block_list(self): + """ + The method to get the block_list + + Returns: + string: A string representing the block_list + """ + + return self.__block_list + + def set_block_list(self, block_list): + """ + The method to set the value to block_list + + Parameters: + block_list (string) : A string representing the block_list + """ + + if block_list is not None and not isinstance(block_list, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: block_list EXPECTED TYPE: str', None, None) + + self.__block_list = block_list + self.__key_modified['block_list'] = 1 + + def get_restrict_tpt(self): + """ + The method to get the restrict_tpt + + Returns: + string: A string representing the restrict_tpt + """ + + return self.__restrict_tpt + + def set_restrict_tpt(self, restrict_tpt): + """ + The method to set the value to restrict_tpt + + Parameters: + restrict_tpt (string) : A string representing the restrict_tpt + """ + + if restrict_tpt is not None and not isinstance(restrict_tpt, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restrict_tpt EXPECTED TYPE: str', None, None) + + self.__restrict_tpt = restrict_tpt + self.__key_modified['restrict_tpt'] = 1 + + def get_actions_while_awaiting(self): + """ + The method to get the actions_while_awaiting + + Returns: + string: A string representing the actions_while_awaiting + """ + + return self.__actions_while_awaiting + + def set_actions_while_awaiting(self, actions_while_awaiting): + """ + The method to set the value to actions_while_awaiting + + Parameters: + actions_while_awaiting (string) : A string representing the actions_while_awaiting + """ + + if actions_while_awaiting is not None and not isinstance(actions_while_awaiting, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actions_while_awaiting EXPECTED TYPE: str', None, None) + + self.__actions_while_awaiting = actions_while_awaiting + self.__key_modified['actions_while_awaiting'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/privacy_preference.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/privacy_preference.py new file mode 100644 index 0000000..360e5f7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/privacy_preference.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PrivacyPreference(object): + def __init__(self): + """Creates an instance of PrivacyPreference""" + + self.__preference = None + self.__config = None + self.__key_modified = dict() + + def get_preference(self): + """ + The method to get the preference + + Returns: + Preference: An instance of Preference + """ + + return self.__preference + + def set_preference(self, preference): + """ + The method to set the value to preference + + Parameters: + preference (Preference) : An instance of Preference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.privacy_preference.preference import Preference + except Exception: + from .preference import Preference + + if preference is not None and not isinstance(preference, Preference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preference EXPECTED TYPE: Preference', None, None) + + self.__preference = preference + self.__key_modified['preference'] = 1 + + def get_config(self): + """ + The method to get the config + + Returns: + Config: An instance of Config + """ + + return self.__config + + def set_config(self, config): + """ + The method to set the value to config + + Parameters: + config (Config) : An instance of Config + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.privacy_preference.config import Config + except Exception: + from .config import Config + + if config is not None and not isinstance(config, Config): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: config EXPECTED TYPE: Config', None, None) + + self.__config = config + self.__key_modified['config'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/section.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/section.py new file mode 100644 index 0000000..a003ea9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/section.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Section(object): + def __init__(self): + """Creates an instance of Section""" + + self.__name = None + self.__tooltip = None + self.__show_type = None + self.__title = None + self.__options = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_tooltip(self): + """ + The method to get the tooltip + + Returns: + string: A string representing the tooltip + """ + + return self.__tooltip + + def set_tooltip(self, tooltip): + """ + The method to set the value to tooltip + + Parameters: + tooltip (string) : A string representing the tooltip + """ + + if tooltip is not None and not isinstance(tooltip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tooltip EXPECTED TYPE: str', None, None) + + self.__tooltip = tooltip + self.__key_modified['tooltip'] = 1 + + def get_show_type(self): + """ + The method to get the show_type + + Returns: + string: A string representing the show_type + """ + + return self.__show_type + + def set_show_type(self, show_type): + """ + The method to set the value to show_type + + Parameters: + show_type (string) : A string representing the show_type + """ + + if show_type is not None and not isinstance(show_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_type EXPECTED TYPE: str', None, None) + + self.__show_type = show_type + self.__key_modified['show_type'] = 1 + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_options(self): + """ + The method to get the options + + Returns: + list: An instance of list + """ + + return self.__options + + def set_options(self, options): + """ + The method to set the value to options + + Parameters: + options (list) : An instance of list + """ + + if options is not None and not isinstance(options, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: options EXPECTED TYPE: list', None, None) + + self.__options = options + self.__key_modified['options'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/tpt.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/tpt.py new file mode 100644 index 0000000..ca0a8f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/tpt.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tpt(object): + def __init__(self): + """Creates an instance of Tpt""" + + self.__isenabled = None + self.__name = None + self.__issupported = None + self.__key_modified = dict() + + def get_isenabled(self): + """ + The method to get the isenabled + + Returns: + string: A string representing the isenabled + """ + + return self.__isenabled + + def set_isenabled(self, isenabled): + """ + The method to set the value to isenabled + + Parameters: + isenabled (string) : A string representing the isenabled + """ + + if isenabled is not None and not isinstance(isenabled, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isenabled EXPECTED TYPE: str', None, None) + + self.__isenabled = isenabled + self.__key_modified['isEnabled'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_issupported(self): + """ + The method to get the issupported + + Returns: + string: A string representing the issupported + """ + + return self.__issupported + + def set_issupported(self, issupported): + """ + The method to set the value to issupported + + Parameters: + issupported (string) : A string representing the issupported + """ + + if issupported is not None and not isinstance(issupported, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: issupported EXPECTED TYPE: str', None, None) + + self.__issupported = issupported + self.__key_modified['isSupported'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/wrapper.py new file mode 100644 index 0000000..6e155e7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/privacy_preference/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__privacypreference = None + self.__key_modified = dict() + + def get_privacypreference(self): + """ + The method to get the privacypreference + + Returns: + list: An instance of list + """ + + return self.__privacypreference + + def set_privacypreference(self, privacypreference): + """ + The method to set the value to privacypreference + + Parameters: + privacypreference (list) : An instance of list + """ + + if privacypreference is not None and not isinstance(privacypreference, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: privacypreference EXPECTED TYPE: list', None, None) + + self.__privacypreference = privacypreference + self.__key_modified['privacyPreference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/__init__.py new file mode 100644 index 0000000..51ffabd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .profile import Profile +from .section import Section +from .body_wrapper import BodyWrapper +from .category_others import CategoryOthers +from .permission_detail import PermissionDetail +from .minified_profile import MinifiedProfile +from .api_exception import APIException +from .profiles_operations import ProfilesOperations, GetProfilesParam, GetProfilesHeader, GetProfileHeader, DeleteProfileParam +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .category_module import CategoryModule +from .action_handler import ActionHandler +from .category import Category +from .default_view import DefaultView +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/action_wrapper.py new file mode 100644 index 0000000..7f7166b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__profiles = None + self.__key_modified = dict() + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/api_exception.py new file mode 100644 index 0000000..acb3f18 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/body_wrapper.py new file mode 100644 index 0000000..9c29c1d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__profiles = None + self.__key_modified = dict() + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/category.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/category.py new file mode 100644 index 0000000..58a0200 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/category.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class Category(ABC): + def __init__(self): + """Creates an instance of Category""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/category_module.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/category_module.py new file mode 100644 index 0000000..1aac312 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/category_module.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.category import Category +except Exception: + from ..exception import SDKException + from ..util import Constants + from .category import Category + + +class CategoryModule(Category): + def __init__(self): + """Creates an instance of CategoryModule""" + super().__init__() + + self.__display_label = None + self.__permissions_details = None + self.__name = None + self.__module = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_permissions_details(self): + """ + The method to get the permissions_details + + Returns: + list: An instance of list + """ + + return self.__permissions_details + + def set_permissions_details(self, permissions_details): + """ + The method to set the value to permissions_details + + Parameters: + permissions_details (list) : An instance of list + """ + + if permissions_details is not None and not isinstance(permissions_details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: list', None, None) + + self.__permissions_details = permissions_details + self.__key_modified['permissions_details'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/category_others.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/category_others.py new file mode 100644 index 0000000..e3e3ca2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/category_others.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.category import Category +except Exception: + from ..exception import SDKException + from ..util import Constants + from .category import Category + + +class CategoryOthers(Category): + def __init__(self): + """Creates an instance of CategoryOthers""" + super().__init__() + + self.__display_label = None + self.__permissions_details = None + self.__name = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_permissions_details(self): + """ + The method to get the permissions_details + + Returns: + list: An instance of list + """ + + return self.__permissions_details + + def set_permissions_details(self, permissions_details): + """ + The method to set the value to permissions_details + + Parameters: + permissions_details (list) : An instance of list + """ + + if permissions_details is not None and not isinstance(permissions_details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: list', None, None) + + self.__permissions_details = permissions_details + self.__key_modified['permissions_details'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/default_view.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/default_view.py new file mode 100644 index 0000000..49e724a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/default_view.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DefaultView(object): + def __init__(self): + """Creates an instance of DefaultView""" + + self.__name = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/info.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/info.py new file mode 100644 index 0000000..42190c7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/info.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__license_limit = None + self.__key_modified = dict() + + def get_license_limit(self): + """ + The method to get the license_limit + + Returns: + int: An int representing the license_limit + """ + + return self.__license_limit + + def set_license_limit(self, license_limit): + """ + The method to set the value to license_limit + + Parameters: + license_limit (int) : An int representing the license_limit + """ + + if license_limit is not None and not isinstance(license_limit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: license_limit EXPECTED TYPE: int', None, None) + + self.__license_limit = license_limit + self.__key_modified['license_limit'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/minified_profile.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/minified_profile.py new file mode 100644 index 0000000..185bfe0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/minified_profile.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedProfile(object): + def __init__(self): + """Creates an instance of MinifiedProfile""" + + self.__id = None + self.__name = None + self.__delete = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/permission_detail.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/permission_detail.py new file mode 100644 index 0000000..cd9108d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/permission_detail.py @@ -0,0 +1,224 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PermissionDetail(object): + def __init__(self): + """Creates an instance of PermissionDetail""" + + self.__id = None + self.__enabled = None + self.__name = None + self.__display_label = None + self.__customizable = None + self.__parent_permissions = None + self.__module = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_enabled(self): + """ + The method to get the enabled + + Returns: + bool: A bool representing the enabled + """ + + return self.__enabled + + def set_enabled(self, enabled): + """ + The method to set the value to enabled + + Parameters: + enabled (bool) : A bool representing the enabled + """ + + if enabled is not None and not isinstance(enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enabled EXPECTED TYPE: bool', None, None) + + self.__enabled = enabled + self.__key_modified['enabled'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_customizable(self): + """ + The method to get the customizable + + Returns: + bool: A bool representing the customizable + """ + + return self.__customizable + + def set_customizable(self, customizable): + """ + The method to set the value to customizable + + Parameters: + customizable (bool) : A bool representing the customizable + """ + + if customizable is not None and not isinstance(customizable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customizable EXPECTED TYPE: bool', None, None) + + self.__customizable = customizable + self.__key_modified['customizable'] = 1 + + def get_parent_permissions(self): + """ + The method to get the parent_permissions + + Returns: + list: An instance of list + """ + + return self.__parent_permissions + + def set_parent_permissions(self, parent_permissions): + """ + The method to set the value to parent_permissions + + Parameters: + parent_permissions (list) : An instance of list + """ + + if parent_permissions is not None and not isinstance(parent_permissions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_permissions EXPECTED TYPE: list', None, None) + + self.__parent_permissions = parent_permissions + self.__key_modified['parent_permissions'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/profile.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/profile.py new file mode 100644 index 0000000..5e662f2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/profile.py @@ -0,0 +1,493 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__defaultview = None + self.__name = None + self.__description = None + self.__id = None + self.__default = None + self.__delete = None + self.__permission_type = None + self.__custom = None + self.__display_label = None + self.__type = None + self.__permissions_details = None + self.__sections = None + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__category = None + self.__created_by = None + self.__key_modified = dict() + + def get_defaultview(self): + """ + The method to get the defaultview + + Returns: + DefaultView: An instance of DefaultView + """ + + return self.__defaultview + + def set_defaultview(self, defaultview): + """ + The method to set the value to defaultview + + Parameters: + defaultview (DefaultView) : An instance of DefaultView + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.default_view import DefaultView + except Exception: + from .default_view import DefaultView + + if defaultview is not None and not isinstance(defaultview, DefaultView): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: defaultview EXPECTED TYPE: DefaultView', None, None) + + self.__defaultview = defaultview + self.__key_modified['_default_view'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_default(self): + """ + The method to get the default + + Returns: + bool: A bool representing the default + """ + + return self.__default + + def set_default(self, default): + """ + The method to set the value to default + + Parameters: + default (bool) : A bool representing the default + """ + + if default is not None and not isinstance(default, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: default EXPECTED TYPE: bool', None, None) + + self.__default = default + self.__key_modified['default'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + string: A string representing the permission_type + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (string) : A string representing the permission_type + """ + + if permission_type is not None and not isinstance(permission_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: str', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def get_custom(self): + """ + The method to get the custom + + Returns: + bool: A bool representing the custom + """ + + return self.__custom + + def set_custom(self, custom): + """ + The method to set the value to custom + + Parameters: + custom (bool) : A bool representing the custom + """ + + if custom is not None and not isinstance(custom, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom EXPECTED TYPE: bool', None, None) + + self.__custom = custom + self.__key_modified['custom'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_permissions_details(self): + """ + The method to get the permissions_details + + Returns: + list: An instance of list + """ + + return self.__permissions_details + + def set_permissions_details(self, permissions_details): + """ + The method to set the value to permissions_details + + Parameters: + permissions_details (list) : An instance of list + """ + + if permissions_details is not None and not isinstance(permissions_details, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permissions_details EXPECTED TYPE: list', None, None) + + self.__permissions_details = permissions_details + self.__key_modified['permissions_details'] = 1 + + def get_sections(self): + """ + The method to get the sections + + Returns: + list: An instance of list + """ + + return self.__sections + + def set_sections(self, sections): + """ + The method to set the value to sections + + Parameters: + sections (list) : An instance of list + """ + + if sections is not None and not isinstance(sections, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sections EXPECTED TYPE: list', None, None) + + self.__sections = sections + self.__key_modified['sections'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + bool: A bool representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (bool) : A bool representing the category + """ + + if category is not None and not isinstance(category, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: bool', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/profiles_operations.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/profiles_operations.py new file mode 100644 index 0000000..559895d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/profiles_operations.py @@ -0,0 +1,219 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class ProfilesOperations(object): + def __init__(self): + """Creates an instance of ProfilesOperations""" + pass + + def get_profiles(self, param_instance=None): + """ + The method to get profiles + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/profiles' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def clone_profiles(self, id, request): + """ + The method to clone profiles + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/profiles/' + api_path = api_path + str(id) + api_path = api_path + '/actions/clone' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_profile(self, id, request): + """ + The method to update profile + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/profiles/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_profile(self, id): + """ + The method to get profile + + 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/v7/settings/profiles/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_profile(self, id, param_instance=None): + """ + The method to delete profile + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/profiles/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetProfilesParam(object): + include_lite_profile = Param('include_lite_profile', 'com.zoho.crm.api.Profiles.GetProfilesParam') + + +class GetProfilesHeader(object): + pass + + +class GetProfileHeader(object): + pass + + +class DeleteProfileParam(object): + transfer_to = Param('transfer_to', 'com.zoho.crm.api.Profiles.DeleteProfileParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/response_wrapper.py new file mode 100644 index 0000000..31cabb7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__profiles = None + self.__info = None + self.__key_modified = dict() + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.profiles.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/section.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/section.py new file mode 100644 index 0000000..0840f41 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/section.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Section(object): + def __init__(self): + """Creates an instance of Section""" + + self.__name = None + self.__categories = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_categories(self): + """ + The method to get the categories + + Returns: + list: An instance of list + """ + + return self.__categories + + def set_categories(self, categories): + """ + The method to set the value to categories + + Parameters: + categories (list) : An instance of list + """ + + if categories is not None and not isinstance(categories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: categories EXPECTED TYPE: list', None, None) + + self.__categories = categories + self.__key_modified['categories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/profiles/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/profiles/success_response.py new file mode 100644 index 0000000..deb52c4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/profiles/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.profiles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class SuccessResponse(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/record/__init__.py new file mode 100644 index 0000000..b6cd274 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/__init__.py @@ -0,0 +1,52 @@ +from .image_upload import ImageUpload +from .file_details import FileDetails +from .criteria import Criteria +from .record_operations import RecordOperations, GetRecordParam, GetRecordHeader, UpdateRecordHeader, DeleteRecordParam, DeleteRecordHeader, GetRecordsParam, GetRecordsHeader, CreateRecordsHeader, UpdateRecordsHeader, DeleteRecordsParam, DeleteRecordsHeader, UpsertRecordsHeader, GetDeletedRecordsParam, GetDeletedRecordsHeader, SearchRecordsParam, SearchRecordsHeader, UploadPhotoParam, GetMassUpdateStatusParam, RecordCountParam, GetRecordUsingExternalIDParam, GetRecordUsingExternalIDHeader, UpdateRecordUsingExternalIDHeader, DeleteRecordUsingExternalIDParam, DeleteRecordUsingExternalIDHeader +from .count_wrapper import CountWrapper +from .mass_update_response_wrapper import MassUpdateResponseWrapper +from .recurring_activity import RecurringActivity +from .record import Record +from .options import Options +from .download_handler import DownloadHandler +from .info import Info +from .tax import Tax +from .body_wrapper import BodyWrapper +from .consent import Consent +from .multi_select_lookup import MultiSelectLookup +from .line_item_product import LineItemProduct +from .field import Field +from .count_handler import CountHandler +from .mass_update_success_response import MassUpdateSuccessResponse +from .line_tax import LineTax +from .widget import Widget +from .deleted_record import DeletedRecord +from .duplicate_record import DuplicateRecord +from .pricing_details import PricingDetails +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .time_range import TimeRange +from .file_body_wrapper import FileBodyWrapper +from .success_response import SuccessResponse +from .mass_update_response import MassUpdateResponse +from .action_handler import ActionHandler +from .price_book import PriceBook +from .participants import Participants +from .action_wrapper import ActionWrapper +from .mass_update_action_wrapper import MassUpdateActionWrapper +from .reminder import Reminder +from .mass_update_action_handler import MassUpdateActionHandler +from .mass_update_body_wrapper import MassUpdateBodyWrapper +from .deleted_records_wrapper import DeletedRecordsWrapper +from .file_handler import FileHandler +from .remind_at import RemindAt +from .mass_update_action_response import MassUpdateActionResponse +from .deleted_records_handler import DeletedRecordsHandler +from .mass_update_territory import MassUpdateTerritory +from .mass_update_response_handler import MassUpdateResponseHandler +from .multi_select_picklist import MultiSelectPicklist +from .response_wrapper import ResponseWrapper +from .comment import Comment +from .wizard import Wizard +from .mass_update import MassUpdate +from .territory import Territory diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/record/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/action_wrapper.py new file mode 100644 index 0000000..fad9a72 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/record/api_exception.py new file mode 100644 index 0000000..d42d33b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/api_exception.py @@ -0,0 +1,172 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response_handler import MassUpdateResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_handler import MassUpdateActionHandler + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response import MassUpdateResponse + from zohocrmsdk.src.com.zoho.crm.api.record.count_handler import CountHandler + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.record.download_handler import DownloadHandler + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_response import MassUpdateActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record.deleted_records_handler import DeletedRecordsHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .mass_update_response_handler import MassUpdateResponseHandler + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .mass_update_action_handler import MassUpdateActionHandler + from .mass_update_response import MassUpdateResponse + from .count_handler import CountHandler + from .action_handler import ActionHandler + from .download_handler import DownloadHandler + from .file_handler import FileHandler + from .mass_update_action_response import MassUpdateActionResponse + from .deleted_records_handler import DeletedRecordsHandler + + +class APIException(ResponseHandler, ActionResponse, ActionHandler, DeletedRecordsHandler, DownloadHandler, FileHandler, MassUpdateActionResponse, MassUpdateActionHandler, MassUpdateResponse, MassUpdateResponseHandler, CountHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/body_wrapper.py new file mode 100644 index 0000000..085259b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/body_wrapper.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__trigger = None + self.__process = None + self.__duplicate_check_fields = None + self.__wf_trigger = None + self.__lar_id = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_trigger(self): + """ + The method to get the trigger + + Returns: + list: An instance of list + """ + + return self.__trigger + + def set_trigger(self, trigger): + """ + The method to set the value to trigger + + Parameters: + trigger (list) : An instance of list + """ + + if trigger is not None and not isinstance(trigger, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trigger EXPECTED TYPE: list', None, None) + + self.__trigger = trigger + self.__key_modified['trigger'] = 1 + + def get_process(self): + """ + The method to get the process + + Returns: + list: An instance of list + """ + + return self.__process + + def set_process(self, process): + """ + The method to set the value to process + + Parameters: + process (list) : An instance of list + """ + + if process is not None and not isinstance(process, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process EXPECTED TYPE: list', None, None) + + self.__process = process + self.__key_modified['process'] = 1 + + def get_duplicate_check_fields(self): + """ + The method to get the duplicate_check_fields + + Returns: + list: An instance of list + """ + + return self.__duplicate_check_fields + + def set_duplicate_check_fields(self, duplicate_check_fields): + """ + The method to set the value to duplicate_check_fields + + Parameters: + duplicate_check_fields (list) : An instance of list + """ + + if duplicate_check_fields is not None and not isinstance(duplicate_check_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_check_fields EXPECTED TYPE: list', None, None) + + self.__duplicate_check_fields = duplicate_check_fields + self.__key_modified['duplicate_check_fields'] = 1 + + def get_wf_trigger(self): + """ + The method to get the wf_trigger + + Returns: + string: A string representing the wf_trigger + """ + + return self.__wf_trigger + + def set_wf_trigger(self, wf_trigger): + """ + The method to set the value to wf_trigger + + Parameters: + wf_trigger (string) : A string representing the wf_trigger + """ + + if wf_trigger is not None and not isinstance(wf_trigger, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wf_trigger EXPECTED TYPE: str', None, None) + + self.__wf_trigger = wf_trigger + self.__key_modified['wf_trigger'] = 1 + + def get_lar_id(self): + """ + The method to get the lar_id + + Returns: + string: A string representing the lar_id + """ + + return self.__lar_id + + def set_lar_id(self, lar_id): + """ + The method to set the value to lar_id + + Parameters: + lar_id (string) : A string representing the lar_id + """ + + if lar_id is not None and not isinstance(lar_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lar_id EXPECTED TYPE: str', None, None) + + self.__lar_id = lar_id + self.__key_modified['lar_id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/comment.py b/zohocrmsdk/src/com/zoho/crm/api/record/comment.py new file mode 100644 index 0000000..b7492e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/comment.py @@ -0,0 +1,151 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Comment(object): + def __init__(self): + """Creates an instance of Comment""" + + self.__commented_by = None + self.__commented_time = None + self.__comment_content = None + self.__id = None + self.__key_modified = dict() + + def get_commented_by(self): + """ + The method to get the commented_by + + Returns: + string: A string representing the commented_by + """ + + return self.__commented_by + + def set_commented_by(self, commented_by): + """ + The method to set the value to commented_by + + Parameters: + commented_by (string) : A string representing the commented_by + """ + + if commented_by is not None and not isinstance(commented_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: commented_by EXPECTED TYPE: str', None, None) + + self.__commented_by = commented_by + self.__key_modified['commented_by'] = 1 + + def get_commented_time(self): + """ + The method to get the commented_time + + Returns: + datetime: An instance of datetime + """ + + return self.__commented_time + + def set_commented_time(self, commented_time): + """ + The method to set the value to commented_time + + Parameters: + commented_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if commented_time is not None and not isinstance(commented_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: commented_time EXPECTED TYPE: datetime', None, None) + + self.__commented_time = commented_time + self.__key_modified['commented_time'] = 1 + + def get_comment_content(self): + """ + The method to get the comment_content + + Returns: + string: A string representing the comment_content + """ + + return self.__comment_content + + def set_comment_content(self, comment_content): + """ + The method to set the value to comment_content + + Parameters: + comment_content (string) : A string representing the comment_content + """ + + if comment_content is not None and not isinstance(comment_content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comment_content EXPECTED TYPE: str', None, None) + + self.__comment_content = comment_content + self.__key_modified['comment_content'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/consent.py b/zohocrmsdk/src/com/zoho/crm/api/record/consent.py new file mode 100644 index 0000000..31b662c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/consent.py @@ -0,0 +1,429 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class Consent(Record): + def __init__(self): + """Creates an instance of Consent""" + super().__init__() + + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Owner') + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Owner', owner) + + def get_contact_through_email(self): + """ + The method to get the contact_through_email + + Returns: + bool: A bool representing the contact_through_email + """ + + return self.get_key_value('Contact_Through_Email') + + def set_contact_through_email(self, contact_through_email): + """ + The method to set the value to contact_through_email + + Parameters: + contact_through_email (bool) : A bool representing the contact_through_email + """ + + if contact_through_email is not None and not isinstance(contact_through_email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_email EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Email', contact_through_email) + + def get_contact_through_social(self): + """ + The method to get the contact_through_social + + Returns: + bool: A bool representing the contact_through_social + """ + + return self.get_key_value('Contact_Through_Social') + + def set_contact_through_social(self, contact_through_social): + """ + The method to set the value to contact_through_social + + Parameters: + contact_through_social (bool) : A bool representing the contact_through_social + """ + + if contact_through_social is not None and not isinstance(contact_through_social, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_social EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Social', contact_through_social) + + def get_contact_through_survey(self): + """ + The method to get the contact_through_survey + + Returns: + bool: A bool representing the contact_through_survey + """ + + return self.get_key_value('Contact_Through_Survey') + + def set_contact_through_survey(self, contact_through_survey): + """ + The method to set the value to contact_through_survey + + Parameters: + contact_through_survey (bool) : A bool representing the contact_through_survey + """ + + if contact_through_survey is not None and not isinstance(contact_through_survey, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_survey EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Survey', contact_through_survey) + + def get_contact_through_phone(self): + """ + The method to get the contact_through_phone + + Returns: + bool: A bool representing the contact_through_phone + """ + + return self.get_key_value('Contact_Through_Phone') + + def set_contact_through_phone(self, contact_through_phone): + """ + The method to set the value to contact_through_phone + + Parameters: + contact_through_phone (bool) : A bool representing the contact_through_phone + """ + + if contact_through_phone is not None and not isinstance(contact_through_phone, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: contact_through_phone EXPECTED TYPE: bool', None, None) + + self.add_key_value('Contact_Through_Phone', contact_through_phone) + + def get_mail_sent_time(self): + """ + The method to get the mail_sent_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Mail_Sent_Time') + + def set_mail_sent_time(self, mail_sent_time): + """ + The method to set the value to mail_sent_time + + Parameters: + mail_sent_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if mail_sent_time is not None and not isinstance(mail_sent_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_sent_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Mail_Sent_Time', mail_sent_time) + + def get_consent_date(self): + """ + The method to get the consent_date + + Returns: + date: An instance of date + """ + + return self.get_key_value('Consent_Date') + + def set_consent_date(self, consent_date): + """ + The method to set the value to consent_date + + Parameters: + consent_date (date) : An instance of date + """ + + from datetime import date as date1 + + if consent_date is not None and not isinstance(consent_date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_date EXPECTED TYPE: date1', None, None) + + self.add_key_value('Consent_Date', consent_date) + + def get_consent_remarks(self): + """ + The method to get the consent_remarks + + Returns: + string: A string representing the consent_remarks + """ + + return self.get_key_value('Consent_Remarks') + + def set_consent_remarks(self, consent_remarks): + """ + The method to set the value to consent_remarks + + Parameters: + consent_remarks (string) : A string representing the consent_remarks + """ + + if consent_remarks is not None and not isinstance(consent_remarks, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_remarks EXPECTED TYPE: str', None, None) + + self.add_key_value('Consent_Remarks', consent_remarks) + + def get_consent_through(self): + """ + The method to get the consent_through + + Returns: + string: A string representing the consent_through + """ + + return self.get_key_value('Consent_Through') + + def set_consent_through(self, consent_through): + """ + The method to set the value to consent_through + + Parameters: + consent_through (string) : A string representing the consent_through + """ + + if consent_through is not None and not isinstance(consent_through, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_through EXPECTED TYPE: str', None, None) + + self.add_key_value('Consent_Through', consent_through) + + def get_data_processing_basis(self): + """ + The method to get the data_processing_basis + + Returns: + string: A string representing the data_processing_basis + """ + + return self.get_key_value('Data_Processing_Basis') + + def set_data_processing_basis(self, data_processing_basis): + """ + The method to set the value to data_processing_basis + + Parameters: + data_processing_basis (string) : A string representing the data_processing_basis + """ + + if data_processing_basis is not None and not isinstance(data_processing_basis, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_processing_basis EXPECTED TYPE: str', None, None) + + self.add_key_value('Data_Processing_Basis', data_processing_basis) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/count_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/count_handler.py new file mode 100644 index 0000000..6c4eb60 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/count_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class CountHandler(ABC): + def __init__(self): + """Creates an instance of CountHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/count_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/count_wrapper.py new file mode 100644 index 0000000..88b90a8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/count_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.count_handler import CountHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .count_handler import CountHandler + + +class CountWrapper(CountHandler): + def __init__(self): + """Creates an instance of CountWrapper""" + super().__init__() + + self.__count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/record/criteria.py new file mode 100644 index 0000000..fe44a34 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/criteria.py @@ -0,0 +1,171 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + Choice: An instance of Choice + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (Choice) : An instance of Choice + """ + + if comparator is not None and not isinstance(comparator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: Choice', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + string: A string representing the field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (string) : A string representing the field + """ + + if field is not None and not isinstance(field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: str', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + Choice: An instance of Choice + """ + + return self.__group_operator + + 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 get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/deleted_record.py b/zohocrmsdk/src/com/zoho/crm/api/record/deleted_record.py new file mode 100644 index 0000000..e1338c9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/deleted_record.py @@ -0,0 +1,211 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DeletedRecord(object): + def __init__(self): + """Creates an instance of DeletedRecord""" + + self.__deleted_by = None + self.__id = None + self.__display_name = None + self.__type = None + self.__created_by = None + self.__deleted_time = None + self.__key_modified = dict() + + def get_deleted_by(self): + """ + The method to get the deleted_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__deleted_by + + def set_deleted_by(self, deleted_by): + """ + The method to set the value to deleted_by + + Parameters: + deleted_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if deleted_by is not None and not isinstance(deleted_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__deleted_by = deleted_by + self.__key_modified['deleted_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_display_name(self): + """ + The method to get the display_name + + Returns: + string: A string representing the display_name + """ + + return self.__display_name + + def set_display_name(self, display_name): + """ + The method to set the value to display_name + + Parameters: + display_name (string) : A string representing the display_name + """ + + if display_name is not None and not isinstance(display_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_name EXPECTED TYPE: str', None, None) + + self.__display_name = display_name + self.__key_modified['display_name'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_deleted_time(self): + """ + The method to get the deleted_time + + Returns: + datetime: An instance of datetime + """ + + return self.__deleted_time + + def set_deleted_time(self, deleted_time): + """ + The method to set the value to deleted_time + + Parameters: + deleted_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if deleted_time is not None and not isinstance(deleted_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_time EXPECTED TYPE: datetime', None, None) + + self.__deleted_time = deleted_time + self.__key_modified['deleted_time'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_handler.py new file mode 100644 index 0000000..4dcc93a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DeletedRecordsHandler(ABC): + def __init__(self): + """Creates an instance of DeletedRecordsHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_wrapper.py new file mode 100644 index 0000000..adec4dc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/deleted_records_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.deleted_records_handler import DeletedRecordsHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .deleted_records_handler import DeletedRecordsHandler + + +class DeletedRecordsWrapper(DeletedRecordsHandler): + def __init__(self): + """Creates an instance of DeletedRecordsWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/download_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/download_handler.py new file mode 100644 index 0000000..3188004 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/download_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DownloadHandler(ABC): + def __init__(self): + """Creates an instance of DownloadHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/duplicate_record.py b/zohocrmsdk/src/com/zoho/crm/api/record/duplicate_record.py new file mode 100644 index 0000000..9c3e8b9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/duplicate_record.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DuplicateRecord(object): + def __init__(self): + """Creates an instance of DuplicateRecord""" + + self.__owner = None + self.__module = None + self.__id = None + self.__key_modified = dict() + + def get_owner(self): + """ + The method to get the owner + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner is not None and not isinstance(owner, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner = owner + self.__key_modified['Owner'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/field.py b/zohocrmsdk/src/com/zoho/crm/api/record/field.py new file mode 100644 index 0000000..e21a0b6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/field.py @@ -0,0 +1,2940 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self, api_name): + """ + Creates an instance of Field with the given parameters + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + + class Products(object): + + @classmethod + def product_category(cls): + return Field('Product_Category') + + @classmethod + def qty_in_demand(cls): + return Field('Qty_in_Demand') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def sales_start_date(cls): + return Field('Sales_Start_Date') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def product_active(cls): + return Field('Product_Active') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def product_code(cls): + return Field('Product_Code') + + @classmethod + def manufacturer(cls): + return Field('Manufacturer') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def support_expiry_date(cls): + return Field('Support_Expiry_Date') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def commission_rate(cls): + return Field('Commission_Rate') + + @classmethod + def product_name(cls): + return Field('Product_Name') + + @classmethod + def handler(cls): + return Field('Handler') + + @classmethod + def support_start_date(cls): + return Field('Support_Start_Date') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def usage_unit(cls): + return Field('Usage_Unit') + + @classmethod + def qty_ordered(cls): + return Field('Qty_Ordered') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def qty_in_stock(cls): + return Field('Qty_in_Stock') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def sales_end_date(cls): + return Field('Sales_End_Date') + + @classmethod + def unit_price(cls): + return Field('Unit_Price') + + @classmethod + def taxable(cls): + return Field('Taxable') + + @classmethod + def reorder_level(cls): + return Field('Reorder_Level') + + + + + class Consents(object): + + @classmethod + def contact_through_email(cls): + return Field('Contact_Through_Email') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def consent_through(cls): + return Field('Consent_Through') + + @classmethod + def contact_through_survey(cls): + return Field('Contact_Through_Survey') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def data_processing_basis(cls): + return Field('Data_Processing_Basis') + + @classmethod + def contact_through_phone(cls): + return Field('Contact_Through_Phone') + + @classmethod + def lawful_reason(cls): + return Field('Lawful_Reason') + + @classmethod + def mail_sent_time(cls): + return Field('Mail_Sent_Time') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def consent_date(cls): + return Field('Consent_Date') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def consent_remarks(cls): + return Field('Consent_Remarks') + + + + + class Tasks(object): + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def priority(cls): + return Field('Priority') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def closed_time(cls): + return Field('Closed_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def send_notification_email(cls): + return Field('Send_Notification_Email') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def recurring_activity(cls): + return Field('Recurring_Activity') + + @classmethod + def what_id(cls): + return Field('What_Id') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def remind_at(cls): + return Field('Remind_At') + + @classmethod + def who_id(cls): + return Field('Who_Id') + + + + + class Data_Subject_Requests(object): + + @classmethod + def request_type(cls): + return Field('Request_Type') + + @classmethod + def is_closed(cls): + return Field('Is_Closed') + + @classmethod + def parent_id(cls): + return Field('Parent_Id') + + @classmethod + def request_source(cls): + return Field('Request_Source') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def closed_by(cls): + return Field('Closed_By') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def requested_by(cls): + return Field('Requested_By') + + @classmethod + def requested_date(cls): + return Field('Requested_Date') + + @classmethod + def closed_date(cls): + return Field('Closed_Date') + + + + + class Vendors(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def category(cls): + return Field('Category') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def website(cls): + return Field('Website') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def unsubscribed_mode(cls): + return Field('Unsubscribed_Mode') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def street(cls): + return Field('Street') + + @classmethod + def zip_code(cls): + return Field('Zip_Code') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def email_opt_out(cls): + return Field('Email_Opt_Out') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def unsubscribed_time(cls): + return Field('Unsubscribed_Time') + + @classmethod + def city(cls): + return Field('City') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def state(cls): + return Field('State') + + @classmethod + def gl_account(cls): + return Field('GL_Account') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def country(cls): + return Field('Country') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + + + + class Data_Enrichment_Stats__s(object): + + @classmethod + def usage_bulk_count__s(cls): + return Field('Usage_Bulk_Count__s') + + @classmethod + def usage_date__s(cls): + return Field('Usage_Date__s') + + @classmethod + def feature_name__s(cls): + return Field('Feature_Name__s') + + @classmethod + def module__s(cls): + return Field('Module__s') + + @classmethod + def add_on_limit__s(cls): + return Field('Add_On_Limit__s') + + @classmethod + def monthly_limit__s(cls): + return Field('Monthly_Limit__s') + + @classmethod + def usage_count__s(cls): + return Field('Usage_Count__s') + + + + + class Appointments__s(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def address(cls): + return Field('Address') + + @classmethod + def appointment_start_time(cls): + return Field('Appointment_Start_Time') + + @classmethod + def cancellation_reason(cls): + return Field('Cancellation_Reason') + + @classmethod + def appointment_for(cls): + return Field('Appointment_For') + + @classmethod + def rescheduled_to(cls): + return Field('Rescheduled_To') + + @classmethod + def reschedule_reason(cls): + return Field('Reschedule_Reason') + + @classmethod + def job_sheet_name__s(cls): + return Field('Job_Sheet_Name__s') + + @classmethod + def additional_information(cls): + return Field('Additional_Information') + + @classmethod + def job_sheet_created__s(cls): + return Field('Job_Sheet_Created__s') + + @classmethod + def cancelled_time(cls): + return Field('Cancelled_Time') + + @classmethod + def cancellation_note(cls): + return Field('Cancellation_Note') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def reschedule_count(cls): + return Field('Reschedule_Count') + + @classmethod + def rescheduled_by(cls): + return Field('Rescheduled_By') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def rescheduled_time(cls): + return Field('Rescheduled_Time') + + @classmethod + def remind_at(cls): + return Field('Remind_At') + + @classmethod + def appointment_end_time(cls): + return Field('Appointment_End_Time') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def service_name(cls): + return Field('Service_Name') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def rescheduled_from(cls): + return Field('Rescheduled_From') + + @classmethod + def cancelled_by(cls): + return Field('Cancelled_By') + + @classmethod + def duration(cls): + return Field('Duration') + + @classmethod + def appointment_name(cls): + return Field('Appointment_Name') + + @classmethod + def job_sheet_section__s(cls): + return Field('Job_Sheet_Section__s') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def job_sheet_description__s(cls): + return Field('Job_Sheet_Description__s') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def location(cls): + return Field('Location') + + @classmethod + def reschedule_note(cls): + return Field('Reschedule_Note') + + + + + class Calls(object): + + @classmethod + def call_duration(cls): + return Field('Call_Duration') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def caller_id(cls): + return Field('Caller_ID') + + @classmethod + def cti_entry(cls): + return Field('CTI_Entry') + + @classmethod + def call_agenda(cls): + return Field('Call_Agenda') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def call_purpose(cls): + return Field('Call_Purpose') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def who_id(cls): + return Field('Who_Id') + + @classmethod + def outgoing_call_status(cls): + return Field('Outgoing_Call_Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def reminder(cls): + return Field('Reminder') + + @classmethod + def voice_recording__s(cls): + return Field('Voice_Recording__s') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def call_start_time(cls): + return Field('Call_Start_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def call_type(cls): + return Field('Call_Type') + + @classmethod + def scheduled_in_crm(cls): + return Field('Scheduled_In_CRM') + + @classmethod + def call_result(cls): + return Field('Call_Result') + + @classmethod + def what_id(cls): + return Field('What_Id') + + @classmethod + def call_duration_in_seconds(cls): + return Field('Call_Duration_in_seconds') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def dialled_number(cls): + return Field('Dialled_Number') + + + + + class Leads(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def company(cls): + return Field('Company') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def visitor_score(cls): + return Field('Visitor_Score') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def industry(cls): + return Field('Industry') + + @classmethod + def unsubscribed_mode(cls): + return Field('Unsubscribed_Mode') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def street(cls): + return Field('Street') + + @classmethod + def data_processing_basis_details(cls): + return Field('Data_Processing_Basis_Details') + + @classmethod + def zip_code(cls): + return Field('Zip_Code') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def data_source(cls): + return Field('Data_Source') + + @classmethod + def enrich_status__s(cls): + return Field('Enrich_Status__s') + + @classmethod + def first_visited_url(cls): + return Field('First_Visited_URL') + + @classmethod + def days_visited(cls): + return Field('Days_Visited') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def city(cls): + return Field('City') + + @classmethod + def no_of_employees(cls): + return Field('No_of_Employees') + + @classmethod + def data_processing_basis(cls): + return Field('Data_Processing_Basis') + + @classmethod + def converted__s(cls): + return Field('Converted__s') + + @classmethod + def converted_date_time(cls): + return Field('Converted_Date_Time') + + @classmethod + def converted_account(cls): + return Field('Converted_Account') + + @classmethod + def state(cls): + return Field('State') + + @classmethod + def country(cls): + return Field('Country') + + @classmethod + def last_visited_time(cls): + return Field('Last_Visited_Time') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def annual_revenue(cls): + return Field('Annual_Revenue') + + @classmethod + def secondary_email(cls): + return Field('Secondary_Email') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def number_of_chats(cls): + return Field('Number_Of_Chats') + + @classmethod + def rating(cls): + return Field('Rating') + + @classmethod + def website(cls): + return Field('Website') + + @classmethod + def twitter(cls): + return Field('Twitter') + + @classmethod + def average_time_spent_minutes(cls): + return Field('Average_Time_Spent_Minutes') + + @classmethod + def salutation(cls): + return Field('Salutation') + + @classmethod + def first_name(cls): + return Field('First_Name') + + @classmethod + def full_name(cls): + return Field('Full_Name') + + @classmethod + def lead_status(cls): + return Field('Lead_Status') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def converted_deal(cls): + return Field('Converted_Deal') + + @classmethod + def lead_conversion_time(cls): + return Field('Lead_Conversion_Time') + + @classmethod + def skype_id(cls): + return Field('Skype_ID') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def email_opt_out(cls): + return Field('Email_Opt_Out') + + @classmethod + def designation(cls): + return Field('Designation') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def unsubscribed_time(cls): + return Field('Unsubscribed_Time') + + @classmethod + def converted_contact(cls): + return Field('Converted_Contact') + + @classmethod + def mobile(cls): + return Field('Mobile') + + @classmethod + def territories(cls): + return Field('Territories') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def first_visited_time(cls): + return Field('First_Visited_Time') + + @classmethod + def last_name(cls): + return Field('Last_Name') + + @classmethod + def layout(cls): + return Field('Layout') + + @classmethod + def referrer(cls): + return Field('Referrer') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def lead_source(cls): + return Field('Lead_Source') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def fax(cls): + return Field('Fax') + + @classmethod + def last_enriched_time__s(cls): + return Field('Last_Enriched_Time__s') + + + + + class Deals(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def campaign_source(cls): + return Field('Campaign_Source') + + @classmethod + def closing_date(cls): + return Field('Closing_Date') + + @classmethod + def reason_for_loss__s(cls): + return Field('Reason_For_Loss__s') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def lead_conversion_time(cls): + return Field('Lead_Conversion_Time') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def expected_revenue(cls): + return Field('Expected_Revenue') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def overall_sales_duration(cls): + return Field('Overall_Sales_Duration') + + @classmethod + def stage(cls): + return Field('Stage') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def territory(cls): + return Field('Territory') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def amount(cls): + return Field('Amount') + + @classmethod + def probability(cls): + return Field('Probability') + + @classmethod + def next_step(cls): + return Field('Next_Step') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def pipeline(cls): + return Field('Pipeline') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def sales_cycle_duration(cls): + return Field('Sales_Cycle_Duration') + + @classmethod + def type(cls): + return Field('Type') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def lead_source(cls): + return Field('Lead_Source') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + + + + class Quotes(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def valid_till(cls): + return Field('Valid_Till') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def team(cls): + return Field('Team') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def carrier(cls): + return Field('Carrier') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def quoted_items(cls): + return Field('Quoted_Items') + + @classmethod + def quote_stage(cls): + return Field('Quote_Stage') + + @classmethod + def grand_total(cls): + return Field('Grand_Total') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def quote_number(cls): + return Field('Quote_Number') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Invoices(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def invoice_date(cls): + return Field('Invoice_Date') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def invoiced_items(cls): + return Field('Invoiced_Items') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def sales_order(cls): + return Field('Sales_Order') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def sales_commission(cls): + return Field('Sales_Commission') + + @classmethod + def grand_total(cls): + return Field('Grand_Total') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def invoice_number(cls): + return Field('Invoice_Number') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def excise_duty(cls): + return Field('Excise_Duty') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def purchase_order(cls): + return Field('Purchase_Order') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Campaigns(object): + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def campaign_name(cls): + return Field('Campaign_Name') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def end_date(cls): + return Field('End_Date') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def type(cls): + return Field('Type') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def num_sent(cls): + return Field('Num_sent') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def expected_revenue(cls): + return Field('Expected_Revenue') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def actual_cost(cls): + return Field('Actual_Cost') + + @classmethod + def expected_response(cls): + return Field('Expected_Response') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def parent_campaign(cls): + return Field('Parent_Campaign') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def start_date(cls): + return Field('Start_Date') + + @classmethod + def budgeted_cost(cls): + return Field('Budgeted_Cost') + + + + + class Attachments(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def file_name(cls): + return Field('File_Name') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def size(cls): + return Field('Size') + + @classmethod + def parent_id(cls): + return Field('Parent_Id') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + + + + class Price_Books(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def pricing_details(cls): + return Field('Pricing_Details') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def active(cls): + return Field('Active') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def pricing_model(cls): + return Field('Pricing_Model') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def price_book_name(cls): + return Field('Price_Book_Name') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + + + + class Sales_Orders(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def customer_no(cls): + return Field('Customer_No') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def carrier(cls): + return Field('Carrier') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def ordered_items(cls): + return Field('Ordered_Items') + + @classmethod + def quote_name(cls): + return Field('Quote_Name') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def sales_commission(cls): + return Field('Sales_Commission') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def excise_duty(cls): + return Field('Excise_Duty') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def so_number(cls): + return Field('SO_Number') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def purchase_order(cls): + return Field('Purchase_Order') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def pending(cls): + return Field('Pending') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Services__s(object): + + @classmethod + def job_sheet_required(cls): + return Field('Job_Sheet_Required') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def available_days(cls): + return Field('Available_Days') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def unavailable_from(cls): + return Field('Unavailable_From') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def available_dates(cls): + return Field('Available_Dates') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def available_timings(cls): + return Field('Available_Timings') + + @classmethod + def service_name(cls): + return Field('Service_Name') + + @classmethod + def available_from(cls): + return Field('Available_From') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def available_till(cls): + return Field('Available_Till') + + @classmethod + def duration(cls): + return Field('Duration') + + @classmethod + def job_sheet_section__s(cls): + return Field('Job_Sheet_Section__s') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def price(cls): + return Field('Price') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def availability_type(cls): + return Field('Availability_Type') + + @classmethod + def members(cls): + return Field('Members') + + @classmethod + def location(cls): + return Field('Location') + + @classmethod + def unavailable_till(cls): + return Field('Unavailable_Till') + + + + + class Contacts(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def visitor_score(cls): + return Field('Visitor_Score') + + @classmethod + def other_phone(cls): + return Field('Other_Phone') + + @classmethod + def mailing_state(cls): + return Field('Mailing_State') + + @classmethod + def other_state(cls): + return Field('Other_State') + + @classmethod + def other_country(cls): + return Field('Other_Country') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def department(cls): + return Field('Department') + + @classmethod + def unsubscribed_mode(cls): + return Field('Unsubscribed_Mode') + + @classmethod + def assistant(cls): + return Field('Assistant') + + @classmethod + def mailing_country(cls): + return Field('Mailing_Country') + + @classmethod + def data_processing_basis_details(cls): + return Field('Data_Processing_Basis_Details') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def data_source(cls): + return Field('Data_Source') + + @classmethod + def reporting_to(cls): + return Field('Reporting_To') + + @classmethod + def enrich_status__s(cls): + return Field('Enrich_Status__s') + + @classmethod + def first_visited_url(cls): + return Field('First_Visited_URL') + + @classmethod + def days_visited(cls): + return Field('Days_Visited') + + @classmethod + def other_city(cls): + return Field('Other_City') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def data_processing_basis(cls): + return Field('Data_Processing_Basis') + + @classmethod + def home_phone(cls): + return Field('Home_Phone') + + @classmethod + def last_visited_time(cls): + return Field('Last_Visited_Time') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def secondary_email(cls): + return Field('Secondary_Email') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def mailing_zip(cls): + return Field('Mailing_Zip') + + @classmethod + def reports_to(cls): + return Field('Reports_To') + + @classmethod + def number_of_chats(cls): + return Field('Number_Of_Chats') + + @classmethod + def twitter(cls): + return Field('Twitter') + + @classmethod + def other_zip(cls): + return Field('Other_Zip') + + @classmethod + def mailing_street(cls): + return Field('Mailing_Street') + + @classmethod + def average_time_spent_minutes(cls): + return Field('Average_Time_Spent_Minutes') + + @classmethod + def salutation(cls): + return Field('Salutation') + + @classmethod + def first_name(cls): + return Field('First_Name') + + @classmethod + def full_name(cls): + return Field('Full_Name') + + @classmethod + def asst_phone(cls): + return Field('Asst_Phone') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def skype_id(cls): + return Field('Skype_ID') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def email_opt_out(cls): + return Field('Email_Opt_Out') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def date_of_birth(cls): + return Field('Date_of_Birth') + + @classmethod + def mailing_city(cls): + return Field('Mailing_City') + + @classmethod + def unsubscribed_time(cls): + return Field('Unsubscribed_Time') + + @classmethod + def title(cls): + return Field('Title') + + @classmethod + def other_street(cls): + return Field('Other_Street') + + @classmethod + def mobile(cls): + return Field('Mobile') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def territories(cls): + return Field('Territories') + + @classmethod + def first_visited_time(cls): + return Field('First_Visited_Time') + + @classmethod + def last_name(cls): + return Field('Last_Name') + + @classmethod + def referrer(cls): + return Field('Referrer') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def lead_source(cls): + return Field('Lead_Source') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def fax(cls): + return Field('Fax') + + @classmethod + def last_enriched_time__s(cls): + return Field('Last_Enriched_Time__s') + + + + + class Solutions(object): + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def comments(cls): + return Field('Comments') + + @classmethod + def no_of_comments(cls): + return Field('No_of_comments') + + @classmethod + def product_name(cls): + return Field('Product_Name') + + @classmethod + def add_comment(cls): + return Field('Add_Comment') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def solution_number(cls): + return Field('Solution_Number') + + @classmethod + def answer(cls): + return Field('Answer') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def solution_title(cls): + return Field('Solution_Title') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def published(cls): + return Field('Published') + + @classmethod + def question(cls): + return Field('Question') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def id(cls): + return Field('id') + + + + + class Events(object): + + @classmethod + def all_day(cls): + return Field('All_day') + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def check_in_state(cls): + return Field('Check_In_State') + + @classmethod + def check_in_address(cls): + return Field('Check_In_Address') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def remind_participants(cls): + return Field('Remind_Participants') + + @classmethod + def start_datetime(cls): + return Field('Start_DateTime') + + @classmethod + def latitude(cls): + return Field('Latitude') + + @classmethod + def participants(cls): + return Field('Participants') + + @classmethod + def event_title(cls): + return Field('Event_Title') + + @classmethod + def end_datetime(cls): + return Field('End_DateTime') + + @classmethod + def check_in_by(cls): + return Field('Check_In_By') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def check_in_city(cls): + return Field('Check_In_City') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def check_in_comment(cls): + return Field('Check_In_Comment') + + @classmethod + def remind_at(cls): + return Field('Remind_At') + + @classmethod + def who_id(cls): + return Field('Who_Id') + + @classmethod + def check_in_status(cls): + return Field('Check_In_Status') + + @classmethod + def check_in_country(cls): + return Field('Check_In_Country') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def venue(cls): + return Field('Venue') + + @classmethod + def zip_code(cls): + return Field('ZIP_Code') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def longitude(cls): + return Field('Longitude') + + @classmethod + def check_in_time(cls): + return Field('Check_In_Time') + + @classmethod + def recurring_activity(cls): + return Field('Recurring_Activity') + + @classmethod + def what_id(cls): + return Field('What_Id') + + @classmethod + def check_in_sub_locality(cls): + return Field('Check_In_Sub_Locality') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + + + + class Purchase_Orders(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def discount(cls): + return Field('Discount') + + @classmethod + def vendor_name(cls): + return Field('Vendor_Name') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def tax(cls): + return Field('Tax') + + @classmethod + def po_date(cls): + return Field('PO_Date') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def purchase_items(cls): + return Field('Purchase_Items') + + @classmethod + def carrier(cls): + return Field('Carrier') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def sales_commission(cls): + return Field('Sales_Commission') + + @classmethod + def grand_total(cls): + return Field('Grand_Total') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def po_number(cls): + return Field('PO_Number') + + @classmethod + def due_date(cls): + return Field('Due_Date') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def adjustment(cls): + return Field('Adjustment') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def terms_and_conditions(cls): + return Field('Terms_and_Conditions') + + @classmethod + def sub_total(cls): + return Field('Sub_Total') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def tracking_number(cls): + return Field('Tracking_Number') + + @classmethod + def contact_name(cls): + return Field('Contact_Name') + + @classmethod + def excise_duty(cls): + return Field('Excise_Duty') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def requisition_no(cls): + return Field('Requisition_No') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Accounts(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def ownership(cls): + return Field('Ownership') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def account_type(cls): + return Field('Account_Type') + + @classmethod + def rating(cls): + return Field('Rating') + + @classmethod + def sic_code(cls): + return Field('SIC_Code') + + @classmethod + def shipping_state(cls): + return Field('Shipping_State') + + @classmethod + def website(cls): + return Field('Website') + + @classmethod + def employees(cls): + return Field('Employees') + + @classmethod + def last_activity_time(cls): + return Field('Last_Activity_Time') + + @classmethod + def industry(cls): + return Field('Industry') + + @classmethod + def record_image(cls): + return Field('Record_Image') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def account_site(cls): + return Field('Account_Site') + + @classmethod + def exchange_rate(cls): + return Field('Exchange_Rate') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def currency(cls): + return Field('Currency') + + @classmethod + def billing_country(cls): + return Field('Billing_Country') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def account_number(cls): + return Field('Account_Number') + + @classmethod + def ticker_symbol(cls): + return Field('Ticker_Symbol') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def enrich_status__s(cls): + return Field('Enrich_Status__s') + + @classmethod + def billing_street(cls): + return Field('Billing_Street') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def change_log_time__s(cls): + return Field('Change_Log_Time__s') + + @classmethod + def billing_code(cls): + return Field('Billing_Code') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def territories(cls): + return Field('Territories') + + @classmethod + def parent_account(cls): + return Field('Parent_Account') + + @classmethod + def shipping_city(cls): + return Field('Shipping_City') + + @classmethod + def shipping_country(cls): + return Field('Shipping_Country') + + @classmethod + def shipping_code(cls): + return Field('Shipping_Code') + + @classmethod + def billing_city(cls): + return Field('Billing_City') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def billing_state(cls): + return Field('Billing_State') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def fax(cls): + return Field('Fax') + + @classmethod + def annual_revenue(cls): + return Field('Annual_Revenue') + + @classmethod + def last_enriched_time__s(cls): + return Field('Last_Enriched_Time__s') + + @classmethod + def shipping_street(cls): + return Field('Shipping_Street') + + + + + class Cases(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def email(cls): + return Field('Email') + + @classmethod + def description(cls): + return Field('Description') + + @classmethod + def internal_comments(cls): + return Field('Internal_Comments') + + @classmethod + def no_of_comments(cls): + return Field('No_of_comments') + + @classmethod + def reported_by(cls): + return Field('Reported_By') + + @classmethod + def case_number(cls): + return Field('Case_Number') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def deal_name(cls): + return Field('Deal_Name') + + @classmethod + def phone(cls): + return Field('Phone') + + @classmethod + def account_name(cls): + return Field('Account_Name') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def solution(cls): + return Field('Solution') + + @classmethod + def status(cls): + return Field('Status') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def priority(cls): + return Field('Priority') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def comments(cls): + return Field('Comments') + + @classmethod + def product_name(cls): + return Field('Product_Name') + + @classmethod + def add_comment(cls): + return Field('Add_Comment') + + @classmethod + def case_origin(cls): + return Field('Case_Origin') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + @classmethod + def case_reason(cls): + return Field('Case_Reason') + + @classmethod + def subject(cls): + return Field('Subject') + + @classmethod + def type(cls): + return Field('Type') + + @classmethod + def locked__s(cls): + return Field('Locked__s') + + @classmethod + def tag(cls): + return Field('Tag') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def related_to(cls): + return Field('Related_To') + + + + + class Notes(object): + + @classmethod + def owner(cls): + return Field('Owner') + + @classmethod + def modified_by(cls): + return Field('Modified_By') + + @classmethod + def modified_time(cls): + return Field('Modified_Time') + + @classmethod + def created_time(cls): + return Field('Created_Time') + + @classmethod + def parent_id(cls): + return Field('Parent_Id') + + @classmethod + def associated_id__s(cls): + return Field('Associated_Id__s') + + @classmethod + def created_by(cls): + return Field('Created_By') + + @classmethod + def id(cls): + return Field('id') + + @classmethod + def note_title(cls): + return Field('Note_Title') + + @classmethod + def note_content(cls): + return Field('Note_Content') + + @classmethod + def record_status__s(cls): + return Field('Record_Status__s') + + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/file_body_wrapper.py new file mode 100644 index 0000000..30c2b86 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/file_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record.download_handler import DownloadHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + from .download_handler import DownloadHandler + + +class FileBodyWrapper(ResponseHandler, DownloadHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/file_details.py b/zohocrmsdk/src/com/zoho/crm/api/record/file_details.py new file mode 100644 index 0000000..52dc096 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/file_details.py @@ -0,0 +1,318 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FileDetails(object): + def __init__(self): + """Creates an instance of FileDetails""" + + self.__created_time__s = None + self.__file_name__s = None + self.__modified_time__s = None + self.__created_by__s = None + self.__size__s = None + self.__id = None + self.__owner__s = None + self.__modified_by__s = None + self.__file_id__s = None + self.__delete = None + self.__key_modified = dict() + + def get_created_time__s(self): + """ + The method to get the created_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time__s + + def set_created_time__s(self, created_time__s): + """ + The method to set the value to created_time__s + + Parameters: + created_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time__s is not None and not isinstance(created_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time__s EXPECTED TYPE: datetime', None, None) + + self.__created_time__s = created_time__s + self.__key_modified['Created_Time__s'] = 1 + + def get_file_name__s(self): + """ + The method to get the file_name__s + + Returns: + string: A string representing the file_name__s + """ + + return self.__file_name__s + + def set_file_name__s(self, file_name__s): + """ + The method to set the value to file_name__s + + Parameters: + file_name__s (string) : A string representing the file_name__s + """ + + if file_name__s is not None and not isinstance(file_name__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name__s EXPECTED TYPE: str', None, None) + + self.__file_name__s = file_name__s + self.__key_modified['File_Name__s'] = 1 + + def get_modified_time__s(self): + """ + The method to get the modified_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time__s + + def set_modified_time__s(self, modified_time__s): + """ + The method to set the value to modified_time__s + + Parameters: + modified_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if modified_time__s is not None and not isinstance(modified_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time__s EXPECTED TYPE: datetime', None, None) + + self.__modified_time__s = modified_time__s + self.__key_modified['Modified_Time__s'] = 1 + + def get_created_by__s(self): + """ + The method to get the created_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by__s + + def set_created_by__s(self, created_by__s): + """ + The method to set the value to created_by__s + + Parameters: + created_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by__s is not None and not isinstance(created_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by__s = created_by__s + self.__key_modified['Created_By__s'] = 1 + + def get_size__s(self): + """ + The method to get the size__s + + Returns: + string: A string representing the size__s + """ + + return self.__size__s + + def set_size__s(self, size__s): + """ + The method to set the value to size__s + + Parameters: + size__s (string) : A string representing the size__s + """ + + if size__s is not None and not isinstance(size__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size__s EXPECTED TYPE: str', None, None) + + self.__size__s = size__s + self.__key_modified['Size__s'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_owner__s(self): + """ + The method to get the owner__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner__s + + def set_owner__s(self, owner__s): + """ + The method to set the value to owner__s + + Parameters: + owner__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner__s is not None and not isinstance(owner__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner__s = owner__s + self.__key_modified['Owner__s'] = 1 + + def get_modified_by__s(self): + """ + The method to get the modified_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by__s + + def set_modified_by__s(self, modified_by__s): + """ + The method to set the value to modified_by__s + + Parameters: + modified_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by__s is not None and not isinstance(modified_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by__s = modified_by__s + self.__key_modified['Modified_By__s'] = 1 + + def get_file_id__s(self): + """ + The method to get the file_id__s + + Returns: + string: A string representing the file_id__s + """ + + return self.__file_id__s + + def set_file_id__s(self, file_id__s): + """ + The method to set the value to file_id__s + + Parameters: + file_id__s (string) : A string representing the file_id__s + """ + + if file_id__s is not None and not isinstance(file_id__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id__s EXPECTED TYPE: str', None, None) + + self.__file_id__s = file_id__s + self.__key_modified['File_Id__s'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + string: A string representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (string) : A string representing the delete + """ + + if delete is not None and not isinstance(delete, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: str', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/file_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/file_handler.py new file mode 100644 index 0000000..2f9df9c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/file_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class FileHandler(ABC): + def __init__(self): + """Creates an instance of FileHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/image_upload.py b/zohocrmsdk/src/com/zoho/crm/api/record/image_upload.py new file mode 100644 index 0000000..8d9af0f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/image_upload.py @@ -0,0 +1,418 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ImageUpload(object): + def __init__(self): + """Creates an instance of ImageUpload""" + + self.__preview_id__s = None + self.__file_name__s = None + self.__description__s = None + self.__size__s = None + self.__id = None + self.__sequence_number__s = None + self.__state__s = None + self.__file_id__s = None + self.__delete = None + self.__created_time__s = None + self.__modified_time__s = None + self.__created_by__s = None + self.__owner__s = None + self.__modified_by__s = None + self.__key_modified = dict() + + def get_preview_id__s(self): + """ + The method to get the preview_id__s + + Returns: + string: A string representing the preview_id__s + """ + + return self.__preview_id__s + + def set_preview_id__s(self, preview_id__s): + """ + The method to set the value to preview_id__s + + Parameters: + preview_id__s (string) : A string representing the preview_id__s + """ + + if preview_id__s is not None and not isinstance(preview_id__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preview_id__s EXPECTED TYPE: str', None, None) + + self.__preview_id__s = preview_id__s + self.__key_modified['Preview_Id__s'] = 1 + + def get_file_name__s(self): + """ + The method to get the file_name__s + + Returns: + string: A string representing the file_name__s + """ + + return self.__file_name__s + + def set_file_name__s(self, file_name__s): + """ + The method to set the value to file_name__s + + Parameters: + file_name__s (string) : A string representing the file_name__s + """ + + if file_name__s is not None and not isinstance(file_name__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_name__s EXPECTED TYPE: str', None, None) + + self.__file_name__s = file_name__s + self.__key_modified['File_Name__s'] = 1 + + def get_description__s(self): + """ + The method to get the description__s + + Returns: + string: A string representing the description__s + """ + + return self.__description__s + + def set_description__s(self, description__s): + """ + The method to set the value to description__s + + Parameters: + description__s (string) : A string representing the description__s + """ + + if description__s is not None and not isinstance(description__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: description__s EXPECTED TYPE: str', None, None) + + self.__description__s = description__s + self.__key_modified['Description__s'] = 1 + + def get_size__s(self): + """ + The method to get the size__s + + Returns: + string: A string representing the size__s + """ + + return self.__size__s + + def set_size__s(self, size__s): + """ + The method to set the value to size__s + + Parameters: + size__s (string) : A string representing the size__s + """ + + if size__s is not None and not isinstance(size__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size__s EXPECTED TYPE: str', None, None) + + self.__size__s = size__s + self.__key_modified['Size__s'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number__s(self): + """ + The method to get the sequence_number__s + + Returns: + int: An int representing the sequence_number__s + """ + + return self.__sequence_number__s + + def set_sequence_number__s(self, sequence_number__s): + """ + The method to set the value to sequence_number__s + + Parameters: + sequence_number__s (int) : An int representing the sequence_number__s + """ + + if sequence_number__s is not None and not isinstance(sequence_number__s, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sequence_number__s EXPECTED TYPE: int', None, None) + + self.__sequence_number__s = sequence_number__s + self.__key_modified['Sequence_Number__s'] = 1 + + def get_state__s(self): + """ + The method to get the state__s + + Returns: + string: A string representing the state__s + """ + + return self.__state__s + + def set_state__s(self, state__s): + """ + The method to set the value to state__s + + Parameters: + state__s (string) : A string representing the state__s + """ + + if state__s is not None and not isinstance(state__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state__s EXPECTED TYPE: str', None, None) + + self.__state__s = state__s + self.__key_modified['State__s'] = 1 + + def get_file_id__s(self): + """ + The method to get the file_id__s + + Returns: + string: A string representing the file_id__s + """ + + return self.__file_id__s + + def set_file_id__s(self, file_id__s): + """ + The method to set the value to file_id__s + + Parameters: + file_id__s (string) : A string representing the file_id__s + """ + + if file_id__s is not None and not isinstance(file_id__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: file_id__s EXPECTED TYPE: str', None, None) + + self.__file_id__s = file_id__s + self.__key_modified['File_Id__s'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + string: A string representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (string) : A string representing the delete + """ + + if delete is not None and not isinstance(delete, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: str', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def get_created_time__s(self): + """ + The method to get the created_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time__s + + def set_created_time__s(self, created_time__s): + """ + The method to set the value to created_time__s + + Parameters: + created_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time__s is not None and not isinstance(created_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time__s EXPECTED TYPE: datetime', None, None) + + self.__created_time__s = created_time__s + self.__key_modified['Created_Time__s'] = 1 + + def get_modified_time__s(self): + """ + The method to get the modified_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time__s + + def set_modified_time__s(self, modified_time__s): + """ + The method to set the value to modified_time__s + + Parameters: + modified_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if modified_time__s is not None and not isinstance(modified_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time__s EXPECTED TYPE: datetime', None, None) + + self.__modified_time__s = modified_time__s + self.__key_modified['Modified_Time__s'] = 1 + + def get_created_by__s(self): + """ + The method to get the created_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by__s + + def set_created_by__s(self, created_by__s): + """ + The method to set the value to created_by__s + + Parameters: + created_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by__s is not None and not isinstance(created_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by__s = created_by__s + self.__key_modified['Created_By__s'] = 1 + + def get_owner__s(self): + """ + The method to get the owner__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__owner__s + + def set_owner__s(self, owner__s): + """ + The method to set the value to owner__s + + Parameters: + owner__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if owner__s is not None and not isinstance(owner__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__owner__s = owner__s + self.__key_modified['Owner__s'] = 1 + + def get_modified_by__s(self): + """ + The method to get the modified_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by__s + + def set_modified_by__s(self, modified_by__s): + """ + The method to set the value to modified_by__s + + Parameters: + modified_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by__s is not None and not isinstance(modified_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by__s = modified_by__s + self.__key_modified['Modified_By__s'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/info.py b/zohocrmsdk/src/com/zoho/crm/api/record/info.py new file mode 100644 index 0000000..1158d1e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/info.py @@ -0,0 +1,326 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__call = None + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__email = None + self.__more_records = None + self.__sort_by = None + self.__sort_order = None + self.__key_modified = dict() + + def get_call(self): + """ + The method to get the call + + Returns: + bool: A bool representing the call + """ + + return self.__call + + def set_call(self, call): + """ + The method to set the value to call + + Parameters: + call (bool) : A bool representing the call + """ + + if call is not None and not isinstance(call, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call EXPECTED TYPE: bool', None, None) + + self.__call = call + self.__key_modified['call'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + bool: A bool representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (bool) : A bool representing the email + """ + + if email is not None and not isinstance(email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: bool', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/line_item_product.py b/zohocrmsdk/src/com/zoho/crm/api/record/line_item_product.py new file mode 100644 index 0000000..6f22b8e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/line_item_product.py @@ -0,0 +1,236 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class LineItemProduct(Record): + def __init__(self): + """Creates an instance of LineItemProduct""" + super().__init__() + + + def get_product_code(self): + """ + The method to get the product_code + + Returns: + string: A string representing the product_code + """ + + return self.get_key_value('Product_Code') + + def set_product_code(self, product_code): + """ + The method to set the value to product_code + + Parameters: + product_code (string) : A string representing the product_code + """ + + if product_code is not None and not isinstance(product_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: product_code EXPECTED TYPE: str', None, None) + + self.add_key_value('Product_Code', product_code) + + def get_currency(self): + """ + The method to get the currency + + Returns: + string: A string representing the currency + """ + + return self.get_key_value('Currency') + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (string) : A string representing the currency + """ + + if currency is not None and not isinstance(currency, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: str', None, None) + + self.add_key_value('Currency', currency) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/line_tax.py b/zohocrmsdk/src/com/zoho/crm/api/record/line_tax.py new file mode 100644 index 0000000..48e17d3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/line_tax.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LineTax(object): + def __init__(self): + """Creates an instance of LineTax""" + + self.__percentage = None + self.__name = None + self.__id = None + self.__value = None + self.__display_name = None + self.__key_modified = dict() + + def get_percentage(self): + """ + The method to get the percentage + + Returns: + float: A float representing the percentage + """ + + return self.__percentage + + def set_percentage(self, percentage): + """ + The method to set the value to percentage + + Parameters: + percentage (float) : A float representing the percentage + """ + + if percentage is not None and not isinstance(percentage, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: percentage EXPECTED TYPE: float', None, None) + + self.__percentage = percentage + self.__key_modified['percentage'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + float: A float representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (float) : A float representing the value + """ + + if value is not None and not isinstance(value, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: float', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def get_display_name(self): + """ + The method to get the display_name + + Returns: + string: A string representing the display_name + """ + + return self.__display_name + + def set_display_name(self, display_name): + """ + The method to set the value to display_name + + Parameters: + display_name (string) : A string representing the display_name + """ + + if display_name is not None and not isinstance(display_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_name EXPECTED TYPE: str', None, None) + + self.__display_name = display_name + self.__key_modified['display_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update.py new file mode 100644 index 0000000..0b8a08b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update.py @@ -0,0 +1,177 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response import MassUpdateResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .mass_update_response import MassUpdateResponse + + +class MassUpdate(MassUpdateResponse): + def __init__(self): + """Creates an instance of MassUpdate""" + super().__init__() + + self.__status = None + self.__failed_count = None + self.__updated_count = None + self.__not_updated_count = None + self.__total_count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def get_failed_count(self): + """ + The method to get the failed_count + + Returns: + int: An int representing the failed_count + """ + + return self.__failed_count + + def set_failed_count(self, failed_count): + """ + The method to set the value to failed_count + + Parameters: + failed_count (int) : An int representing the failed_count + """ + + if failed_count is not None and not isinstance(failed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: failed_count EXPECTED TYPE: int', None, None) + + self.__failed_count = failed_count + self.__key_modified['Failed_Count'] = 1 + + def get_updated_count(self): + """ + The method to get the updated_count + + Returns: + int: An int representing the updated_count + """ + + return self.__updated_count + + def set_updated_count(self, updated_count): + """ + The method to set the value to updated_count + + Parameters: + updated_count (int) : An int representing the updated_count + """ + + if updated_count is not None and not isinstance(updated_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: updated_count EXPECTED TYPE: int', None, None) + + self.__updated_count = updated_count + self.__key_modified['Updated_Count'] = 1 + + def get_not_updated_count(self): + """ + The method to get the not_updated_count + + Returns: + int: An int representing the not_updated_count + """ + + return self.__not_updated_count + + 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 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['Total_Count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_handler.py new file mode 100644 index 0000000..4d9126f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateActionHandler(ABC): + def __init__(self): + """Creates an instance of MassUpdateActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_response.py new file mode 100644 index 0000000..fc67129 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateActionResponse(ABC): + def __init__(self): + """Creates an instance of MassUpdateActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_wrapper.py new file mode 100644 index 0000000..5107719 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_handler import MassUpdateActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .mass_update_action_handler import MassUpdateActionHandler + + +class MassUpdateActionWrapper(MassUpdateActionHandler): + def __init__(self): + """Creates an instance of MassUpdateActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_body_wrapper.py new file mode 100644 index 0000000..41c0c8b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_body_wrapper.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MassUpdateBodyWrapper(object): + def __init__(self): + """Creates an instance of MassUpdateBodyWrapper""" + + self.__data = None + self.__cvid = None + self.__ids = None + self.__territory = None + self.__over_write = None + self.__criteria = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_cvid(self): + """ + The method to get the cvid + + Returns: + string: A string representing the cvid + """ + + return self.__cvid + + def set_cvid(self, cvid): + """ + The method to set the value to cvid + + Parameters: + cvid (string) : A string representing the cvid + """ + + if cvid is not None and not isinstance(cvid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cvid EXPECTED TYPE: str', None, None) + + self.__cvid = cvid + self.__key_modified['cvid'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + MassUpdateTerritory: An instance of MassUpdateTerritory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (MassUpdateTerritory) : An instance of MassUpdateTerritory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_territory import MassUpdateTerritory + except Exception: + from .mass_update_territory import MassUpdateTerritory + + if territory is not None and not isinstance(territory, MassUpdateTerritory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: MassUpdateTerritory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def get_over_write(self): + """ + The method to get the over_write + + Returns: + bool: A bool representing the over_write + """ + + return self.__over_write + + def set_over_write(self, over_write): + """ + The method to set the value to over_write + + Parameters: + over_write (bool) : A bool representing the over_write + """ + + if over_write is not None and not isinstance(over_write, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: over_write EXPECTED TYPE: bool', None, None) + + self.__over_write = over_write + self.__key_modified['over_write'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + list: An instance of list + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (list) : An instance of list + """ + + if criteria is not None and not isinstance(criteria, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: list', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response.py new file mode 100644 index 0000000..ae0fcbd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateResponse(ABC): + def __init__(self): + """Creates an instance of MassUpdateResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_handler.py new file mode 100644 index 0000000..881be87 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class MassUpdateResponseHandler(ABC): + def __init__(self): + """Creates an instance of MassUpdateResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_wrapper.py new file mode 100644 index 0000000..6fec7e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response_handler import MassUpdateResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .mass_update_response_handler import MassUpdateResponseHandler + + +class MassUpdateResponseWrapper(MassUpdateResponseHandler): + def __init__(self): + """Creates an instance of MassUpdateResponseWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_success_response.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_success_response.py new file mode 100644 index 0000000..a683600 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_response import MassUpdateActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .mass_update_action_response import MassUpdateActionResponse + + +class MassUpdateSuccessResponse(MassUpdateActionResponse): + def __init__(self): + """Creates an instance of MassUpdateSuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_territory.py b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_territory.py new file mode 100644 index 0000000..f32e3a2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/mass_update_territory.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MassUpdateTerritory(object): + def __init__(self): + """Creates an instance of MassUpdateTerritory""" + + self.__id = None + self.__include_child = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_include_child(self): + """ + The method to get the include_child + + Returns: + bool: A bool representing the include_child + """ + + return self.__include_child + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_lookup.py b/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_lookup.py new file mode 100644 index 0000000..a326778 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_lookup.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiSelectLookup(object): + def __init__(self): + """Creates an instance of MultiSelectLookup""" + + self.__id = None + self.__fieldname = None + self.__has_more = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_fieldname(self): + """ + The method to get the fieldname + + Returns: + dict: An instance of dict + """ + + return self.__fieldname + + def set_fieldname(self, fieldname): + """ + The method to set the value to fieldname + + Parameters: + fieldname (dict) : An instance of dict + """ + + if fieldname is not None and not isinstance(fieldname, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fieldname EXPECTED TYPE: dict', None, None) + + self.__fieldname = fieldname + self.__key_modified['fieldName'] = 1 + + def get_has_more(self): + """ + The method to get the has_more + + Returns: + dict: An instance of dict + """ + + return self.__has_more + + def set_has_more(self, has_more): + """ + The method to set the value to has_more + + Parameters: + has_more (dict) : An instance of dict + """ + + if has_more is not None and not isinstance(has_more, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: has_more EXPECTED TYPE: dict', None, None) + + self.__has_more = has_more + self.__key_modified['$has_more'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_picklist.py b/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_picklist.py new file mode 100644 index 0000000..95e01b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/multi_select_picklist.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MultiSelectPicklist(object): + def __init__(self): + """Creates an instance of MultiSelectPicklist""" + + self.__id = None + self.__fieldname = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_fieldname(self): + """ + The method to get the fieldname + + Returns: + dict: An instance of dict + """ + + return self.__fieldname + + def set_fieldname(self, fieldname): + """ + The method to set the value to fieldname + + Parameters: + fieldname (dict) : An instance of dict + """ + + if fieldname is not None and not isinstance(fieldname, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fieldname EXPECTED TYPE: dict', None, None) + + self.__fieldname = fieldname + self.__key_modified['fieldName'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/options.py b/zohocrmsdk/src/com/zoho/crm/api/record/options.py new file mode 100644 index 0000000..d09d8b2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/options.py @@ -0,0 +1,87 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Options(object): + def __init__(self): + """Creates an instance of Options""" + pass + + + + class RecordLockLockSourceS(object): + + @classmethod + def manual(cls): + return Choice('Manual') + + @classmethod + def automatic(cls): + return Choice('Automatic') + + + + + class UsersTimeFormat(object): + + @classmethod + def hhmm(cls): + return Choice('HH:mm') + + @classmethod + def hhmma(cls): + return Choice('hh:mm a') + + + + + class UsersDateFormat(object): + + @classmethod + def mmmdyyyy(cls): + return Choice('MMM d, yyyy') + + + + + class UsersDecimalSeparator(object): + + @classmethod + def comma(cls): + return Choice('Comma') + + @classmethod + def period(cls): + return Choice('Period') + + + + + class UsersNumberSeparator(object): + + @classmethod + def space(cls): + return Choice('Space') + + + + + class UsersNameFormatS(object): + + @classmethod + def salutationfirstnamelastname(cls): + return Choice('Salutation,First Name,Last Name') + + @classmethod + def saluationlastnamefirstname(cls): + return Choice('Saluation,Last Name,First Name') + + @classmethod + def firstnamelastnamesaluation(cls): + return Choice('First Name,Last Name,Saluation') + + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/participants.py b/zohocrmsdk/src/com/zoho/crm/api/record/participants.py new file mode 100644 index 0000000..8d7b1bb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/participants.py @@ -0,0 +1,305 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class Participants(Record): + def __init__(self): + """Creates an instance of Participants""" + super().__init__() + + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.get_key_value('Email') + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.add_key_value('Email', email) + + def get_invited(self): + """ + The method to get the invited + + Returns: + bool: A bool representing the invited + """ + + return self.get_key_value('invited') + + def set_invited(self, invited): + """ + The method to set the value to invited + + Parameters: + invited (bool) : A bool representing the invited + """ + + if invited is not None and not isinstance(invited, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: invited EXPECTED TYPE: bool', None, None) + + self.add_key_value('invited', invited) + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.get_key_value('type') + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.add_key_value('type', type) + + def get_participant(self): + """ + The method to get the participant + + Returns: + string: A string representing the participant + """ + + return self.get_key_value('participant') + + def set_participant(self, participant): + """ + The method to set the value to participant + + Parameters: + participant (string) : A string representing the participant + """ + + if participant is not None and not isinstance(participant, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: participant EXPECTED TYPE: str', None, None) + + self.add_key_value('participant', participant) + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.get_key_value('status') + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.add_key_value('status', status) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/price_book.py b/zohocrmsdk/src/com/zoho/crm/api/record/price_book.py new file mode 100644 index 0000000..9a7d579 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/price_book.py @@ -0,0 +1,190 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class PriceBook(Record): + def __init__(self): + """Creates an instance of PriceBook""" + super().__init__() + + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/pricing_details.py b/zohocrmsdk/src/com/zoho/crm/api/record/pricing_details.py new file mode 100644 index 0000000..2d01619 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/pricing_details.py @@ -0,0 +1,259 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.record import Record +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record import Record + + +class PricingDetails(Record): + def __init__(self): + """Creates an instance of PricingDetails""" + super().__init__() + + + def get_to_range(self): + """ + The method to get the to_range + + Returns: + float: A float representing the to_range + """ + + return self.get_key_value('to_range') + + def set_to_range(self, to_range): + """ + The method to set the value to to_range + + Parameters: + to_range (float) : A float representing the to_range + """ + + if to_range is not None and not isinstance(to_range, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to_range EXPECTED TYPE: float', None, None) + + self.add_key_value('to_range', to_range) + + def get_discount(self): + """ + The method to get the discount + + Returns: + float: A float representing the discount + """ + + return self.get_key_value('discount') + + def set_discount(self, discount): + """ + The method to set the value to discount + + Parameters: + discount (float) : A float representing the discount + """ + + if discount is not None and not isinstance(discount, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: discount EXPECTED TYPE: float', None, None) + + self.add_key_value('discount', discount) + + def get_from_range(self): + """ + The method to get the from_range + + Returns: + float: A float representing the from_range + """ + + return self.get_key_value('from_range') + + def set_from_range(self, from_range): + """ + The method to set the value to from_range + + Parameters: + from_range (float) : A float representing the from_range + """ + + if from_range is not None and not isinstance(from_range, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_range EXPECTED TYPE: float', None, None) + + self.add_key_value('from_range', from_range) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/record.py b/zohocrmsdk/src/com/zoho/crm/api/record/record.py new file mode 100644 index 0000000..8a65b5d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/record.py @@ -0,0 +1,288 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__key_values = dict() + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) + + def add_field_value(self, field, value): + """ + The method to add field value + + Parameters: + field (Field) : An instance of Field + value (object) : An object + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.add_key_value(field.get_api_name(), value) + + def add_key_value(self, api_name, value): + """ + The method to add key value + + Parameters: + api_name (string) : A string representing the api_name + value (Object) : A Object representing the value + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__key_values[api_name] = value + self.__key_modified[api_name] = 1 + + def get_key_value(self, api_name): + """ + The method to get key value + + Parameters: + api_name (string) : A string representing the api_name + + Returns: + Object: A Object representing the key_value + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + if api_name in self.__key_values: + return self.__key_values.get(api_name) + + return None + + def get_key_values(self): + """ + The method to get key values + + Returns: + dict: An instance of dict + """ + + return self.__key_values + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/record_operations.py b/zohocrmsdk/src/com/zoho/crm/api/record/record_operations.py new file mode 100644 index 0000000..e563cb5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/record_operations.py @@ -0,0 +1,1290 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + from ..header import Header + + +class RecordOperations(object): + def __init__(self, module_api_name): + """ + Creates an instance of RecordOperations with the given parameters + + Parameters: + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__module_api_name = module_api_name + + + def get_record(self, id, param_instance=None, header_instance=None): + """ + The method to get record + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_record(self, id, request, header_instance=None): + """ + The method to update record + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_record(self, id, param_instance=None, header_instance=None): + """ + The method to delete record + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_records(self, param_instance=None, header_instance=None): + """ + The method to get records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_records(self, request, header_instance=None): + """ + The method to create records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + 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_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_records(self, request, header_instance=None): + """ + The method to update records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + 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.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_records(self, param_instance=None, header_instance=None): + """ + The method to delete records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def upsert_records(self, request, header_instance=None): + """ + The method to upsert records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/upsert' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_deleted_records(self, param_instance=None, header_instance=None): + """ + The method to get deleted records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/deleted' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.deleted_records_handler import DeletedRecordsHandler + except Exception: + from .deleted_records_handler import DeletedRecordsHandler + return handler_instance.api_call(DeletedRecordsHandler.__module__, 'application/json') + + def search_records(self, param_instance=None, header_instance=None): + """ + The method to search records + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/search' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_photo(self, id): + """ + The method to get photo + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/photo' + 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) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.download_handler import DownloadHandler + except Exception: + from .download_handler import DownloadHandler + return handler_instance.api_call(DownloadHandler.__module__, 'application/x-download') + + def upload_photo(self, id, request, param_instance=None): + """ + The method to upload photo + + Parameters: + id (int) : An int representing the id + request (FileBodyWrapper) : An instance of FileBodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.file_body_wrapper import FileBodyWrapper + except Exception: + from .file_body_wrapper import FileBodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, FileBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: FileBodyWrapper', None, None) + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/photo' + 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('multipart/form-data') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + Utility.verify_photo_support(self.__module_api_name) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler + except Exception: + from .file_handler import FileHandler + return handler_instance.api_call(FileHandler.__module__, 'application/json') + + def delete_photo(self, id): + """ + The method to delete photo + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/photo' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler + except Exception: + from .file_handler import FileHandler + return handler_instance.api_call(FileHandler.__module__, 'application/json') + + def mass_update_records(self, request): + """ + The method to mass update records + + Parameters: + request (MassUpdateBodyWrapper) : An instance of MassUpdateBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_body_wrapper import MassUpdateBodyWrapper + except Exception: + from .mass_update_body_wrapper import MassUpdateBodyWrapper + + if request is not None and not isinstance(request, MassUpdateBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MassUpdateBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/mass_update' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_action_handler import MassUpdateActionHandler + except Exception: + from .mass_update_action_handler import MassUpdateActionHandler + return handler_instance.api_call(MassUpdateActionHandler.__module__, 'application/json') + + def get_mass_update_status(self, param_instance=None): + """ + The method to get mass update status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/mass_update' + 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.set_param(param_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.mass_update_response_handler import MassUpdateResponseHandler + except Exception: + from .mass_update_response_handler import MassUpdateResponseHandler + return handler_instance.api_call(MassUpdateResponseHandler.__module__, 'application/json') + + def assign_territories_to_multiple_records(self, request): + """ + The method to assign territories to multiple records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/assign_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def assign_territory_to_record(self, id, request): + """ + The method to assign territory to record + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/assign_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def remove_territories_from_multiple_records(self, request): + """ + The method to remove territories from multiple records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/remove_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def remove_territories_from_record(self, id, request): + """ + The method to remove territories from record + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/remove_territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_UPDATE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def record_count(self, param_instance=None): + """ + The method to record count + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/actions/count' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.count_handler import CountHandler + except Exception: + from .count_handler import CountHandler + return handler_instance.api_call(CountHandler.__module__, 'application/json') + + def get_record_using_external_id(self, external_field_value, param_instance=None, header_instance=None): + """ + The method to get record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_record_using_external_id(self, external_field_value, request, header_instance=None): + """ + The method to update record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_record_using_external_id(self, external_field_value, param_instance=None, header_instance=None): + """ + The method to delete record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def clone_record(self, id): + """ + The method to clone record + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/clone' + 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_mandatory_checker(True) + handler_instance.set_module_api_name(self.__module_api_name) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +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') + on_demand_properties = Param('on_demand_properties', 'com.zoho.crm.api.Record.GetRecordParam') + + +class GetRecordHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordHeader') + + +class UpdateRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordHeader') + + +class DeleteRecordParam(object): + wf_trigger = Param('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordParam') + + +class DeleteRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordHeader') + + +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') + page_token = Param('page_token', 'com.zoho.crm.api.Record.GetRecordsParam') + + +class GetRecordsHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordsHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordsHeader') + + +class CreateRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.CreateRecordsHeader') + + +class UpdateRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordsHeader') + + +class DeleteRecordsParam(object): + ids = Param('ids', 'com.zoho.crm.api.Record.DeleteRecordsParam') + wf_trigger = Param('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordsParam') + + +class DeleteRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordsHeader') + + +class UpsertRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpsertRecordsHeader') + + +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 GetDeletedRecordsHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetDeletedRecordsHeader') + + +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') + fields = Param('fields', 'com.zoho.crm.api.Record.SearchRecordsParam') + cvid = Param('cvid', 'com.zoho.crm.api.Record.SearchRecordsParam') + + +class SearchRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.SearchRecordsHeader') + + +class UploadPhotoParam(object): + restrict_triggers = Param('restrict_triggers', 'com.zoho.crm.api.Record.UploadPhotoParam') + + +class GetMassUpdateStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.Record.GetMassUpdateStatusParam') + + +class RecordCountParam(object): + criteria = Param('criteria', 'com.zoho.crm.api.Record.RecordCountParam') + email = Param('email', 'com.zoho.crm.api.Record.RecordCountParam') + phone = Param('phone', 'com.zoho.crm.api.Record.RecordCountParam') + word = Param('word', 'com.zoho.crm.api.Record.RecordCountParam') + + +class GetRecordUsingExternalIDParam(object): + approved = Param('approved', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + converted = Param('converted', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + cvid = Param('cvid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + uid = Param('uid', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + fields = Param('fields', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + startdatetime = Param('startDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + enddatetime = Param('endDateTime', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + territory_id = Param('territory_id', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + include_child = Param('include_child', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDParam') + + +class GetRecordUsingExternalIDHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.GetRecordUsingExternalIDHeader') + + +class UpdateRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.UpdateRecordUsingExternalIDHeader') + + +class DeleteRecordUsingExternalIDParam(object): + wf_trigger = Param('wf_trigger', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDParam') + + +class DeleteRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.Record.DeleteRecordUsingExternalIDHeader') diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/recurring_activity.py b/zohocrmsdk/src/com/zoho/crm/api/record/recurring_activity.py new file mode 100644 index 0000000..1c927f6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/recurring_activity.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RecurringActivity(object): + def __init__(self): + """Creates an instance of RecurringActivity""" + + self.__rrule = None + self.__exdate = None + self.__key_modified = dict() + + def get_rrule(self): + """ + The method to get the rrule + + Returns: + string: A string representing the rrule + """ + + return self.__rrule + + def set_rrule(self, rrule): + """ + The method to set the value to rrule + + Parameters: + rrule (string) : A string representing the rrule + """ + + if rrule is not None and not isinstance(rrule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rrule EXPECTED TYPE: str', None, None) + + self.__rrule = rrule + self.__key_modified['RRULE'] = 1 + + def get_exdate(self): + """ + The method to get the exdate + + Returns: + string: A string representing the exdate + """ + + return self.__exdate + + def set_exdate(self, exdate): + """ + The method to set the value to exdate + + Parameters: + exdate (string) : A string representing the exdate + """ + + if exdate is not None and not isinstance(exdate, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exdate EXPECTED TYPE: str', None, None) + + self.__exdate = exdate + self.__key_modified['EXDATE'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/remind_at.py b/zohocrmsdk/src/com/zoho/crm/api/record/remind_at.py new file mode 100644 index 0000000..75290e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/remind_at.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RemindAt(object): + def __init__(self): + """Creates an instance of RemindAt""" + + self.__alarm = None + self.__key_modified = dict() + + def get_alarm(self): + """ + The method to get the alarm + + Returns: + string: A string representing the alarm + """ + + return self.__alarm + + def set_alarm(self, alarm): + """ + The method to set the value to alarm + + Parameters: + alarm (string) : A string representing the alarm + """ + + if alarm is not None and not isinstance(alarm, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alarm EXPECTED TYPE: str', None, None) + + self.__alarm = alarm + self.__key_modified['ALARM'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/reminder.py b/zohocrmsdk/src/com/zoho/crm/api/record/reminder.py new file mode 100644 index 0000000..f6bba1c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/reminder.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Reminder(object): + def __init__(self): + """Creates an instance of Reminder""" + + self.__period = None + self.__unit = None + self.__time = None + self.__key_modified = dict() + + def get_period(self): + """ + The method to get the period + + Returns: + string: A string representing the period + """ + + return self.__period + + def set_period(self, period): + """ + The method to set the value to period + + Parameters: + period (string) : A string representing the period + """ + + if period is not None and not isinstance(period, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: period EXPECTED TYPE: str', None, None) + + self.__period = period + self.__key_modified['period'] = 1 + + def get_unit(self): + """ + The method to get the unit + + Returns: + int: An int representing the unit + """ + + return self.__unit + + def set_unit(self, unit): + """ + The method to set the value to unit + + Parameters: + unit (int) : An int representing the unit + """ + + if unit is not None and not isinstance(unit, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unit EXPECTED TYPE: int', None, None) + + self.__unit = unit + self.__key_modified['unit'] = 1 + + def get_time(self): + """ + The method to get the time + + Returns: + string: A string representing the time + """ + + return self.__time + + def set_time(self, time): + """ + The method to set the value to time + + Parameters: + time (string) : A string representing the time + """ + + if time is not None and not isinstance(time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time EXPECTED TYPE: str', None, None) + + self.__time = time + self.__key_modified['time'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record/response_wrapper.py new file mode 100644 index 0000000..9ec8d19 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/record/success_response.py new file mode 100644 index 0000000..5877fa7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/success_response.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record.file_handler import FileHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .file_handler import FileHandler + + +class SuccessResponse(ActionResponse, FileHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__duplicate_field = None + self.__action = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_duplicate_field(self): + """ + The method to get the duplicate_field + + Returns: + string: A string representing the duplicate_field + """ + + return self.__duplicate_field + + def set_duplicate_field(self, duplicate_field): + """ + The method to set the value to duplicate_field + + Parameters: + duplicate_field (string) : A string representing the duplicate_field + """ + + if duplicate_field is not None and not isinstance(duplicate_field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_field EXPECTED TYPE: str', None, None) + + self.__duplicate_field = duplicate_field + self.__key_modified['duplicate_field'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + Choice: An instance of Choice + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (Choice) : An instance of Choice + """ + + if action is not None and not isinstance(action, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: Choice', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/tax.py b/zohocrmsdk/src/com/zoho/crm/api/record/tax.py new file mode 100644 index 0000000..01b384f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/tax.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tax(object): + def __init__(self): + """Creates an instance of Tax""" + + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + string: A string representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (string) : A string representing the value + """ + + if value is not None and not isinstance(value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: str', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/territory.py b/zohocrmsdk/src/com/zoho/crm/api/record/territory.py new file mode 100644 index 0000000..dc0aa0a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/territory.py @@ -0,0 +1,181 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__assigned = None + self.__name = None + self.__id = None + self.__assigned_time = None + self.__assigned_by = None + self.__key_modified = dict() + + def get_assigned(self): + """ + The method to get the assigned + + Returns: + string: A string representing the assigned + """ + + return self.__assigned + + def set_assigned(self, assigned): + """ + The method to set the value to assigned + + Parameters: + assigned (string) : A string representing the assigned + """ + + if assigned is not None and not isinstance(assigned, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assigned EXPECTED TYPE: str', None, None) + + self.__assigned = assigned + self.__key_modified['$assigned'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_assigned_time(self): + """ + The method to get the assigned_time + + Returns: + datetime: An instance of datetime + """ + + return self.__assigned_time + + def set_assigned_time(self, assigned_time): + """ + The method to set the value to assigned_time + + Parameters: + assigned_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if assigned_time is not None and not isinstance(assigned_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assigned_time EXPECTED TYPE: datetime', None, None) + + self.__assigned_time = assigned_time + self.__key_modified['$assigned_time'] = 1 + + def get_assigned_by(self): + """ + The method to get the assigned_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__assigned_by + + def set_assigned_by(self, assigned_by): + """ + The method to set the value to assigned_by + + Parameters: + assigned_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if assigned_by is not None and not isinstance(assigned_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assigned_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__assigned_by = assigned_by + self.__key_modified['$assigned_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/time_range.py b/zohocrmsdk/src/com/zoho/crm/api/record/time_range.py new file mode 100644 index 0000000..1230a55 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/time_range.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TimeRange(object): + def __init__(self): + """Creates an instance of TimeRange""" + + self.__from_1 = None + self.__to = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + string: A string representing the from_1 + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (string) : A string representing the from_1 + """ + + if from_1 is not None and not isinstance(from_1, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: str', None, None) + + self.__from_1 = from_1 + self.__key_modified['From'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + string: A string representing the to + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (string) : A string representing the to + """ + + if to is not None and not isinstance(to, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: str', None, None) + + self.__to = to + self.__key_modified['To'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/widget.py b/zohocrmsdk/src/com/zoho/crm/api/record/widget.py new file mode 100644 index 0000000..8a3d04b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/widget.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Widget(object): + def __init__(self): + """Creates an instance of Widget""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record/wizard.py b/zohocrmsdk/src/com/zoho/crm/api/record/wizard.py new file mode 100644 index 0000000..5edbd89 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record/wizard.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wizard(object): + def __init__(self): + """Creates an instance of Wizard""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/__init__.py new file mode 100644 index 0000000..337f82d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/__init__.py @@ -0,0 +1,13 @@ +from .action_wrapper import ActionWrapper +from .record_locking_operations import RecordLockingOperations, GetRecordLockingInformationsParam, GetRecordLockingInformationParam +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .locked_for_s import LockedForS +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .record_lock import RecordLock +from .lock_record import LockRecord +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_wrapper.py new file mode 100644 index 0000000..9189b26 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/api_exception.py new file mode 100644 index 0000000..4939b53 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/info.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/info.py new file mode 100644 index 0000000..1158d1e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/info.py @@ -0,0 +1,326 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__call = None + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__email = None + self.__more_records = None + self.__sort_by = None + self.__sort_order = None + self.__key_modified = dict() + + def get_call(self): + """ + The method to get the call + + Returns: + bool: A bool representing the call + """ + + return self.__call + + def set_call(self, call): + """ + The method to set the value to call + + Parameters: + call (bool) : A bool representing the call + """ + + if call is not None and not isinstance(call, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call EXPECTED TYPE: bool', None, None) + + self.__call = call + self.__key_modified['call'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + bool: A bool representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (bool) : A bool representing the email + """ + + if email is not None and not isinstance(email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: bool', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_sort_by(self): + """ + The method to get the sort_by + + Returns: + string: A string representing the sort_by + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (string) : A string representing the sort_by + """ + + if sort_by is not None and not isinstance(sort_by, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: str', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/lock_record.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/lock_record.py new file mode 100644 index 0000000..27d2437 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/lock_record.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockRecord(object): + def __init__(self): + """Creates an instance of LockRecord""" + + self.__locked_reason__s = None + self.__key_modified = dict() + + def get_locked_reason__s(self): + """ + The method to get the locked_reason__s + + Returns: + string: A string representing the locked_reason__s + """ + + return self.__locked_reason__s + + def set_locked_reason__s(self, locked_reason__s): + """ + The method to set the value to locked_reason__s + + Parameters: + locked_reason__s (string) : A string representing the locked_reason__s + """ + + if locked_reason__s is not None and not isinstance(locked_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_reason__s EXPECTED TYPE: str', None, None) + + self.__locked_reason__s = locked_reason__s + self.__key_modified['Locked_Reason__s'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/locked_for_s.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/locked_for_s.py new file mode 100644 index 0000000..aa16775 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/locked_for_s.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockedForS(object): + def __init__(self): + """Creates an instance of LockedForS""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + dict: An instance of dict + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (dict) : An instance of dict + """ + + if module is not None and not isinstance(module, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: dict', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_lock.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_lock.py new file mode 100644 index 0000000..f5a9831 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_lock.py @@ -0,0 +1,361 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record import Record +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from ..record import Record + + +class RecordLock(Record): + def __init__(self): + """Creates an instance of RecordLock""" + super().__init__() + + + def get_lock_source__s(self): + """ + The method to get the lock_source__s + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('lock_source__s') + + def set_lock_source__s(self, lock_source__s): + """ + The method to set the value to lock_source__s + + Parameters: + lock_source__s (Choice) : An instance of Choice + """ + + if lock_source__s is not None and not isinstance(lock_source__s, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_source__s EXPECTED TYPE: Choice', None, None) + + self.add_key_value('lock_source__s', lock_source__s) + + def get_locked_by__s(self): + """ + The method to get the locked_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('locked_by__s') + + def set_locked_by__s(self, locked_by__s): + """ + The method to set the value to locked_by__s + + Parameters: + locked_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if locked_by__s is not None and not isinstance(locked_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('locked_by__s', locked_by__s) + + def get_locked_for_s(self): + """ + The method to get the locked_for_s + + Returns: + LockedForS: An instance of LockedForS + """ + + return self.get_key_value('locked_for_s') + + def set_locked_for_s(self, locked_for_s): + """ + The method to set the value to locked_for_s + + Parameters: + locked_for_s (LockedForS) : An instance of LockedForS + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.locked_for_s import LockedForS + except Exception: + from .locked_for_s import LockedForS + + if locked_for_s is not None and not isinstance(locked_for_s, LockedForS): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_for_s EXPECTED TYPE: LockedForS', None, None) + + self.add_key_value('locked_for_s', locked_for_s) + + def get_locked_reason__s(self): + """ + The method to get the locked_reason__s + + Returns: + string: A string representing the locked_reason__s + """ + + return self.get_key_value('locked_reason__s') + + def set_locked_reason__s(self, locked_reason__s): + """ + The method to set the value to locked_reason__s + + Parameters: + locked_reason__s (string) : A string representing the locked_reason__s + """ + + if locked_reason__s is not None and not isinstance(locked_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_reason__s EXPECTED TYPE: str', None, None) + + self.add_key_value('locked_reason__s', locked_reason__s) + + def get_locked_time__s(self): + """ + The method to get the locked_time__s + + Returns: + string: A string representing the locked_time__s + """ + + return self.get_key_value('Locked_time__s') + + def set_locked_time__s(self, locked_time__s): + """ + The method to set the value to locked_time__s + + Parameters: + locked_time__s (string) : A string representing the locked_time__s + """ + + if locked_time__s is not None and not isinstance(locked_time__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_time__s EXPECTED TYPE: str', None, None) + + self.add_key_value('Locked_time__s', locked_time__s) + + def get_record_locking_configuration_id__s(self): + """ + The method to get the record_locking_configuration_id__s + + Returns: + int: An int representing the record_locking_configuration_id__s + """ + + return self.get_key_value('record_locking_configuration_id__s') + + def set_record_locking_configuration_id__s(self, record_locking_configuration_id__s): + """ + The method to set the value to record_locking_configuration_id__s + + Parameters: + record_locking_configuration_id__s (int) : An int representing the record_locking_configuration_id__s + """ + + if record_locking_configuration_id__s is not None and not isinstance(record_locking_configuration_id__s, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configuration_id__s EXPECTED TYPE: int', None, None) + + self.add_key_value('record_locking_configuration_id__s', record_locking_configuration_id__s) + + def get_record_locking_rule_id__s(self): + """ + The method to get the record_locking_rule_id__s + + Returns: + int: An int representing the record_locking_rule_id__s + """ + + return self.get_key_value('record_locking_rule_id__s') + + def set_record_locking_rule_id__s(self, record_locking_rule_id__s): + """ + The method to set the value to record_locking_rule_id__s + + Parameters: + record_locking_rule_id__s (int) : An int representing the record_locking_rule_id__s + """ + + if record_locking_rule_id__s is not None and not isinstance(record_locking_rule_id__s, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_rule_id__s EXPECTED TYPE: int', None, None) + + self.add_key_value('record_locking_rule_id__s', record_locking_rule_id__s) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_locking_operations.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_locking_operations.py new file mode 100644 index 0000000..2e3eb27 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/record_locking_operations.py @@ -0,0 +1,252 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + + +class RecordLockingOperations(object): + def __init__(self, record_id, module_name): + """ + Creates an instance of RecordLockingOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module_name (string) : A string representing the module_name + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module_name = module_name + + + def get_record_locking_informations(self, param_instance=None): + """ + The method to get record locking informations + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s' + 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.set_param(param_instance) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def lock_records(self, request): + """ + The method to lock records + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s' + 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.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_record_locking_information(self, lock_id, param_instance=None): + """ + The method to get record locking information + + Parameters: + lock_id (int) : An int representing the lock_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(lock_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_id EXPECTED TYPE: int', None, None) + + 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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s/' + api_path = api_path + str(lock_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.set_param(param_instance) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_record_locking_information(self, lock_id, request): + """ + The method to update record locking information + + Parameters: + lock_id (int) : An int representing the lock_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(lock_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_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/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s/' + api_path = api_path + str(lock_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.set_mandatory_checker(True) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def unlock_record(self, lock_id): + """ + The method to unlock record + + Parameters: + lock_id (int) : An int representing the lock_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(lock_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_name) + api_path = api_path + '/' + api_path = api_path + str(self.__record_id) + api_path = api_path + '/Locking_Information__s/' + api_path = api_path + str(lock_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_module_api_name("Locking_Information__s") + Utility.get_fields("Locking_Information__s", handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetRecordLockingInformationsParam(object): + fields = Param('fields', 'com.zoho.crm.api.RecordLocking.GetRecordLockingInformationsParam') + ids = Param('ids', 'com.zoho.crm.api.RecordLocking.GetRecordLockingInformationsParam') + + +class GetRecordLockingInformationParam(object): + fields = Param('fields', 'com.zoho.crm.api.RecordLocking.GetRecordLockingInformationParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_wrapper.py new file mode 100644 index 0000000..e940333 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking/success_response.py new file mode 100644 index 0000000..91d9911 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking/success_response.py @@ -0,0 +1,202 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__duplicate_field = None + self.__action = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_duplicate_field(self): + """ + The method to get the duplicate_field + + Returns: + string: A string representing the duplicate_field + """ + + return self.__duplicate_field + + def set_duplicate_field(self, duplicate_field): + """ + The method to set the value to duplicate_field + + Parameters: + duplicate_field (string) : A string representing the duplicate_field + """ + + if duplicate_field is not None and not isinstance(duplicate_field, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: duplicate_field EXPECTED TYPE: str', None, None) + + self.__duplicate_field = duplicate_field + self.__key_modified['duplicate_field'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + Choice: An instance of Choice + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (Choice) : An instance of Choice + """ + + if action is not None and not isinstance(action, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: Choice', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/__init__.py new file mode 100644 index 0000000..9d3c651 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/__init__.py @@ -0,0 +1,13 @@ +from .dependee import Dependee +from .action_wrapper import ActionWrapper +from .criteria import Criteria +from .body_wrapper import BodyWrapper +from .lock_excluded_profile import LockExcludedProfile +from .locking_rules import LockingRules +from .api_exception import APIException +from .action_response import ActionResponse +from .field import Field +from .restricted_custom_button import RestrictedCustomButton +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .record_lock import RecordLock diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_wrapper.py new file mode 100644 index 0000000..a0047a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__record_locking_configurations = None + self.__key_modified = dict() + + def get_record_locking_configurations(self): + """ + The method to get the record_locking_configurations + + Returns: + list: An instance of list + """ + + return self.__record_locking_configurations + + def set_record_locking_configurations(self, record_locking_configurations): + """ + The method to set the value to record_locking_configurations + + Parameters: + record_locking_configurations (list) : An instance of list + """ + + if record_locking_configurations is not None and not isinstance(record_locking_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configurations EXPECTED TYPE: list', None, None) + + self.__record_locking_configurations = record_locking_configurations + self.__key_modified['record_locking_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/api_exception.py new file mode 100644 index 0000000..49d630f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class APIException(ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/body_wrapper.py new file mode 100644 index 0000000..26a229e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__record_locking_configurations = None + self.__key_modified = dict() + + def get_record_locking_configurations(self): + """ + The method to get the record_locking_configurations + + Returns: + list: An instance of list + """ + + return self.__record_locking_configurations + + def set_record_locking_configurations(self, record_locking_configurations): + """ + The method to set the value to record_locking_configurations + + Parameters: + record_locking_configurations (list) : An instance of list + """ + + if record_locking_configurations is not None and not isinstance(record_locking_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configurations EXPECTED TYPE: list', None, None) + + self.__record_locking_configurations = record_locking_configurations + self.__key_modified['record_locking_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/criteria.py new file mode 100644 index 0000000..2ff3aa4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/dependee.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/dependee.py new file mode 100644 index 0000000..fb318b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/dependee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Dependee(object): + def __init__(self): + """Creates an instance of Dependee""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/field.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/lock_excluded_profile.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/lock_excluded_profile.py new file mode 100644 index 0000000..94b33e0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/lock_excluded_profile.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockExcludedProfile(object): + def __init__(self): + """Creates an instance of LockExcludedProfile""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/locking_rules.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/locking_rules.py new file mode 100644 index 0000000..33d7e66 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/locking_rules.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LockingRules(object): + def __init__(self): + """Creates an instance of LockingRules""" + + self.__name = None + self.__id = None + self.__lock_existing_records = None + self.__criteria = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_lock_existing_records(self): + """ + The method to get the lock_existing_records + + Returns: + bool: A bool representing the lock_existing_records + """ + + return self.__lock_existing_records + + def set_lock_existing_records(self, lock_existing_records): + """ + The method to set the value to lock_existing_records + + Parameters: + lock_existing_records (bool) : A bool representing the lock_existing_records + """ + + if lock_existing_records is not None and not isinstance(lock_existing_records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_existing_records EXPECTED TYPE: bool', None, None) + + self.__lock_existing_records = lock_existing_records + self.__key_modified['lock_existing_records'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/record_lock.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/record_lock.py new file mode 100644 index 0000000..57c1696 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/record_lock.py @@ -0,0 +1,463 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class RecordLock(object): + def __init__(self): + """Creates an instance of RecordLock""" + + self.__created_time = None + self.__locked_for = None + self.__excluded_fields = None + self.__created_by = None + self.__feature_type = None + self.__locking_rules = None + self.__restricted_actions = None + self.__lock_for_portal_users = None + self.__modified_time = None + self.__restricted_communications = None + self.__system_defined = None + self.__modified_by = None + self.__id = None + self.__lock_type = None + self.__restricted_custom_buttons = None + self.__lock_excluded_profiles = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_locked_for(self): + """ + The method to get the locked_for + + Returns: + string: A string representing the locked_for + """ + + return self.__locked_for + + def set_locked_for(self, locked_for): + """ + The method to set the value to locked_for + + Parameters: + locked_for (string) : A string representing the locked_for + """ + + if locked_for is not None and not isinstance(locked_for, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_for EXPECTED TYPE: str', None, None) + + self.__locked_for = locked_for + self.__key_modified['locked_for'] = 1 + + def get_excluded_fields(self): + """ + The method to get the excluded_fields + + Returns: + list: An instance of list + """ + + return self.__excluded_fields + + def set_excluded_fields(self, excluded_fields): + """ + The method to set the value to excluded_fields + + Parameters: + excluded_fields (list) : An instance of list + """ + + if excluded_fields is not None and not isinstance(excluded_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: excluded_fields EXPECTED TYPE: list', None, None) + + self.__excluded_fields = excluded_fields + self.__key_modified['excluded_fields'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_feature_type(self): + """ + The method to get the feature_type + + Returns: + string: A string representing the feature_type + """ + + return self.__feature_type + + def set_feature_type(self, feature_type): + """ + The method to set the value to feature_type + + Parameters: + feature_type (string) : A string representing the feature_type + """ + + if feature_type is not None and not isinstance(feature_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature_type EXPECTED TYPE: str', None, None) + + self.__feature_type = feature_type + self.__key_modified['feature_type'] = 1 + + def get_locking_rules(self): + """ + The method to get the locking_rules + + Returns: + list: An instance of list + """ + + return self.__locking_rules + + def set_locking_rules(self, locking_rules): + """ + The method to set the value to locking_rules + + Parameters: + locking_rules (list) : An instance of list + """ + + if locking_rules is not None and not isinstance(locking_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locking_rules EXPECTED TYPE: list', None, None) + + self.__locking_rules = locking_rules + self.__key_modified['locking_rules'] = 1 + + def get_restricted_actions(self): + """ + The method to get the restricted_actions + + Returns: + list: An instance of list + """ + + return self.__restricted_actions + + def set_restricted_actions(self, restricted_actions): + """ + The method to set the value to restricted_actions + + Parameters: + restricted_actions (list) : An instance of list + """ + + if restricted_actions is not None and not isinstance(restricted_actions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_actions EXPECTED TYPE: list', None, None) + + self.__restricted_actions = restricted_actions + self.__key_modified['restricted_actions'] = 1 + + def get_lock_for_portal_users(self): + """ + The method to get the lock_for_portal_users + + Returns: + bool: A bool representing the lock_for_portal_users + """ + + return self.__lock_for_portal_users + + def set_lock_for_portal_users(self, lock_for_portal_users): + """ + The method to set the value to lock_for_portal_users + + Parameters: + lock_for_portal_users (bool) : A bool representing the lock_for_portal_users + """ + + if lock_for_portal_users is not None and not isinstance(lock_for_portal_users, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_for_portal_users EXPECTED TYPE: bool', None, None) + + self.__lock_for_portal_users = lock_for_portal_users + self.__key_modified['lock_for_portal_users'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_restricted_communications(self): + """ + The method to get the restricted_communications + + Returns: + list: An instance of list + """ + + return self.__restricted_communications + + def set_restricted_communications(self, restricted_communications): + """ + The method to set the value to restricted_communications + + Parameters: + restricted_communications (list) : An instance of list + """ + + if restricted_communications is not None and not isinstance(restricted_communications, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_communications EXPECTED TYPE: list', None, None) + + self.__restricted_communications = restricted_communications + self.__key_modified['restricted_communications'] = 1 + + def get_system_defined(self): + """ + The method to get the system_defined + + Returns: + bool: A bool representing the system_defined + """ + + return self.__system_defined + + def set_system_defined(self, system_defined): + """ + The method to set the value to system_defined + + Parameters: + system_defined (bool) : A bool representing the system_defined + """ + + if system_defined is not None and not isinstance(system_defined, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: system_defined EXPECTED TYPE: bool', None, None) + + self.__system_defined = system_defined + self.__key_modified['system_defined'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_lock_type(self): + """ + The method to get the lock_type + + Returns: + Choice: An instance of Choice + """ + + return self.__lock_type + + def set_lock_type(self, lock_type): + """ + The method to set the value to lock_type + + Parameters: + lock_type (Choice) : An instance of Choice + """ + + if lock_type is not None and not isinstance(lock_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_type EXPECTED TYPE: Choice', None, None) + + self.__lock_type = lock_type + self.__key_modified['lock_type'] = 1 + + def get_restricted_custom_buttons(self): + """ + The method to get the restricted_custom_buttons + + Returns: + list: An instance of list + """ + + return self.__restricted_custom_buttons + + def set_restricted_custom_buttons(self, restricted_custom_buttons): + """ + The method to set the value to restricted_custom_buttons + + Parameters: + restricted_custom_buttons (list) : An instance of list + """ + + if restricted_custom_buttons is not None and not isinstance(restricted_custom_buttons, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: restricted_custom_buttons EXPECTED TYPE: list', None, None) + + self.__restricted_custom_buttons = restricted_custom_buttons + self.__key_modified['restricted_custom_buttons'] = 1 + + def get_lock_excluded_profiles(self): + """ + The method to get the lock_excluded_profiles + + Returns: + list: An instance of list + """ + + return self.__lock_excluded_profiles + + def set_lock_excluded_profiles(self, lock_excluded_profiles): + """ + The method to set the value to lock_excluded_profiles + + Parameters: + lock_excluded_profiles (list) : An instance of list + """ + + if lock_excluded_profiles is not None and not isinstance(lock_excluded_profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lock_excluded_profiles EXPECTED TYPE: list', None, None) + + self.__lock_excluded_profiles = lock_excluded_profiles + self.__key_modified['lock_excluded_profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/response_wrapper.py new file mode 100644 index 0000000..e190173 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__record_locking_configurations = None + self.__key_modified = dict() + + def get_record_locking_configurations(self): + """ + The method to get the record_locking_configurations + + Returns: + list: An instance of list + """ + + return self.__record_locking_configurations + + def set_record_locking_configurations(self, record_locking_configurations): + """ + The method to set the value to record_locking_configurations + + Parameters: + record_locking_configurations (list) : An instance of list + """ + + if record_locking_configurations is not None and not isinstance(record_locking_configurations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_locking_configurations EXPECTED TYPE: list', None, None) + + self.__record_locking_configurations = record_locking_configurations + self.__key_modified['record_locking_configurations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/restricted_custom_button.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/restricted_custom_button.py new file mode 100644 index 0000000..751948d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/restricted_custom_button.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RestrictedCustomButton(object): + def __init__(self): + """Creates an instance of RestrictedCustomButton""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/success_response.py new file mode 100644 index 0000000..ae8c634 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/record_locking_configuration/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/__init__.py new file mode 100644 index 0000000..b84fcd2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/__init__.py @@ -0,0 +1,7 @@ +from .related_lists_operations import RelatedListsOperations, GetRelatedListsParam, GetRelatedListParam +from .api_exception import APIException +from .response_handler import ResponseHandler +from .field import Field +from .response_wrapper import ResponseWrapper +from .related_list import RelatedList +from .module_map import ModuleMap diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/api_exception.py new file mode 100644 index 0000000..9e9f19b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/field.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/module_map.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/module_map.py new file mode 100644 index 0000000..cec4563 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/module_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ModuleMap(object): + def __init__(self): + """Creates an instance of ModuleMap""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_list.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_list.py new file mode 100644 index 0000000..902ab93 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_list.py @@ -0,0 +1,534 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class RelatedList(object): + def __init__(self): + """Creates an instance of RelatedList""" + + self.__id = None + self.__sequence_number = None + self.__display_label = None + self.__api_name = None + self.__module = None + self.__name = None + self.__action = None + self.__href = None + self.__type = None + self.__connectedmodule = None + self.__linkingmodule = None + self.__visible = None + self.__customize_sort = None + self.__customize_fields = None + self.__customize_display_label = None + self.__sort_by = None + self.__sort_order = None + self.__fields = None + self.__status = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + string: A string representing the sequence_number + """ + + return self.__sequence_number + + def set_sequence_number(self, sequence_number): + """ + The method to set the value to sequence_number + + Parameters: + sequence_number (string) : A string representing the sequence_number + """ + + if sequence_number is not None and not isinstance(sequence_number, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sequence_number EXPECTED TYPE: str', None, None) + + self.__sequence_number = sequence_number + self.__key_modified['sequence_number'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + ModuleMap: An instance of ModuleMap + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (ModuleMap) : An instance of ModuleMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.module_map import ModuleMap + except Exception: + from .module_map import ModuleMap + + if module is not None and not isinstance(module, ModuleMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: ModuleMap', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + string: A string representing the action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (string) : A string representing the action + """ + + if action is not None and not isinstance(action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: str', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_href(self): + """ + The method to get the href + + Returns: + string: A string representing the href + """ + + return self.__href + + def set_href(self, href): + """ + The method to set the value to href + + Parameters: + href (string) : A string representing the href + """ + + if href is not None and not isinstance(href, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: href EXPECTED TYPE: str', None, None) + + self.__href = href + self.__key_modified['href'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_connectedmodule(self): + """ + The method to get the connectedmodule + + Returns: + string: A string representing the connectedmodule + """ + + return self.__connectedmodule + + def set_connectedmodule(self, connectedmodule): + """ + The method to set the value to connectedmodule + + Parameters: + connectedmodule (string) : A string representing the connectedmodule + """ + + if connectedmodule is not None and not isinstance(connectedmodule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: connectedmodule EXPECTED TYPE: str', None, None) + + self.__connectedmodule = connectedmodule + self.__key_modified['connectedmodule'] = 1 + + def get_linkingmodule(self): + """ + The method to get the linkingmodule + + Returns: + string: A string representing the linkingmodule + """ + + return self.__linkingmodule + + def set_linkingmodule(self, linkingmodule): + """ + The method to set the value to linkingmodule + + Parameters: + linkingmodule (string) : A string representing the linkingmodule + """ + + if linkingmodule is not None and not isinstance(linkingmodule, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linkingmodule EXPECTED TYPE: str', None, None) + + self.__linkingmodule = linkingmodule + self.__key_modified['linkingmodule'] = 1 + + def get_visible(self): + """ + The method to get the visible + + Returns: + bool: A bool representing the visible + """ + + return self.__visible + + def set_visible(self, visible): + """ + The method to set the value to visible + + Parameters: + visible (bool) : A bool representing the visible + """ + + if visible is not None and not isinstance(visible, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visible EXPECTED TYPE: bool', None, None) + + self.__visible = visible + self.__key_modified['visible'] = 1 + + def get_customize_sort(self): + """ + The method to get the customize_sort + + Returns: + bool: A bool representing the customize_sort + """ + + return self.__customize_sort + + def set_customize_sort(self, customize_sort): + """ + The method to set the value to customize_sort + + Parameters: + customize_sort (bool) : A bool representing the customize_sort + """ + + if customize_sort is not None and not isinstance(customize_sort, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_sort EXPECTED TYPE: bool', None, None) + + self.__customize_sort = customize_sort + self.__key_modified['customize_sort'] = 1 + + def get_customize_fields(self): + """ + The method to get the customize_fields + + Returns: + bool: A bool representing the customize_fields + """ + + return self.__customize_fields + + def set_customize_fields(self, customize_fields): + """ + The method to set the value to customize_fields + + Parameters: + customize_fields (bool) : A bool representing the customize_fields + """ + + if customize_fields is not None and not isinstance(customize_fields, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_fields EXPECTED TYPE: bool', None, None) + + self.__customize_fields = customize_fields + self.__key_modified['customize_fields'] = 1 + + def get_customize_display_label(self): + """ + The method to get the customize_display_label + + Returns: + bool: A bool representing the customize_display_label + """ + + return self.__customize_display_label + + def set_customize_display_label(self, customize_display_label): + """ + The method to set the value to customize_display_label + + Parameters: + customize_display_label (bool) : A bool representing the customize_display_label + """ + + if customize_display_label is not None and not isinstance(customize_display_label, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_display_label EXPECTED TYPE: bool', None, None) + + self.__customize_display_label = customize_display_label + self.__key_modified['customize_display_label'] = 1 + + def get_sort_by(self): + """ + The method to get the sort_by + + Returns: + Field: An instance of Field + """ + + return self.__sort_by + + def set_sort_by(self, sort_by): + """ + The method to set the value to sort_by + + Parameters: + sort_by (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.field import Field + except Exception: + from .field import Field + + if sort_by is not None and not isinstance(sort_by, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_by EXPECTED TYPE: Field', None, None) + + self.__sort_by = sort_by + self.__key_modified['sort_by'] = 1 + + def get_sort_order(self): + """ + The method to get the sort_order + + Returns: + string: A string representing the sort_order + """ + + return self.__sort_order + + def set_sort_order(self, sort_order): + """ + The method to set the value to sort_order + + Parameters: + sort_order (string) : A string representing the sort_order + """ + + if sort_order is not None and not isinstance(sort_order, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order EXPECTED TYPE: str', None, None) + + self.__sort_order = sort_order + self.__key_modified['sort_order'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_lists_operations.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_lists_operations.py new file mode 100644 index 0000000..0dedf0f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/related_lists_operations.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class RelatedListsOperations(object): + def __init__(self, layout_id=None): + """ + Creates an instance of RelatedListsOperations with the given parameters + + Parameters: + layout_id (int) : An int representing the layout_id + """ + + if layout_id is not None and not isinstance(layout_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout_id EXPECTED TYPE: int', None, None) + + self.__layout_id = layout_id + + + def get_related_lists(self, param_instance=None): + """ + The method to get related lists + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/related_lists' + 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('layout_id', 'com.zoho.crm.api.RelatedLists.GetRelatedListsParam'), self.__layout_id) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_related_list(self, id, param_instance=None): + """ + The method to get related list + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/related_lists/' + 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('layout_id', 'com.zoho.crm.api.RelatedLists.GetRelatedListParam'), self.__layout_id) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetRelatedListsParam(object): + module = Param('module', 'com.zoho.crm.api.RelatedLists.GetRelatedListsParam') + + +class GetRelatedListParam(object): + module = Param('module', 'com.zoho.crm.api.RelatedLists.GetRelatedListParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_wrapper.py new file mode 100644 index 0000000..bc30bbf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_lists/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.related_lists.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__related_lists = None + self.__key_modified = dict() + + def get_related_lists(self): + """ + The method to get the related_lists + + Returns: + list: An instance of list + """ + + return self.__related_lists + + def set_related_lists(self, related_lists): + """ + The method to set the value to related_lists + + Parameters: + related_lists (list) : An instance of list + """ + + if related_lists is not None and not isinstance(related_lists, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_lists EXPECTED TYPE: list', None, None) + + self.__related_lists = related_lists + self.__key_modified['related_lists'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/__init__.py new file mode 100644 index 0000000..274a90f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .file_body_wrapper import FileBodyWrapper +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .related_records_operations import RelatedRecordsOperations, GetRelatedRecordsParam, GetRelatedRecordsHeader, UpdateRelatedRecordsHeader, DelinkRecordsParam, DelinkRecordsHeader, GetRelatedRecordsUsingExternalIDParam, GetRelatedRecordsUsingExternalIDHeader, UpdateRelatedRecordsUsingExternalIDHeader, DeleteRelatedRecordsUsingExternalIDParam, DeleteRelatedRecordsUsingExternalIDHeader, GetRelatedRecordParam, GetRelatedRecordHeader, UpdateRelatedRecordHeader, DelinkRecordHeader, GetRelatedRecordUsingExternalIDParam, GetRelatedRecordUsingExternalIDHeader, UpdateRelatedRecordUsingExternalIDHeader, DeleteRelatedRecordUsingExternalIDHeader, GetDeletedParentRecordsRelatedRecordParam diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/action_wrapper.py new file mode 100644 index 0000000..93e99a0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/api_exception.py new file mode 100644 index 0000000..182b2be --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/file_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/file_body_wrapper.py new file mode 100644 index 0000000..fcfdf6c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/file_body_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import StreamWrapper, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import StreamWrapper, Constants + from .response_handler import ResponseHandler + + +class FileBodyWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of FileBodyWrapper""" + super().__init__() + + self.__file = None + self.__key_modified = dict() + + def get_file(self): + """ + The method to get the file + + Returns: + StreamWrapper: An instance of StreamWrapper + """ + + return self.__file + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/related_records_operations.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/related_records_operations.py new file mode 100644 index 0000000..e477259 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/related_records_operations.py @@ -0,0 +1,845 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Utility, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Utility, Constants + from ..param import Param + from ..header import Header + + +class RelatedRecordsOperations(object): + def __init__(self, related_list_api_name, module_api_name): + """ + Creates an instance of RelatedRecordsOperations with the given parameters + + Parameters: + related_list_api_name (string) : A string representing the related_list_api_name + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(related_list_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_list_api_name EXPECTED TYPE: str', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__related_list_api_name = related_list_api_name + self.__module_api_name = module_api_name + + + def get_related_records(self, record_id, param_instance=None, header_instance=None): + """ + The method to get related records + + Parameters: + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_records(self, record_id, request, header_instance=None): + """ + The method to update related records + + Parameters: + record_id (int) : An int representing the record_id + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delink_records(self, record_id, param_instance=None, header_instance=None): + """ + The method to delink records + + Parameters: + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_related_records_using_external_id(self, external_value, param_instance=None, header_instance=None): + """ + The method to get related records using external id + + Parameters: + external_value (string) : A string representing the external_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_records_using_external_id(self, external_value, request, header_instance=None): + """ + The method to update related records using external id + + Parameters: + external_value (string) : A string representing the external_value + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_related_records_using_external_id(self, external_value, param_instance=None, header_instance=None): + """ + The method to delete related records using external id + + Parameters: + external_value (string) : A string representing the external_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_related_record(self, related_record_id, record_id, param_instance=None, header_instance=None): + """ + The method to get related record + + Parameters: + related_record_id (int) : An int representing the related_record_id + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(related_record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: int', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(related_record_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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_record(self, related_record_id, record_id, request, header_instance=None): + """ + The method to update related record + + Parameters: + related_record_id (int) : An int representing the related_record_id + record_id (int) : An int representing the record_id + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(related_record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: int', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(related_record_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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delink_record(self, related_record_id, record_id, header_instance=None): + """ + The method to delink record + + Parameters: + related_record_id (int) : An int representing the related_record_id + record_id (int) : An int representing the record_id + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(related_record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record_id EXPECTED TYPE: int', None, None) + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(related_record_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_header(header_instance) + Utility.get_fields(self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_related_record_using_external_id(self, external_field_value, external_value, param_instance=None, header_instance=None): + """ + The method to get related record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + external_value (string) : A string representing the external_value + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_related_record_using_external_id(self, external_field_value, external_value, request, header_instance=None): + """ + The method to update related record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + external_value (string) : A string representing the external_value + request (BodyWrapper) : An instance of BodyWrapper + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + 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.set_mandatory_checker(True) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_related_record_using_external_id(self, external_field_value, external_value, header_instance=None): + """ + The method to delete related record using external id + + Parameters: + external_field_value (string) : A string representing the external_field_value + external_value (string) : A string representing the external_value + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(external_field_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_field_value EXPECTED TYPE: str', None, None) + + if not isinstance(external_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: external_value EXPECTED TYPE: str', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_value) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + api_path = api_path + '/' + api_path = api_path + str(external_field_value) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_header(header_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_deleted_parent_records_related_record(self, record_id, param_instance=None): + """ + The method to get deleted parent records related record + + Parameters: + record_id (int) : An int representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + 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/v7/' + api_path = api_path + str(self.__module_api_name) + api_path = api_path + '/deleted/' + api_path = api_path + str(record_id) + api_path = api_path + '/' + api_path = api_path + str(self.__related_list_api_name) + 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.set_param(param_instance) + Utility.get_related_lists(self.__related_list_api_name, self.__module_api_name, handler_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetRelatedRecordsParam(object): + page = Param('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam') + per_page = Param('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam') + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsParam') + + +class GetRelatedRecordsHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsHeader') + + +class UpdateRelatedRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordsHeader') + + +class DelinkRecordsParam(object): + ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsParam') + + +class DelinkRecordsHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordsHeader') + + +class GetRelatedRecordsUsingExternalIDParam(object): + page = Param('page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam') + per_page = Param('per_page', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam') + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDParam') + + +class GetRelatedRecordsUsingExternalIDHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordsUsingExternalIDHeader') + + +class UpdateRelatedRecordsUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordsUsingExternalIDHeader') + + +class DeleteRelatedRecordsUsingExternalIDParam(object): + ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordsUsingExternalIDParam') + + +class DeleteRelatedRecordsUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordsUsingExternalIDHeader') + + +class GetRelatedRecordParam(object): + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordParam') + + +class GetRelatedRecordHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordHeader') + + +class UpdateRelatedRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordHeader') + + +class DelinkRecordHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DelinkRecordHeader') + + +class GetRelatedRecordUsingExternalIDParam(object): + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDParam') + + +class GetRelatedRecordUsingExternalIDHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDHeader') + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.GetRelatedRecordUsingExternalIDHeader') + + +class UpdateRelatedRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.UpdateRelatedRecordUsingExternalIDHeader') + + +class DeleteRelatedRecordUsingExternalIDHeader(object): + x_external = Header('X-EXTERNAL', 'com.zoho.crm.api.RelatedRecords.DeleteRelatedRecordUsingExternalIDHeader') + + +class GetDeletedParentRecordsRelatedRecordParam(object): + fields = Param('fields', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') + page = Param('page', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') + per_page = Param('per_page', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') + ids = Param('ids', 'com.zoho.crm.api.RelatedRecords.GetDeletedParentRecordsRelatedRecordParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/response_wrapper.py new file mode 100644 index 0000000..32f102c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Info + except Exception: + from ..record import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/related_records/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/related_records/success_response.py new file mode 100644 index 0000000..87ebd71 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/related_records/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.related_records.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/request_proxy.py b/zohocrmsdk/src/com/zoho/crm/api/request_proxy.py new file mode 100755 index 0000000..7419864 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/request_proxy.py @@ -0,0 +1,66 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants +except Exception: + from .exception import SDKException + from .util import Constants + + +class RequestProxy(object): + def __init__(self, host, port, user=None, password=""): + + """ + Creates a RequestProxy class instance with the specified parameters. + + Parameters: + host(str): A String containing the hostname or address of the proxy server + port(int): An Integer containing The port number of the proxy server + user(str): A String containing the user name of the proxy server + password(str) : A String containing the password of the proxy server. Default value is an empty string + + Raises: + SDKException + """ + + if host is None: + raise SDKException(Constants.USER_PROXY_ERROR, Constants.HOST_ERROR_MESSAGE) + + if port is None: + raise SDKException(Constants.USER_PROXY_ERROR, Constants.PORT_ERROR_MESSAGE) + + self.__host = host + self.__port = port + self.__user = user + self.__password = password + + def get_host(self): + """ + This is a getter method to get __host. + + Returns: + string: A string representing __host + """ + + def get_port(self): + """ + This is a getter method to get __port. + + Returns: + string: A string representing __port + """ + + def get_user(self): + """ + This is a getter method to get __user. + + Returns: + string: A string representing __user + """ + + def get_password(self): + """ + This is a getter method to get __password. + + Returns: + string: A string representing __password + """ \ No newline at end of file diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/__init__.py new file mode 100644 index 0000000..53e9483 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .reschedule_history import RescheduleHistory +from .approval import Approval +from .appointment_name import AppointmentName +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .user import User +from .reschedule_history_operations import RescheduleHistoryOperations, GetAppointmentsRescheduledHistoryParam, GetAppointmentRescheduledHistoryParam +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_wrapper.py new file mode 100644 index 0000000..433d399 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/api_exception.py new file mode 100644 index 0000000..3c3dc1e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/appointment_name.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/appointment_name.py new file mode 100644 index 0000000..f415c32 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/appointment_name.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AppointmentName(object): + def __init__(self): + """Creates an instance of AppointmentName""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/approval.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/approval.py new file mode 100644 index 0000000..fc87dfb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/approval.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Approval(object): + def __init__(self): + """Creates an instance of Approval""" + + self.__delegate = None + self.__approve = None + self.__reject = None + self.__resubmit = None + self.__key_modified = dict() + + def get_delegate(self): + """ + The method to get the delegate + + Returns: + bool: A bool representing the delegate + """ + + return self.__delegate + + def set_delegate(self, delegate): + """ + The method to set the value to delegate + + Parameters: + delegate (bool) : A bool representing the delegate + """ + + if delegate is not None and not isinstance(delegate, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delegate EXPECTED TYPE: bool', None, None) + + self.__delegate = delegate + self.__key_modified['delegate'] = 1 + + def get_approve(self): + """ + The method to get the approve + + Returns: + bool: A bool representing the approve + """ + + return self.__approve + + def set_approve(self, approve): + """ + The method to set the value to approve + + Parameters: + approve (bool) : A bool representing the approve + """ + + if approve is not None and not isinstance(approve, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approve EXPECTED TYPE: bool', None, None) + + self.__approve = approve + self.__key_modified['approve'] = 1 + + def get_reject(self): + """ + The method to get the reject + + Returns: + bool: A bool representing the reject + """ + + return self.__reject + + def set_reject(self, reject): + """ + The method to set the value to reject + + Parameters: + reject (bool) : A bool representing the reject + """ + + if reject is not None and not isinstance(reject, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reject EXPECTED TYPE: bool', None, None) + + self.__reject = reject + self.__key_modified['reject'] = 1 + + def get_resubmit(self): + """ + The method to get the resubmit + + Returns: + bool: A bool representing the resubmit + """ + + return self.__resubmit + + def set_resubmit(self, resubmit): + """ + The method to set the value to resubmit + + Parameters: + resubmit (bool) : A bool representing the resubmit + """ + + if resubmit is not None and not isinstance(resubmit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resubmit EXPECTED TYPE: bool', None, None) + + self.__resubmit = resubmit + self.__key_modified['resubmit'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/info.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/info.py new file mode 100644 index 0000000..cbb4d4c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/info.py @@ -0,0 +1,226 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history.py new file mode 100644 index 0000000..8516070 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history.py @@ -0,0 +1,759 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RescheduleHistory(object): + def __init__(self): + """Creates an instance of RescheduleHistory""" + + self.__currency_symbol = None + self.__rescheduled_to = None + self.__review_process = None + self.__reschedule_reason = None + self.__sharing_permission = None + self.__name = None + self.__modified_by = None + self.__review = None + self.__rescheduled_by = None + self.__state = None + self.__canvas_id = None + self.__process_flow = None + self.__id = None + self.__rescheduled_time = None + self.__zia_visions = None + self.__approved = None + self.__modified_time = None + self.__approval = None + self.__created_time = None + self.__rescheduled_from = None + self.__appointment_name = None + self.__editable = None + self.__orchestration = None + self.__in_merge = None + self.__created_by = None + self.__approval_state = None + self.__reschedule_note = None + self.__key_modified = dict() + + def get_currency_symbol(self): + """ + The method to get the currency_symbol + + Returns: + string: A string representing the currency_symbol + """ + + return self.__currency_symbol + + def set_currency_symbol(self, currency_symbol): + """ + The method to set the value to currency_symbol + + Parameters: + currency_symbol (string) : A string representing the currency_symbol + """ + + if currency_symbol is not None and not isinstance(currency_symbol, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency_symbol EXPECTED TYPE: str', None, None) + + self.__currency_symbol = currency_symbol + self.__key_modified['$currency_symbol'] = 1 + + def get_rescheduled_to(self): + """ + The method to get the rescheduled_to + + Returns: + datetime: An instance of datetime + """ + + return self.__rescheduled_to + + def set_rescheduled_to(self, rescheduled_to): + """ + The method to set the value to rescheduled_to + + Parameters: + rescheduled_to (datetime) : An instance of datetime + """ + + from datetime import datetime + + if rescheduled_to is not None and not isinstance(rescheduled_to, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_to EXPECTED TYPE: datetime', None, None) + + self.__rescheduled_to = rescheduled_to + self.__key_modified['Rescheduled_To'] = 1 + + def get_review_process(self): + """ + The method to get the review_process + + Returns: + bool: A bool representing the review_process + """ + + return self.__review_process + + def set_review_process(self, review_process): + """ + The method to set the value to review_process + + Parameters: + review_process (bool) : A bool representing the review_process + """ + + if review_process is not None and not isinstance(review_process, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: review_process EXPECTED TYPE: bool', None, None) + + self.__review_process = review_process + self.__key_modified['$review_process'] = 1 + + def get_reschedule_reason(self): + """ + The method to get the reschedule_reason + + Returns: + string: A string representing the reschedule_reason + """ + + return self.__reschedule_reason + + def set_reschedule_reason(self, reschedule_reason): + """ + The method to set the value to reschedule_reason + + Parameters: + reschedule_reason (string) : A string representing the reschedule_reason + """ + + if reschedule_reason is not None and not isinstance(reschedule_reason, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reschedule_reason EXPECTED TYPE: str', None, None) + + self.__reschedule_reason = reschedule_reason + self.__key_modified['Reschedule_Reason'] = 1 + + def get_sharing_permission(self): + """ + The method to get the sharing_permission + + Returns: + string: A string representing the sharing_permission + """ + + return self.__sharing_permission + + def set_sharing_permission(self, sharing_permission): + """ + The method to set the value to sharing_permission + + Parameters: + sharing_permission (string) : A string representing the sharing_permission + """ + + if sharing_permission is not None and not isinstance(sharing_permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sharing_permission EXPECTED TYPE: str', None, None) + + self.__sharing_permission = sharing_permission + self.__key_modified['$sharing_permission'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['Modified_By'] = 1 + + def get_review(self): + """ + The method to get the review + + Returns: + bool: A bool representing the review + """ + + return self.__review + + def set_review(self, review): + """ + The method to set the value to review + + Parameters: + review (bool) : A bool representing the review + """ + + if review is not None and not isinstance(review, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: review EXPECTED TYPE: bool', None, None) + + self.__review = review + self.__key_modified['$review'] = 1 + + def get_rescheduled_by(self): + """ + The method to get the rescheduled_by + + Returns: + User: An instance of User + """ + + return self.__rescheduled_by + + def set_rescheduled_by(self, rescheduled_by): + """ + The method to set the value to rescheduled_by + + Parameters: + rescheduled_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.user import User + except Exception: + from .user import User + + if rescheduled_by is not None and not isinstance(rescheduled_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_by EXPECTED TYPE: User', None, None) + + self.__rescheduled_by = rescheduled_by + self.__key_modified['Rescheduled_By'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['$state'] = 1 + + def get_canvas_id(self): + """ + The method to get the canvas_id + + Returns: + string: A string representing the canvas_id + """ + + return self.__canvas_id + + def set_canvas_id(self, canvas_id): + """ + The method to set the value to canvas_id + + Parameters: + canvas_id (string) : A string representing the canvas_id + """ + + if canvas_id is not None and not isinstance(canvas_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: canvas_id EXPECTED TYPE: str', None, None) + + self.__canvas_id = canvas_id + self.__key_modified['$canvas_id'] = 1 + + def get_process_flow(self): + """ + The method to get the process_flow + + Returns: + bool: A bool representing the process_flow + """ + + return self.__process_flow + + def set_process_flow(self, process_flow): + """ + The method to set the value to process_flow + + Parameters: + process_flow (bool) : A bool representing the process_flow + """ + + if process_flow is not None and not isinstance(process_flow, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_flow EXPECTED TYPE: bool', None, None) + + self.__process_flow = process_flow + self.__key_modified['$process_flow'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_rescheduled_time(self): + """ + The method to get the rescheduled_time + + Returns: + datetime: An instance of datetime + """ + + return self.__rescheduled_time + + def set_rescheduled_time(self, rescheduled_time): + """ + The method to set the value to rescheduled_time + + Parameters: + rescheduled_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if rescheduled_time is not None and not isinstance(rescheduled_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_time EXPECTED TYPE: datetime', None, None) + + self.__rescheduled_time = rescheduled_time + self.__key_modified['Rescheduled_Time'] = 1 + + def get_zia_visions(self): + """ + The method to get the zia_visions + + Returns: + bool: A bool representing the zia_visions + """ + + return self.__zia_visions + + def set_zia_visions(self, zia_visions): + """ + The method to set the value to zia_visions + + Parameters: + zia_visions (bool) : A bool representing the zia_visions + """ + + if zia_visions is not None and not isinstance(zia_visions, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_visions EXPECTED TYPE: bool', None, None) + + self.__zia_visions = zia_visions + self.__key_modified['$zia_visions'] = 1 + + def get_approved(self): + """ + The method to get the approved + + Returns: + bool: A bool representing the approved + """ + + return self.__approved + + def set_approved(self, approved): + """ + The method to set the value to approved + + Parameters: + approved (bool) : A bool representing the approved + """ + + if approved is not None and not isinstance(approved, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approved EXPECTED TYPE: bool', None, None) + + self.__approved = approved + self.__key_modified['$approved'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_approval(self): + """ + The method to get the approval + + Returns: + Approval: An instance of Approval + """ + + return self.__approval + + def set_approval(self, approval): + """ + The method to set the value to approval + + Parameters: + approval (Approval) : An instance of Approval + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.approval import Approval + except Exception: + from .approval import Approval + + if approval is not None and not isinstance(approval, Approval): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approval EXPECTED TYPE: Approval', None, None) + + self.__approval = approval + self.__key_modified['$approval'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['Created_Time'] = 1 + + def get_rescheduled_from(self): + """ + The method to get the rescheduled_from + + Returns: + datetime: An instance of datetime + """ + + return self.__rescheduled_from + + def set_rescheduled_from(self, rescheduled_from): + """ + The method to set the value to rescheduled_from + + Parameters: + rescheduled_from (datetime) : An instance of datetime + """ + + from datetime import datetime + + if rescheduled_from is not None and not isinstance(rescheduled_from, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rescheduled_from EXPECTED TYPE: datetime', None, None) + + self.__rescheduled_from = rescheduled_from + self.__key_modified['Rescheduled_From'] = 1 + + def get_appointment_name(self): + """ + The method to get the appointment_name + + Returns: + AppointmentName: An instance of AppointmentName + """ + + return self.__appointment_name + + def set_appointment_name(self, appointment_name): + """ + The method to set the value to appointment_name + + Parameters: + appointment_name (AppointmentName) : An instance of AppointmentName + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.appointment_name import AppointmentName + except Exception: + from .appointment_name import AppointmentName + + if appointment_name is not None and not isinstance(appointment_name, AppointmentName): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: appointment_name EXPECTED TYPE: AppointmentName', None, None) + + self.__appointment_name = appointment_name + self.__key_modified['Appointment_Name'] = 1 + + def get_editable(self): + """ + The method to get the editable + + Returns: + bool: A bool representing the editable + """ + + return self.__editable + + def set_editable(self, editable): + """ + The method to set the value to editable + + Parameters: + editable (bool) : A bool representing the editable + """ + + if editable is not None and not isinstance(editable, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: editable EXPECTED TYPE: bool', None, None) + + self.__editable = editable + self.__key_modified['$editable'] = 1 + + def get_orchestration(self): + """ + The method to get the orchestration + + Returns: + bool: A bool representing the orchestration + """ + + return self.__orchestration + + def set_orchestration(self, orchestration): + """ + The method to set the value to orchestration + + Parameters: + orchestration (bool) : A bool representing the orchestration + """ + + if orchestration is not None and not isinstance(orchestration, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: orchestration EXPECTED TYPE: bool', None, None) + + self.__orchestration = orchestration + self.__key_modified['$orchestration'] = 1 + + def get_in_merge(self): + """ + The method to get the in_merge + + Returns: + bool: A bool representing the in_merge + """ + + return self.__in_merge + + def set_in_merge(self, in_merge): + """ + The method to set the value to in_merge + + Parameters: + in_merge (bool) : A bool representing the in_merge + """ + + if in_merge is not None and not isinstance(in_merge, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: in_merge EXPECTED TYPE: bool', None, None) + + self.__in_merge = in_merge + self.__key_modified['$in_merge'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['Created_By'] = 1 + + def get_approval_state(self): + """ + The method to get the approval_state + + Returns: + string: A string representing the approval_state + """ + + return self.__approval_state + + def set_approval_state(self, approval_state): + """ + The method to set the value to approval_state + + Parameters: + approval_state (string) : A string representing the approval_state + """ + + if approval_state is not None and not isinstance(approval_state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approval_state EXPECTED TYPE: str', None, None) + + self.__approval_state = approval_state + self.__key_modified['$approval_state'] = 1 + + def get_reschedule_note(self): + """ + The method to get the reschedule_note + + Returns: + string: A string representing the reschedule_note + """ + + return self.__reschedule_note + + def set_reschedule_note(self, reschedule_note): + """ + The method to set the value to reschedule_note + + Parameters: + reschedule_note (string) : A string representing the reschedule_note + """ + + if reschedule_note is not None and not isinstance(reschedule_note, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reschedule_note EXPECTED TYPE: str', None, None) + + self.__reschedule_note = reschedule_note + self.__key_modified['Reschedule_Note'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.py new file mode 100644 index 0000000..88b2463 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/reschedule_history_operations.py @@ -0,0 +1,247 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class RescheduleHistoryOperations(object): + def __init__(self): + """Creates an instance of RescheduleHistoryOperations""" + pass + + def add_appointments_rescheduled_history(self, request): + """ + The method to add appointments rescheduled history + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Appointments_Rescheduled_History__s' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_appointments_rescheduled_history(self, request): + """ + The method to update appointments rescheduled history + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/Appointments_Rescheduled_History__s' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_appointments_rescheduled_history(self, param_instance=None): + """ + The method to get appointments rescheduled history + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/Appointments_Rescheduled_History__s' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_appointment_rescheduled_history(self, id, request): + """ + The method to update appointment rescheduled history + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/Appointments_Rescheduled_History__s/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_appointment_rescheduled_history(self, id, param_instance=None): + """ + The method to get appointment rescheduled history + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/Appointments_Rescheduled_History__s/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_appointments_rescheduled_history(self, id): + """ + The method to delete appointments rescheduled history + + 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/v7/Appointments_Rescheduled_History__s/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetAppointmentsRescheduledHistoryParam(object): + fields = Param('fields', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + page = Param('page', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + per_page = Param('per_page', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + ids = Param('ids', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentsRescheduledHistoryParam') + + +class GetAppointmentRescheduledHistoryParam(object): + fields = Param('fields', 'com.zoho.crm.api.RescheduleHistory.GetAppointmentRescheduledHistoryParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_wrapper.py new file mode 100644 index 0000000..9f6af18 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__data = None + self.__info = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/success_response.py new file mode 100644 index 0000000..eabbba2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.reschedule_history.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/user.py b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/user.py new file mode 100644 index 0000000..bf4dd24 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/reschedule_history/user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/roles/__init__.py new file mode 100644 index 0000000..9e6098e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/__init__.py @@ -0,0 +1,11 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .role import Role +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .roles_operations import RolesOperations, DeleteRoleParam +from .reporting_to import ReportingTo diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/roles/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/roles/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/roles/action_wrapper.py new file mode 100644 index 0000000..7bc8f5d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__roles = None + self.__key_modified = dict() + + def get_roles(self): + """ + The method to get the roles + + Returns: + list: An instance of list + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (list) : An instance of list + """ + + if roles is not None and not isinstance(roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: list', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/roles/api_exception.py new file mode 100644 index 0000000..c80d827 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/roles/body_wrapper.py new file mode 100644 index 0000000..a5559da --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__roles = None + self.__key_modified = dict() + + def get_roles(self): + """ + The method to get the roles + + Returns: + list: An instance of list + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (list) : An instance of list + """ + + if roles is not None and not isinstance(roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: list', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/reporting_to.py b/zohocrmsdk/src/com/zoho/crm/api/roles/reporting_to.py new file mode 100644 index 0000000..44dcbf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/reporting_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReportingTo(object): + def __init__(self): + """Creates an instance of ReportingTo""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/roles/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/roles/response_wrapper.py new file mode 100644 index 0000000..305361b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__roles = None + self.__key_modified = dict() + + def get_roles(self): + """ + The method to get the roles + + Returns: + list: An instance of list + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (list) : An instance of list + """ + + if roles is not None and not isinstance(roles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: list', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/role.py b/zohocrmsdk/src/com/zoho/crm/api/roles/role.py new file mode 100644 index 0000000..1e2b0bf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/role.py @@ -0,0 +1,373 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Role(object): + def __init__(self): + """Creates an instance of Role""" + + self.__display_label = None + self.__forecast_manager = None + self.__reporting_to = None + self.__share_with_peers = None + self.__description = None + self.__id = None + self.__name = None + self.__created_by__s = None + self.__modified_by__s = None + self.__modified_time__s = None + self.__created_time__s = None + self.__admin_user = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_forecast_manager(self): + """ + The method to get the forecast_manager + + Returns: + ReportingTo: An instance of ReportingTo + """ + + return self.__forecast_manager + + def set_forecast_manager(self, forecast_manager): + """ + The method to set the value to forecast_manager + + Parameters: + forecast_manager (ReportingTo) : An instance of ReportingTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.reporting_to import ReportingTo + except Exception: + from .reporting_to import ReportingTo + + if forecast_manager is not None and not isinstance(forecast_manager, ReportingTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: forecast_manager EXPECTED TYPE: ReportingTo', None, None) + + self.__forecast_manager = forecast_manager + self.__key_modified['forecast_manager'] = 1 + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + ReportingTo: An instance of ReportingTo + """ + + return self.__reporting_to + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (ReportingTo) : An instance of ReportingTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.reporting_to import ReportingTo + except Exception: + from .reporting_to import ReportingTo + + if reporting_to is not None and not isinstance(reporting_to, ReportingTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: ReportingTo', None, None) + + self.__reporting_to = reporting_to + self.__key_modified['reporting_to'] = 1 + + def get_share_with_peers(self): + """ + The method to get the share_with_peers + + Returns: + bool: A bool representing the share_with_peers + """ + + return self.__share_with_peers + + def set_share_with_peers(self, share_with_peers): + """ + The method to set the value to share_with_peers + + Parameters: + share_with_peers (bool) : A bool representing the share_with_peers + """ + + if share_with_peers is not None and not isinstance(share_with_peers, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_with_peers EXPECTED TYPE: bool', None, None) + + self.__share_with_peers = share_with_peers + self.__key_modified['share_with_peers'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_created_by__s(self): + """ + The method to get the created_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by__s + + def set_created_by__s(self, created_by__s): + """ + The method to set the value to created_by__s + + Parameters: + created_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by__s is not None and not isinstance(created_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by__s = created_by__s + self.__key_modified['created_by__s'] = 1 + + def get_modified_by__s(self): + """ + The method to get the modified_by__s + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by__s + + def set_modified_by__s(self, modified_by__s): + """ + The method to set the value to modified_by__s + + Parameters: + modified_by__s (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by__s is not None and not isinstance(modified_by__s, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by__s EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by__s = modified_by__s + self.__key_modified['modified_by__s'] = 1 + + def get_modified_time__s(self): + """ + The method to get the modified_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time__s + + def set_modified_time__s(self, modified_time__s): + """ + The method to set the value to modified_time__s + + Parameters: + modified_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if modified_time__s is not None and not isinstance(modified_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time__s EXPECTED TYPE: datetime', None, None) + + self.__modified_time__s = modified_time__s + self.__key_modified['modified_time__s'] = 1 + + def get_created_time__s(self): + """ + The method to get the created_time__s + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time__s + + def set_created_time__s(self, created_time__s): + """ + The method to set the value to created_time__s + + Parameters: + created_time__s (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time__s is not None and not isinstance(created_time__s, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time__s EXPECTED TYPE: datetime', None, None) + + self.__created_time__s = created_time__s + self.__key_modified['created_time__s'] = 1 + + def get_admin_user(self): + """ + The method to get the admin_user + + Returns: + bool: A bool representing the admin_user + """ + + return self.__admin_user + + def set_admin_user(self, admin_user): + """ + The method to set the value to admin_user + + Parameters: + admin_user (bool) : A bool representing the admin_user + """ + + if admin_user is not None and not isinstance(admin_user, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: admin_user EXPECTED TYPE: bool', None, None) + + self.__admin_user = admin_user + self.__key_modified['admin_user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/roles_operations.py b/zohocrmsdk/src/com/zoho/crm/api/roles/roles_operations.py new file mode 100644 index 0000000..1e6cbbb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/roles_operations.py @@ -0,0 +1,227 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class RolesOperations(object): + def __init__(self): + """Creates an instance of RolesOperations""" + pass + + def get_roles(self): + """ + The method to get roles + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_roles(self, request): + """ + The method to create roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/roles' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_roles(self, request): + """ + The method to update roles + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/roles' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_role(self, role_id): + """ + The method to get role + + Parameters: + role_id (int) : An int representing the role_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(role_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/roles/' + api_path = api_path + str(role_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_role(self, role_id, request): + """ + The method to update role + + Parameters: + role_id (int) : An int representing the role_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(role_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role_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/v7/settings/roles/' + api_path = api_path + str(role_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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_role(self, role_id, param_instance=None): + """ + The method to delete role + + Parameters: + role_id (int) : An int representing the role_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(role_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role_id EXPECTED TYPE: int', None, None) + + 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/v7/settings/roles/' + api_path = api_path + str(role_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.roles.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class DeleteRoleParam(object): + transfer_to_id = Param('transfer_to_id', 'com.zoho.crm.api.Roles.DeleteRoleParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/roles/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/roles/success_response.py new file mode 100644 index 0000000..9877ae0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/roles/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.roles.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/__init__.py new file mode 100644 index 0000000..e157ef4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/__init__.py @@ -0,0 +1,20 @@ +from .action_wrapper import ActionWrapper +from .field_rule import FieldRule +from .scoring_rule import ScoringRule +from .criteria import Criteria +from .layout_request_wrapper import LayoutRequestWrapper +from .body_wrapper import BodyWrapper +from .expected_field import ExpectedField +from .signal_rule import SignalRule +from .layout import Layout +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .scoring_rules_operations import ScoringRulesOperations, GetScoringRulesParam, DeleteScoringRulesParam, GetScoringRuleParam +from .field import Field +from .success_response import SuccessResponse +from .role_request_wrapper import RoleRequestWrapper +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .signal import Signal +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_wrapper.py new file mode 100644 index 0000000..360bf4a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__scoring_rules = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/api_exception.py new file mode 100644 index 0000000..6bdc9b2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/body_wrapper.py new file mode 100644 index 0000000..1920c40 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__scoring_rules = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/criteria.py new file mode 100644 index 0000000..29b13d6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/expected_field.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/expected_field.py new file mode 100644 index 0000000..f7bbab1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/expected_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExpectedField(object): + def __init__(self): + """Creates an instance of ExpectedField""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field_rule.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field_rule.py new file mode 100644 index 0000000..68cff56 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/field_rule.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldRule(object): + def __init__(self): + """Creates an instance of FieldRule""" + + self.__score = None + self.__criteria = None + self.__id = None + self.__key_modified = dict() + + def get_score(self): + """ + The method to get the score + + Returns: + int: An int representing the score + """ + + return self.__score + + def set_score(self, score): + """ + The method to set the value to score + + Parameters: + score (int) : An int representing the score + """ + + if score is not None and not isinstance(score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: score EXPECTED TYPE: int', None, None) + + self.__score = score + self.__key_modified['score'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/info.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/info.py new file mode 100644 index 0000000..94c5980 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/info.py @@ -0,0 +1,276 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__call = None + self.__per_page = None + self.__next_page_token = None + self.__count = None + self.__page = None + self.__previous_page_token = None + self.__page_token_expiry = None + self.__email = None + self.__more_records = None + self.__key_modified = dict() + + def get_call(self): + """ + The method to get the call + + Returns: + bool: A bool representing the call + """ + + return self.__call + + def set_call(self, call): + """ + The method to set the value to call + + Parameters: + call (bool) : A bool representing the call + """ + + if call is not None and not isinstance(call, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: call EXPECTED TYPE: bool', None, None) + + self.__call = call + self.__key_modified['call'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def get_page_token_expiry(self): + """ + The method to get the page_token_expiry + + Returns: + datetime: An instance of datetime + """ + + return self.__page_token_expiry + + def set_page_token_expiry(self, page_token_expiry): + """ + The method to set the value to page_token_expiry + + Parameters: + page_token_expiry (datetime) : An instance of datetime + """ + + from datetime import datetime + + if page_token_expiry is not None and not isinstance(page_token_expiry, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_token_expiry EXPECTED TYPE: datetime', None, None) + + self.__page_token_expiry = page_token_expiry + self.__key_modified['page_token_expiry'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + bool: A bool representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (bool) : A bool representing the email + """ + + if email is not None and not isinstance(email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: bool', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout.py new file mode 100644 index 0000000..b8c4ce2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout_request_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout_request_wrapper.py new file mode 100644 index 0000000..7b3cf1e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/layout_request_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LayoutRequestWrapper(object): + def __init__(self): + """Creates an instance of LayoutRequestWrapper""" + + self.__layout = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_wrapper.py new file mode 100644 index 0000000..9cda57b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__scoring_rules = None + self.__info = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/role_request_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/role_request_wrapper.py new file mode 100644 index 0000000..522f447 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/role_request_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RoleRequestWrapper(object): + def __init__(self): + """Creates an instance of RoleRequestWrapper""" + + self.__scoring_rules = None + self.__key_modified = dict() + + def get_scoring_rules(self): + """ + The method to get the scoring_rules + + Returns: + list: An instance of list + """ + + return self.__scoring_rules + + def set_scoring_rules(self, scoring_rules): + """ + The method to set the value to scoring_rules + + Parameters: + scoring_rules (list) : An instance of list + """ + + if scoring_rules is not None and not isinstance(scoring_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scoring_rules EXPECTED TYPE: list', None, None) + + self.__scoring_rules = scoring_rules + self.__key_modified['scoring_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rule.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rule.py new file mode 100644 index 0000000..c5dfebc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rule.py @@ -0,0 +1,369 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScoringRule(object): + def __init__(self): + """Creates an instance of ScoringRule""" + + self.__name = None + self.__description = None + self.__id = None + self.__layout = None + self.__created_time = None + self.__modified_time = None + self.__module = None + self.__modified_by = None + self.__active = None + self.__created_by = None + self.__field_rules = None + self.__signal_rules = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + string: A string representing the modified_time + """ + + return self.__modified_time + + def set_modified_time(self, modified_time): + """ + The method to set the value to modified_time + + Parameters: + modified_time (string) : A string representing the modified_time + """ + + if modified_time is not None and not isinstance(modified_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_time EXPECTED TYPE: str', None, None) + + self.__modified_time = modified_time + self.__key_modified['modified_time'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Modules: An instance of Modules + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import Modules + except Exception: + from ..modules import Modules + + if module is not None and not isinstance(module, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Modules', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_field_rules(self): + """ + The method to get the field_rules + + Returns: + list: An instance of list + """ + + return self.__field_rules + + def set_field_rules(self, field_rules): + """ + The method to set the value to field_rules + + Parameters: + field_rules (list) : An instance of list + """ + + if field_rules is not None and not isinstance(field_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_rules EXPECTED TYPE: list', None, None) + + self.__field_rules = field_rules + self.__key_modified['field_rules'] = 1 + + def get_signal_rules(self): + """ + The method to get the signal_rules + + Returns: + list: An instance of list + """ + + return self.__signal_rules + + def set_signal_rules(self, signal_rules): + """ + The method to set the value to signal_rules + + Parameters: + signal_rules (list) : An instance of list + """ + + if signal_rules is not None and not isinstance(signal_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signal_rules EXPECTED TYPE: list', None, None) + + self.__signal_rules = signal_rules + self.__key_modified['signal_rules'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rules_operations.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rules_operations.py new file mode 100644 index 0000000..d65f07d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/scoring_rules_operations.py @@ -0,0 +1,469 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class ScoringRulesOperations(object): + def __init__(self): + """Creates an instance of ScoringRulesOperations""" + pass + + def create_scoring_rules(self, request): + """ + The method to create scoring rules + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/automation/scoring_rules' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_scoring_rules(self, param_instance=None): + """ + The method to get scoring rules + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/automation/scoring_rules' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_scoring_rules(self, request): + """ + The method to update scoring rules + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/automation/scoring_rules' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_scoring_rules(self, param_instance=None): + """ + The method to delete scoring rules + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/automation/scoring_rules' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_scoring_rule(self, id, request): + """ + The method to update scoring rule + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_scoring_rule(self, module, id, param_instance=None): + """ + The method to get scoring rule + + Parameters: + module (string) : A string representing the module + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/automation/scoring_rules/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_scoring_rule(self, id): + """ + The method to delete scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def activate_scoring_rule(self, id): + """ + The method to activate scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + api_path = api_path + '/actions/activate' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def deactivate_scoring_rule(self, id): + """ + The method to deactivate scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + api_path = api_path + '/actions/activate' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def clone_scoring_rule(self, id): + """ + The method to clone scoring rule + + 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/v7/settings/automation/scoring_rules/' + api_path = api_path + str(id) + api_path = api_path + '/actions/clone' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def scoring_rule_execution_using_layout_id(self, module, request): + """ + The method to scoring rule execution using layout id + + Parameters: + module (string) : A string representing the module + request (LayoutRequestWrapper) : An instance of LayoutRequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.layout_request_wrapper import LayoutRequestWrapper + except Exception: + from .layout_request_wrapper import LayoutRequestWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, LayoutRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: LayoutRequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/run_scoring_rules' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def scoring_rule_execution_using_rule_ids(self, module, request): + """ + The method to scoring rule execution using rule ids + + Parameters: + module (string) : A string representing the module + request (RoleRequestWrapper) : An instance of RoleRequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.role_request_wrapper import RoleRequestWrapper + except Exception: + from .role_request_wrapper import RoleRequestWrapper + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, RoleRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: RoleRequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module) + api_path = api_path + '/actions/run_scoring_rules' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetScoringRulesParam(object): + module = Param('module', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + layout_id = Param('layout_id', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + active = Param('active', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + name = Param('name', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + page = Param('page', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + per_page = Param('per_page', 'com.zoho.crm.api.ScoringRules.GetScoringRulesParam') + + +class DeleteScoringRulesParam(object): + ids = Param('ids', 'com.zoho.crm.api.ScoringRules.DeleteScoringRulesParam') + + +class GetScoringRuleParam(object): + layout_id = Param('layout_id', 'com.zoho.crm.api.ScoringRules.GetScoringRuleParam') + active = Param('active', 'com.zoho.crm.api.ScoringRules.GetScoringRuleParam') + name = Param('name', 'com.zoho.crm.api.ScoringRules.GetScoringRuleParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal.py new file mode 100644 index 0000000..85e5fd7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Signal(object): + def __init__(self): + """Creates an instance of Signal""" + + self.__namespace = None + self.__id = None + self.__key_modified = dict() + + def get_namespace(self): + """ + The method to get the namespace + + Returns: + string: A string representing the namespace + """ + + return self.__namespace + + def set_namespace(self, namespace): + """ + The method to set the value to namespace + + Parameters: + namespace (string) : A string representing the namespace + """ + + if namespace is not None and not isinstance(namespace, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: namespace EXPECTED TYPE: str', None, None) + + self.__namespace = namespace + self.__key_modified['namespace'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal_rule.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal_rule.py new file mode 100644 index 0000000..1c1fbe1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/signal_rule.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SignalRule(object): + def __init__(self): + """Creates an instance of SignalRule""" + + self.__score = None + self.__signal = None + self.__id = None + self.__key_modified = dict() + + def get_score(self): + """ + The method to get the score + + Returns: + int: An int representing the score + """ + + return self.__score + + def set_score(self, score): + """ + The method to set the value to score + + Parameters: + score (int) : An int representing the score + """ + + if score is not None and not isinstance(score, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: score EXPECTED TYPE: int', None, None) + + self.__score = score + self.__key_modified['score'] = 1 + + def get_signal(self): + """ + The method to get the signal + + Returns: + Signal: An instance of Signal + """ + + return self.__signal + + def set_signal(self, signal): + """ + The method to set the value to signal + + Parameters: + signal (Signal) : An instance of Signal + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.signal import Signal + except Exception: + from .signal import Signal + + if signal is not None and not isinstance(signal, Signal): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signal EXPECTED TYPE: Signal', None, None) + + self.__signal = signal + self.__key_modified['signal'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/success_response.py new file mode 100644 index 0000000..42c3860 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/scoring_rules/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.scoring_rules.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class SuccessResponse(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/sdk_config.py b/zohocrmsdk/src/com/zoho/crm/api/sdk_config.py new file mode 100755 index 0000000..5132e7b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/sdk_config.py @@ -0,0 +1,55 @@ +class SDKConfig(object): + """ + The class to configure the SDK. + """ + + def __init__(self, auto_refresh_fields=False, pick_list_validation=True, read_timeout=None, connect_timeout=None): + """ + Creates an instance of SDKConfig with the following parameters + + Parameters: + auto_refresh_fields(bool): A bool representing auto_refresh_fields + pick_list_validation(bool): A bool representing pick_list_validation + read_timeout(float): A Float representing read_timeout + connect_timeout(float): A Float representing connect_timeout + """ + self.__auto_refresh_fields = auto_refresh_fields + self.__pick_list_validation = pick_list_validation + self.__read_timeout = read_timeout + self.__connect_timeout = connect_timeout + + def get_auto_refresh_fields(self): + """ + This is a getter method to get auto_refresh_fields. + + Returns: + bool: A bool representing auto_refresh_fields + """ + return self.__auto_refresh_fields + + def get_pick_list_validation(self): + """ + This is a getter method to get pick_list_validation. + + Returns: + bool: A bool representing pick_list_validation + """ + return self.__pick_list_validation + + def get_read_timeout(self): + """ + This is a getter method to get read_timeout. + + Returns: + Float: A Float representing read_timeout + """ + return self.__read_timeout + + def get_connect_timeout(self): + """ + This is a getter method to get connect_timeout. + + Returns: + Float: A Float representing connect_timeout + """ + return self.__connect_timeout diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/__init__.py new file mode 100644 index 0000000..6fad2ef --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/__init__.py @@ -0,0 +1,21 @@ +from .cc import Cc +from .owner import Owner +from .action_wrapper import ActionWrapper +from .template import Template +from .data_subject_request import DataSubjectRequest +from .data import Data +from .send_mail_operations import SendMailOperations +from .body_wrapper import BodyWrapper +from .in_reply_to import InReplyTo +from .blocked_email_address import BlockedEmailAddress +from .linked_record import LinkedRecord +from .api_exception import APIException +from .action_response import ActionResponse +from .attachment import Attachment +from .success_response import SuccessResponse +from .inventory_details import InventoryDetails +from .linked_module import LinkedModule +from .from1 import From +from .action_handler import ActionHandler +from .to import To +from .inventory_template import InventoryTemplate diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_wrapper.py new file mode 100644 index 0000000..239b739 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/api_exception.py new file mode 100644 index 0000000..685af3b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/attachment.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/attachment.py new file mode 100644 index 0000000..a81642f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/attachment.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Attachment(object): + def __init__(self): + """Creates an instance of Attachment""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/blocked_email_address.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/blocked_email_address.py new file mode 100644 index 0000000..b8d1734 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/blocked_email_address.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BlockedEmailAddress(object): + def __init__(self): + """Creates an instance of BlockedEmailAddress""" + + self.__email = None + self.__reason = None + self.__key_modified = dict() + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_reason(self): + """ + The method to get the reason + + Returns: + string: A string representing the reason + """ + + return self.__reason + + def set_reason(self, reason): + """ + The method to set the value to reason + + Parameters: + reason (string) : A string representing the reason + """ + + if reason is not None and not isinstance(reason, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reason EXPECTED TYPE: str', None, None) + + self.__reason = reason + self.__key_modified['reason'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/body_wrapper.py new file mode 100644 index 0000000..5c76913 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/cc.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/cc.py new file mode 100644 index 0000000..09430ce --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/cc.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Cc(object): + def __init__(self): + """Creates an instance of Cc""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/data.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/data.py new file mode 100644 index 0000000..6d252c9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/data.py @@ -0,0 +1,511 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Data(object): + def __init__(self): + """Creates an instance of Data""" + + self.__from_1 = None + self.__to = None + self.__cc = None + self.__bcc = None + self.__reply_to = None + self.__org_email = None + self.__scheduled_time = None + self.__mail_format = None + self.__consent_email = None + self.__content = None + self.__subject = None + self.__in_reply_to = None + self.__template = None + self.__inventory_details = None + self.__data_subject_request = None + self.__attachments = None + self.__linked_record = None + self.__key_modified = dict() + + def get_from(self): + """ + The method to get the from + + Returns: + From: An instance of From + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (From) : An instance of From + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.from1 import From + except Exception: + from .from1 import From + + if from_1 is not None and not isinstance(from_1, From): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: From', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + list: An instance of list + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (list) : An instance of list + """ + + if to is not None and not isinstance(to, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: list', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_cc(self): + """ + The method to get the cc + + Returns: + list: An instance of list + """ + + return self.__cc + + def set_cc(self, cc): + """ + The method to set the value to cc + + Parameters: + cc (list) : An instance of list + """ + + if cc is not None and not isinstance(cc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: cc EXPECTED TYPE: list', None, None) + + self.__cc = cc + self.__key_modified['cc'] = 1 + + def get_bcc(self): + """ + The method to get the bcc + + Returns: + list: An instance of list + """ + + return self.__bcc + + def set_bcc(self, bcc): + """ + The method to set the value to bcc + + Parameters: + bcc (list) : An instance of list + """ + + if bcc is not None and not isinstance(bcc, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: bcc EXPECTED TYPE: list', None, None) + + self.__bcc = bcc + self.__key_modified['bcc'] = 1 + + def get_reply_to(self): + """ + The method to get the reply_to + + Returns: + To: An instance of To + """ + + return self.__reply_to + + def set_reply_to(self, reply_to): + """ + The method to set the value to reply_to + + Parameters: + reply_to (To) : An instance of To + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.to import To + except Exception: + from .to import To + + if reply_to is not None and not isinstance(reply_to, To): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reply_to EXPECTED TYPE: To', None, None) + + self.__reply_to = reply_to + self.__key_modified['reply_to'] = 1 + + def get_org_email(self): + """ + The method to get the org_email + + Returns: + bool: A bool representing the org_email + """ + + return self.__org_email + + def set_org_email(self, org_email): + """ + The method to set the value to org_email + + Parameters: + org_email (bool) : A bool representing the org_email + """ + + if org_email is not None and not isinstance(org_email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_email EXPECTED TYPE: bool', None, None) + + self.__org_email = org_email + self.__key_modified['org_email'] = 1 + + def get_scheduled_time(self): + """ + The method to get the scheduled_time + + Returns: + datetime: An instance of datetime + """ + + return self.__scheduled_time + + def set_scheduled_time(self, scheduled_time): + """ + The method to set the value to scheduled_time + + Parameters: + scheduled_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if scheduled_time is not None and not isinstance(scheduled_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scheduled_time EXPECTED TYPE: datetime', None, None) + + self.__scheduled_time = scheduled_time + self.__key_modified['scheduled_time'] = 1 + + def get_mail_format(self): + """ + The method to get the mail_format + + Returns: + Choice: An instance of Choice + """ + + return self.__mail_format + + def set_mail_format(self, mail_format): + """ + The method to set the value to mail_format + + Parameters: + mail_format (Choice) : An instance of Choice + """ + + if mail_format is not None and not isinstance(mail_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mail_format EXPECTED TYPE: Choice', None, None) + + self.__mail_format = mail_format + self.__key_modified['mail_format'] = 1 + + def get_consent_email(self): + """ + The method to get the consent_email + + Returns: + bool: A bool representing the consent_email + """ + + return self.__consent_email + + def set_consent_email(self, consent_email): + """ + The method to set the value to consent_email + + Parameters: + consent_email (bool) : A bool representing the consent_email + """ + + if consent_email is not None and not isinstance(consent_email, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_email EXPECTED TYPE: bool', None, None) + + self.__consent_email = consent_email + self.__key_modified['consent_email'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_in_reply_to(self): + """ + The method to get the in_reply_to + + Returns: + InReplyTo: An instance of InReplyTo + """ + + return self.__in_reply_to + + def set_in_reply_to(self, in_reply_to): + """ + The method to set the value to in_reply_to + + Parameters: + in_reply_to (InReplyTo) : An instance of InReplyTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.in_reply_to import InReplyTo + except Exception: + from .in_reply_to import InReplyTo + + if in_reply_to is not None and not isinstance(in_reply_to, InReplyTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: in_reply_to EXPECTED TYPE: InReplyTo', None, None) + + self.__in_reply_to = in_reply_to + self.__key_modified['in_reply_to'] = 1 + + def get_template(self): + """ + The method to get the template + + Returns: + Template: An instance of Template + """ + + return self.__template + + def set_template(self, template): + """ + The method to set the value to template + + Parameters: + template (Template) : An instance of Template + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.template import Template + except Exception: + from .template import Template + + if template is not None and not isinstance(template, Template): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template EXPECTED TYPE: Template', None, None) + + self.__template = template + self.__key_modified['template'] = 1 + + def get_inventory_details(self): + """ + The method to get the inventory_details + + Returns: + InventoryDetails: An instance of InventoryDetails + """ + + return self.__inventory_details + + def set_inventory_details(self, inventory_details): + """ + The method to set the value to inventory_details + + Parameters: + inventory_details (InventoryDetails) : An instance of InventoryDetails + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.inventory_details import InventoryDetails + except Exception: + from .inventory_details import InventoryDetails + + if inventory_details is not None and not isinstance(inventory_details, InventoryDetails): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_details EXPECTED TYPE: InventoryDetails', None, None) + + self.__inventory_details = inventory_details + self.__key_modified['inventory_details'] = 1 + + def get_data_subject_request(self): + """ + The method to get the data_subject_request + + Returns: + DataSubjectRequest: An instance of DataSubjectRequest + """ + + return self.__data_subject_request + + def set_data_subject_request(self, data_subject_request): + """ + The method to set the value to data_subject_request + + Parameters: + data_subject_request (DataSubjectRequest) : An instance of DataSubjectRequest + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.data_subject_request import DataSubjectRequest + except Exception: + from .data_subject_request import DataSubjectRequest + + if data_subject_request is not None and not isinstance(data_subject_request, DataSubjectRequest): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_subject_request EXPECTED TYPE: DataSubjectRequest', None, None) + + self.__data_subject_request = data_subject_request + self.__key_modified['data_subject_request'] = 1 + + def get_attachments(self): + """ + The method to get the attachments + + Returns: + list: An instance of list + """ + + return self.__attachments + + def set_attachments(self, attachments): + """ + The method to set the value to attachments + + Parameters: + attachments (list) : An instance of list + """ + + if attachments is not None and not isinstance(attachments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachments EXPECTED TYPE: list', None, None) + + self.__attachments = attachments + self.__key_modified['attachments'] = 1 + + def get_linked_record(self): + """ + The method to get the linked_record + + Returns: + LinkedRecord: An instance of LinkedRecord + """ + + return self.__linked_record + + def set_linked_record(self, linked_record): + """ + The method to set the value to linked_record + + Parameters: + linked_record (LinkedRecord) : An instance of LinkedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.linked_record import LinkedRecord + except Exception: + from .linked_record import LinkedRecord + + if linked_record is not None and not isinstance(linked_record, LinkedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linked_record EXPECTED TYPE: LinkedRecord', None, None) + + self.__linked_record = linked_record + self.__key_modified['linked_record'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/data_subject_request.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/data_subject_request.py new file mode 100644 index 0000000..5987b13 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/data_subject_request.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataSubjectRequest(object): + def __init__(self): + """Creates an instance of DataSubjectRequest""" + + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/from1.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/from1.py new file mode 100644 index 0000000..9999b7b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/from1.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class From(object): + def __init__(self): + """Creates an instance of From""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/in_reply_to.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/in_reply_to.py new file mode 100644 index 0000000..e899ab3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/in_reply_to.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InReplyTo(object): + def __init__(self): + """Creates an instance of InReplyTo""" + + self.__message_id = None + self.__owner = None + self.__key_modified = dict() + + def get_message_id(self): + """ + The method to get the message_id + + Returns: + string: A string representing the message_id + """ + + return self.__message_id + + def set_message_id(self, message_id): + """ + The method to set the value to message_id + + Parameters: + message_id (string) : A string representing the message_id + """ + + if message_id is not None and not isinstance(message_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message_id EXPECTED TYPE: str', None, None) + + self.__message_id = message_id + self.__key_modified['message_id'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_details.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_details.py new file mode 100644 index 0000000..f1fbbcb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_details.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryDetails(object): + def __init__(self): + """Creates an instance of InventoryDetails""" + + self.__inventory_template = None + self.__key_modified = dict() + + def get_inventory_template(self): + """ + The method to get the inventory_template + + Returns: + InventoryTemplate: An instance of InventoryTemplate + """ + + return self.__inventory_template + + def set_inventory_template(self, inventory_template): + """ + The method to set the value to inventory_template + + Parameters: + inventory_template (InventoryTemplate) : An instance of InventoryTemplate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.inventory_template import InventoryTemplate + except Exception: + from .inventory_template import InventoryTemplate + + if inventory_template is not None and not isinstance(inventory_template, InventoryTemplate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inventory_template EXPECTED TYPE: InventoryTemplate', None, None) + + self.__inventory_template = inventory_template + self.__key_modified['inventory_template'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_template.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_template.py new file mode 100644 index 0000000..40e4f90 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/inventory_template.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InventoryTemplate(object): + def __init__(self): + """Creates an instance of InventoryTemplate""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_module.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_module.py new file mode 100644 index 0000000..ad76f8f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedModule(object): + def __init__(self): + """Creates an instance of LinkedModule""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_record.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_record.py new file mode 100644 index 0000000..8c51f46 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/linked_record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class LinkedRecord(object): + def __init__(self): + """Creates an instance of LinkedRecord""" + + self.__module = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + LinkedModule: An instance of LinkedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (LinkedModule) : An instance of LinkedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.linked_module import LinkedModule + except Exception: + from .linked_module import LinkedModule + + if module is not None and not isinstance(module, LinkedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: LinkedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/owner.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/owner.py new file mode 100644 index 0000000..3a97231 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/send_mail_operations.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/send_mail_operations.py new file mode 100644 index 0000000..c4d3d15 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/send_mail_operations.py @@ -0,0 +1,68 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class SendMailOperations(object): + def __init__(self, id, modulename): + """ + Creates an instance of SendMailOperations with the given parameters + + Parameters: + id (int) : An int representing the id + modulename (string) : A string representing the modulename + """ + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if not isinstance(modulename, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modulename EXPECTED TYPE: str', None, None) + + self.__id = id + self.__modulename = modulename + + + def send_mail(self, request): + """ + The method to send mail + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__modulename) + api_path = api_path + '/' + api_path = api_path + str(self.__id) + api_path = api_path + '/actions/send_mail' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/success_response.py new file mode 100644 index 0000000..a961fde --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.send_mail.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/template.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/template.py new file mode 100644 index 0000000..2277ba4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/template.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class Template(ABC): + def __init__(self): + """Creates an instance of Template""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/send_mail/to.py b/zohocrmsdk/src/com/zoho/crm/api/send_mail/to.py new file mode 100644 index 0000000..dbe309e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/send_mail/to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class To(object): + def __init__(self): + """Creates an instance of To""" + + self.__user_name = None + self.__email = None + self.__key_modified = dict() + + def get_user_name(self): + """ + The method to get the user_name + + Returns: + string: A string representing the user_name + """ + + return self.__user_name + + def set_user_name(self, user_name): + """ + The method to set the value to user_name + + Parameters: + user_name (string) : A string representing the user_name + """ + + if user_name is not None and not isinstance(user_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_name EXPECTED TYPE: str', None, None) + + self.__user_name = user_name + self.__key_modified['user_name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/__init__.py new file mode 100644 index 0000000..ddb4f62 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .body_wrapper import BodyWrapper +from .action_handler import ActionHandler +from .service_preference import ServicePreference +from .service_preference_operations import ServicePreferenceOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_wrapper.py new file mode 100644 index 0000000..afe8e63 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__service_preferences = None + self.__key_modified = dict() + + def get_service_preferences(self): + """ + The method to get the service_preferences + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__service_preferences + + def set_service_preferences(self, service_preferences): + """ + The method to set the value to service_preferences + + Parameters: + service_preferences (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if service_preferences is not None and not isinstance(service_preferences, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_preferences EXPECTED TYPE: ActionResponse', None, None) + + self.__service_preferences = service_preferences + self.__key_modified['service_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/api_exception.py new file mode 100644 index 0000000..fd61990 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/body_wrapper.py new file mode 100644 index 0000000..0aa37d2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__service_preferences = None + self.__key_modified = dict() + + def get_service_preferences(self): + """ + The method to get the service_preferences + + Returns: + ServicePreference: An instance of ServicePreference + """ + + return self.__service_preferences + + def set_service_preferences(self, service_preferences): + """ + The method to set the value to service_preferences + + Parameters: + service_preferences (ServicePreference) : An instance of ServicePreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.service_preference import ServicePreference + except Exception: + from .service_preference import ServicePreference + + if service_preferences is not None and not isinstance(service_preferences, ServicePreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_preferences EXPECTED TYPE: ServicePreference', None, None) + + self.__service_preferences = service_preferences + self.__key_modified['service_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_wrapper.py new file mode 100644 index 0000000..8d61856 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__service_preferences = None + self.__key_modified = dict() + + def get_service_preferences(self): + """ + The method to get the service_preferences + + Returns: + ServicePreference: An instance of ServicePreference + """ + + return self.__service_preferences + + def set_service_preferences(self, service_preferences): + """ + The method to set the value to service_preferences + + Parameters: + service_preferences (ServicePreference) : An instance of ServicePreference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.service_preference import ServicePreference + except Exception: + from .service_preference import ServicePreference + + if service_preferences is not None and not isinstance(service_preferences, ServicePreference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service_preferences EXPECTED TYPE: ServicePreference', None, None) + + self.__service_preferences = service_preferences + self.__key_modified['service_preferences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference.py new file mode 100644 index 0000000..89ad3a4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ServicePreference(object): + def __init__(self): + """Creates an instance of ServicePreference""" + + self.__job_sheet_enabled = None + self.__key_modified = dict() + + def get_job_sheet_enabled(self): + """ + The method to get the job_sheet_enabled + + Returns: + bool: A bool representing the job_sheet_enabled + """ + + return self.__job_sheet_enabled + + def set_job_sheet_enabled(self, job_sheet_enabled): + """ + The method to set the value to job_sheet_enabled + + Parameters: + job_sheet_enabled (bool) : A bool representing the job_sheet_enabled + """ + + if job_sheet_enabled is not None and not isinstance(job_sheet_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: job_sheet_enabled EXPECTED TYPE: bool', None, None) + + self.__job_sheet_enabled = job_sheet_enabled + self.__key_modified['job_sheet_enabled'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference_operations.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference_operations.py new file mode 100644 index 0000000..81b8458 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/service_preference_operations.py @@ -0,0 +1,72 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class ServicePreferenceOperations(object): + def __init__(self): + """Creates an instance of ServicePreferenceOperations""" + pass + + def get_service_preference(self): + """ + The method to get service preference + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/service_preferences' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_service_preference(self, request): + """ + The method to update service preference + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/service_preferences' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/service_preference/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/service_preference/success_response.py new file mode 100644 index 0000000..0415309 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/service_preference/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.service_preference.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/__init__.py new file mode 100644 index 0000000..09a80e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/__init__.py @@ -0,0 +1,16 @@ +from .action_wrapper import ActionWrapper +from .dependee import Dependee +from .share_record import ShareRecord +from .delete_action_handler import DeleteActionHandler +from .shared_through import SharedThrough +from .module import Module +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .share_records_operations import ShareRecordsOperations, GetSharedRecordDetailsParam +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .delete_action_wrapper import DeleteActionWrapper +from .action_handler import ActionHandler +from .delete_action_response import DeleteActionResponse diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/action_wrapper.py new file mode 100644 index 0000000..4d0faf3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/action_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__share = None + self.__notify = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + list: An instance of list + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (list) : An instance of list + """ + + if share is not None and not isinstance(share, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: list', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/api_exception.py new file mode 100644 index 0000000..d17fc09 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.share_records.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_handler import DeleteActionHandler + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_response import DeleteActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .delete_action_handler import DeleteActionHandler + from .action_handler import ActionHandler + from .delete_action_response import DeleteActionResponse + + +class APIException(ResponseHandler, ActionResponse, ActionHandler, DeleteActionResponse, DeleteActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/body_wrapper.py new file mode 100644 index 0000000..80d365a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/body_wrapper.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__share = None + self.__notify_on_completion = None + self.__notify = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + list: An instance of list + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (list) : An instance of list + """ + + if share is not None and not isinstance(share, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: list', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def get_notify_on_completion(self): + """ + The method to get the notify_on_completion + + Returns: + bool: A bool representing the notify_on_completion + """ + + return self.__notify_on_completion + + def set_notify_on_completion(self, notify_on_completion): + """ + The method to set the value to notify_on_completion + + Parameters: + notify_on_completion (bool) : A bool representing the notify_on_completion + """ + + if notify_on_completion is not None and not isinstance(notify_on_completion, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_on_completion EXPECTED TYPE: bool', None, None) + + self.__notify_on_completion = notify_on_completion + self.__key_modified['notify_on_completion'] = 1 + + def get_notify(self): + """ + The method to get the notify + + Returns: + bool: A bool representing the notify + """ + + return self.__notify + + def set_notify(self, notify): + """ + The method to set the value to notify + + Parameters: + notify (bool) : A bool representing the notify + """ + + if notify is not None and not isinstance(notify, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify EXPECTED TYPE: bool', None, None) + + self.__notify = notify + self.__key_modified['notify'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_handler.py new file mode 100644 index 0000000..3183800 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DeleteActionHandler(ABC): + def __init__(self): + """Creates an instance of DeleteActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_response.py new file mode 100644 index 0000000..5550b68 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class DeleteActionResponse(ABC): + def __init__(self): + """Creates an instance of DeleteActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_wrapper.py new file mode 100644 index 0000000..9333f77 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/delete_action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_handler import DeleteActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .delete_action_handler import DeleteActionHandler + + +class DeleteActionWrapper(DeleteActionHandler): + def __init__(self): + """Creates an instance of DeleteActionWrapper""" + super().__init__() + + self.__share = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + DeleteActionResponse: An instance of DeleteActionResponse + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (DeleteActionResponse) : An instance of DeleteActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_response import DeleteActionResponse + except Exception: + from .delete_action_response import DeleteActionResponse + + if share is not None and not isinstance(share, DeleteActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: DeleteActionResponse', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/dependee.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/dependee.py new file mode 100644 index 0000000..4cbcc79 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/dependee.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Dependee(object): + def __init__(self): + """Creates an instance of Dependee""" + + self.__json_path = None + self.__api_name = None + self.__key_modified = dict() + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/module.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/module.py new file mode 100644 index 0000000..8ebed21 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__name = None + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/response_wrapper.py new file mode 100644 index 0000000..1773982 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/response_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__share = None + self.__shareable_user = None + self.__key_modified = dict() + + def get_share(self): + """ + The method to get the share + + Returns: + list: An instance of list + """ + + return self.__share + + def set_share(self, share): + """ + The method to set the value to share + + Parameters: + share (list) : An instance of list + """ + + if share is not None and not isinstance(share, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share EXPECTED TYPE: list', None, None) + + self.__share = share + self.__key_modified['share'] = 1 + + def get_shareable_user(self): + """ + The method to get the shareable_user + + Returns: + list: An instance of list + """ + + return self.__shareable_user + + def set_shareable_user(self, shareable_user): + """ + The method to set the value to shareable_user + + Parameters: + shareable_user (list) : An instance of list + """ + + if shareable_user is not None and not isinstance(shareable_user, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shareable_user EXPECTED TYPE: list', None, None) + + self.__shareable_user = shareable_user + self.__key_modified['shareable_user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/share_record.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/share_record.py new file mode 100644 index 0000000..e4622bd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/share_record.py @@ -0,0 +1,271 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ShareRecord(object): + def __init__(self): + """Creates an instance of ShareRecord""" + + self.__shared_with = None + self.__share_related_records = None + self.__shared_through = None + self.__shared_time = None + self.__permission = None + self.__shared_by = None + self.__user = None + self.__type = None + self.__key_modified = dict() + + def get_shared_with(self): + """ + The method to get the shared_with + + Returns: + Users: An instance of Users + """ + + return self.__shared_with + + def set_shared_with(self, shared_with): + """ + The method to set the value to shared_with + + Parameters: + shared_with (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import Users + except Exception: + from ..users import Users + + if shared_with is not None and not isinstance(shared_with, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_with EXPECTED TYPE: Users', None, None) + + self.__shared_with = shared_with + self.__key_modified['shared_with'] = 1 + + def get_share_related_records(self): + """ + The method to get the share_related_records + + Returns: + bool: A bool representing the share_related_records + """ + + return self.__share_related_records + + def set_share_related_records(self, share_related_records): + """ + The method to set the value to share_related_records + + Parameters: + share_related_records (bool) : A bool representing the share_related_records + """ + + if share_related_records is not None and not isinstance(share_related_records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: share_related_records EXPECTED TYPE: bool', None, None) + + self.__share_related_records = share_related_records + self.__key_modified['share_related_records'] = 1 + + def get_shared_through(self): + """ + The method to get the shared_through + + Returns: + SharedThrough: An instance of SharedThrough + """ + + return self.__shared_through + + def set_shared_through(self, shared_through): + """ + The method to set the value to shared_through + + Parameters: + shared_through (SharedThrough) : An instance of SharedThrough + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.shared_through import SharedThrough + except Exception: + from .shared_through import SharedThrough + + if shared_through is not None and not isinstance(shared_through, SharedThrough): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_through EXPECTED TYPE: SharedThrough', None, None) + + self.__shared_through = shared_through + self.__key_modified['shared_through'] = 1 + + def get_shared_time(self): + """ + The method to get the shared_time + + Returns: + datetime: An instance of datetime + """ + + return self.__shared_time + + def set_shared_time(self, shared_time): + """ + The method to set the value to shared_time + + Parameters: + shared_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if shared_time is not None and not isinstance(shared_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_time EXPECTED TYPE: datetime', None, None) + + self.__shared_time = shared_time + self.__key_modified['shared_time'] = 1 + + def get_permission(self): + """ + The method to get the permission + + Returns: + string: A string representing the permission + """ + + return self.__permission + + def set_permission(self, permission): + """ + The method to set the value to permission + + Parameters: + permission (string) : A string representing the permission + """ + + if permission is not None and not isinstance(permission, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission EXPECTED TYPE: str', None, None) + + self.__permission = permission + self.__key_modified['permission'] = 1 + + def get_shared_by(self): + """ + The method to get the shared_by + + Returns: + Users: An instance of Users + """ + + return self.__shared_by + + def set_shared_by(self, shared_by): + """ + The method to set the value to shared_by + + Parameters: + shared_by (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import Users + except Exception: + from ..users import Users + + if shared_by is not None and not isinstance(shared_by, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shared_by EXPECTED TYPE: Users', None, None) + + self.__shared_by = shared_by + self.__key_modified['shared_by'] = 1 + + def get_user(self): + """ + The method to get the user + + Returns: + Users: An instance of Users + """ + + return self.__user + + def set_user(self, user): + """ + The method to set the value to user + + Parameters: + user (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import Users + except Exception: + from ..users import Users + + if user is not None and not isinstance(user, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: Users', None, None) + + self.__user = user + self.__key_modified['user'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/share_records_operations.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/share_records_operations.py new file mode 100644 index 0000000..8be9d07 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/share_records_operations.py @@ -0,0 +1,182 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class ShareRecordsOperations(object): + def __init__(self, record_id, module_api_name): + """ + Creates an instance of ShareRecordsOperations with the given parameters + + Parameters: + record_id (int) : An int representing the record_id + module_api_name (string) : A string representing the module_api_name + """ + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + self.__record_id = record_id + self.__module_api_name = module_api_name + + + def get_shared_record_details(self, param_instance=None): + """ + The method to get shared record details + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/' + 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/share' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def share_record(self, request): + """ + The method to share record + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + 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/share' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_share_permissions(self, request): + """ + The method to update share permissions + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + 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/share' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def revoke_shared_record(self): + """ + The method to revoke shared record + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + 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/share' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_handler import DeleteActionHandler + except Exception: + from .delete_action_handler import DeleteActionHandler + return handler_instance.api_call(DeleteActionHandler.__module__, 'application/json') + + +class GetSharedRecordDetailsParam(object): + sharedto = Param('sharedTo', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam') + view = Param('view', 'com.zoho.crm.api.ShareRecords.GetSharedRecordDetailsParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/shared_through.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/shared_through.py new file mode 100644 index 0000000..35a7337 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/shared_through.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SharedThrough(object): + def __init__(self): + """Creates an instance of SharedThrough""" + + self.__module = None + self.__id = None + self.__entity_name = None + self.__name = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.share_records.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_entity_name(self): + """ + The method to get the entity_name + + Returns: + string: A string representing the entity_name + """ + + return self.__entity_name + + def set_entity_name(self, entity_name): + """ + The method to set the value to entity_name + + Parameters: + entity_name (string) : A string representing the entity_name + """ + + if entity_name is not None and not isinstance(entity_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: entity_name EXPECTED TYPE: str', None, None) + + self.__entity_name = entity_name + self.__key_modified['entity_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/share_records/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/share_records/success_response.py new file mode 100644 index 0000000..13165a3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/share_records/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.share_records.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.share_records.delete_action_response import DeleteActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .delete_action_response import DeleteActionResponse + + +class SuccessResponse(ActionResponse, DeleteActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/__init__.py new file mode 100644 index 0000000..6be5346 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/__init__.py @@ -0,0 +1,18 @@ +from .shift_count import ShiftCount +from .shift_custom_timing import ShiftCustomTiming +from .action_wrapper import ActionWrapper +from .role import Role +from .body_wrapper import BodyWrapper +from .shift_hours import ShiftHours +from .users import Users +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .holidays import Holidays +from .success_response import SuccessResponse +from .break_hours import BreakHours +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .mandatory_details import MandatoryDetails +from .shift_hours_operations import ShiftHoursOperations, GetShiftHoursHeader, CreateShiftsHoursHeader, UpdateShiftHoursHeader, GetShiftHourHeader, UpdateShiftHourHeader, DeleteShiftHourHeader +from .break_custom_timing import BreakCustomTiming diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_wrapper.py new file mode 100644 index 0000000..5e5d914 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__shift_hours = None + self.__key_modified = dict() + + def get_shift_hours(self): + """ + The method to get the shift_hours + + Returns: + list: An instance of list + """ + + return self.__shift_hours + + def set_shift_hours(self, shift_hours): + """ + The method to set the value to shift_hours + + Parameters: + shift_hours (list) : An instance of list + """ + + if shift_hours is not None and not isinstance(shift_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hours EXPECTED TYPE: list', None, None) + + self.__shift_hours = shift_hours + self.__key_modified['shift_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/api_exception.py new file mode 100644 index 0000000..701f1f2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/body_wrapper.py new file mode 100644 index 0000000..2f468ef --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__shift_hours = None + self.__key_modified = dict() + + def get_shift_hours(self): + """ + The method to get the shift_hours + + Returns: + list: An instance of list + """ + + return self.__shift_hours + + def set_shift_hours(self, shift_hours): + """ + The method to set the value to shift_hours + + Parameters: + shift_hours (list) : An instance of list + """ + + if shift_hours is not None and not isinstance(shift_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hours EXPECTED TYPE: list', None, None) + + self.__shift_hours = shift_hours + self.__key_modified['shift_hours'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_custom_timing.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_custom_timing.py new file mode 100644 index 0000000..4d3971f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_custom_timing.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BreakCustomTiming(object): + def __init__(self): + """Creates an instance of BreakCustomTiming""" + + self.__days = None + self.__break_timing = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + string: A string representing the days + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (string) : A string representing the days + """ + + if days is not None and not isinstance(days, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: str', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_break_timing(self): + """ + The method to get the break_timing + + Returns: + list: An instance of list + """ + + return self.__break_timing + + def set_break_timing(self, break_timing): + """ + The method to set the value to break_timing + + Parameters: + break_timing (list) : An instance of list + """ + + if break_timing is not None and not isinstance(break_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: break_timing EXPECTED TYPE: list', None, None) + + self.__break_timing = break_timing + self.__key_modified['break_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_hours.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_hours.py new file mode 100644 index 0000000..d0ccdb5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/break_hours.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BreakHours(object): + def __init__(self): + """Creates an instance of BreakHours""" + + self.__break_days = None + self.__same_as_everyday = None + self.__daily_timing = None + self.__custom_timing = None + self.__id = None + self.__key_modified = dict() + + def get_break_days(self): + """ + The method to get the break_days + + Returns: + list: An instance of list + """ + + return self.__break_days + + def set_break_days(self, break_days): + """ + The method to set the value to break_days + + Parameters: + break_days (list) : An instance of list + """ + + if break_days is not None and not isinstance(break_days, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: break_days EXPECTED TYPE: list', None, None) + + self.__break_days = break_days + self.__key_modified['break_days'] = 1 + + def get_same_as_everyday(self): + """ + The method to get the same_as_everyday + + Returns: + bool: A bool representing the same_as_everyday + """ + + return self.__same_as_everyday + + def set_same_as_everyday(self, same_as_everyday): + """ + The method to set the value to same_as_everyday + + Parameters: + same_as_everyday (bool) : A bool representing the same_as_everyday + """ + + if same_as_everyday is not None and not isinstance(same_as_everyday, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: same_as_everyday EXPECTED TYPE: bool', None, None) + + self.__same_as_everyday = same_as_everyday + self.__key_modified['same_as_everyday'] = 1 + + def get_daily_timing(self): + """ + The method to get the daily_timing + + Returns: + list: An instance of list + """ + + return self.__daily_timing + + def set_daily_timing(self, daily_timing): + """ + The method to set the value to daily_timing + + Parameters: + daily_timing (list) : An instance of list + """ + + if daily_timing is not None and not isinstance(daily_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: daily_timing EXPECTED TYPE: list', None, None) + + self.__daily_timing = daily_timing + self.__key_modified['daily_timing'] = 1 + + def get_custom_timing(self): + """ + The method to get the custom_timing + + Returns: + list: An instance of list + """ + + return self.__custom_timing + + def set_custom_timing(self, custom_timing): + """ + The method to set the value to custom_timing + + Parameters: + custom_timing (list) : An instance of list + """ + + if custom_timing is not None and not isinstance(custom_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_timing EXPECTED TYPE: list', None, None) + + self.__custom_timing = custom_timing + self.__key_modified['custom_timing'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/holidays.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/holidays.py new file mode 100644 index 0000000..cba10cd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/holidays.py @@ -0,0 +1,151 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Holidays(object): + def __init__(self): + """Creates an instance of Holidays""" + + self.__date = None + self.__year = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_date(self): + """ + The method to get the date + + Returns: + date: An instance of date + """ + + return self.__date + + def set_date(self, date): + """ + The method to set the value to date + + Parameters: + date (date) : An instance of date + """ + + from datetime import date as date1 + + if date is not None and not isinstance(date, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date EXPECTED TYPE: date1', None, None) + + self.__date = date + self.__key_modified['date'] = 1 + + def get_year(self): + """ + The method to get the year + + Returns: + int: An int representing the year + """ + + return self.__year + + def set_year(self, year): + """ + The method to set the value to year + + Parameters: + year (int) : An int representing the year + """ + + if year is not None and not isinstance(year, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: year EXPECTED TYPE: int', None, None) + + self.__year = year + self.__key_modified['year'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/mandatory_details.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/mandatory_details.py new file mode 100644 index 0000000..6ee3c77 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/mandatory_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MandatoryDetails(object): + def __init__(self): + """Creates an instance of MandatoryDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_wrapper.py new file mode 100644 index 0000000..0acdf2f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__shift_hours = None + self.__shift_count = None + self.__key_modified = dict() + + def get_shift_hours(self): + """ + The method to get the shift_hours + + Returns: + list: An instance of list + """ + + return self.__shift_hours + + def set_shift_hours(self, shift_hours): + """ + The method to set the value to shift_hours + + Parameters: + shift_hours (list) : An instance of list + """ + + if shift_hours is not None and not isinstance(shift_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_hours EXPECTED TYPE: list', None, None) + + self.__shift_hours = shift_hours + self.__key_modified['shift_hours'] = 1 + + def get_shift_count(self): + """ + The method to get the shift_count + + Returns: + ShiftCount: An instance of ShiftCount + """ + + return self.__shift_count + + def set_shift_count(self, shift_count): + """ + The method to set the value to shift_count + + Parameters: + shift_count (ShiftCount) : An instance of ShiftCount + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.shift_count import ShiftCount + except Exception: + from .shift_count import ShiftCount + + if shift_count is not None and not isinstance(shift_count, ShiftCount): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_count EXPECTED TYPE: ShiftCount', None, None) + + self.__shift_count = shift_count + self.__key_modified['shift_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/role.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/role.py new file mode 100644 index 0000000..bba4d98 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/role.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Role(object): + def __init__(self): + """Creates an instance of Role""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_count.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_count.py new file mode 100644 index 0000000..8c4a9fe --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_count.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftCount(object): + def __init__(self): + """Creates an instance of ShiftCount""" + + self.__total_shift_with_user = None + self.__total_shift = None + self.__key_modified = dict() + + def get_total_shift_with_user(self): + """ + The method to get the total_shift_with_user + + Returns: + int: An int representing the total_shift_with_user + """ + + return self.__total_shift_with_user + + def set_total_shift_with_user(self, total_shift_with_user): + """ + The method to set the value to total_shift_with_user + + Parameters: + total_shift_with_user (int) : An int representing the total_shift_with_user + """ + + if total_shift_with_user is not None and not isinstance(total_shift_with_user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_shift_with_user EXPECTED TYPE: int', None, None) + + self.__total_shift_with_user = total_shift_with_user + self.__key_modified['total_shift_with_user'] = 1 + + def get_total_shift(self): + """ + The method to get the total_shift + + Returns: + int: An int representing the total_shift + """ + + return self.__total_shift + + def set_total_shift(self, total_shift): + """ + The method to set the value to total_shift + + Parameters: + total_shift (int) : An int representing the total_shift + """ + + if total_shift is not None and not isinstance(total_shift, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_shift EXPECTED TYPE: int', None, None) + + self.__total_shift = total_shift + self.__key_modified['total_shift'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_custom_timing.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_custom_timing.py new file mode 100644 index 0000000..d059e52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_custom_timing.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftCustomTiming(object): + def __init__(self): + """Creates an instance of ShiftCustomTiming""" + + self.__days = None + self.__shift_timing = None + self.__key_modified = dict() + + def get_days(self): + """ + The method to get the days + + Returns: + string: A string representing the days + """ + + return self.__days + + def set_days(self, days): + """ + The method to set the value to days + + Parameters: + days (string) : A string representing the days + """ + + if days is not None and not isinstance(days, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: days EXPECTED TYPE: str', None, None) + + self.__days = days + self.__key_modified['days'] = 1 + + def get_shift_timing(self): + """ + The method to get the shift_timing + + Returns: + list: An instance of list + """ + + return self.__shift_timing + + def set_shift_timing(self, shift_timing): + """ + The method to set the value to shift_timing + + Parameters: + shift_timing (list) : An instance of list + """ + + if shift_timing is not None and not isinstance(shift_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_timing EXPECTED TYPE: list', None, None) + + self.__shift_timing = shift_timing + self.__key_modified['shift_timing'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours.py new file mode 100644 index 0000000..2baf6f7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours.py @@ -0,0 +1,321 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ShiftHours(object): + def __init__(self): + """Creates an instance of ShiftHours""" + + self.__same_as_everyday = None + self.__shift_days = None + self.__daily_timing = None + self.__custom_timing = None + self.__id = None + self.__break_hours = None + self.__users = None + self.__holidays = None + self.__users_count = None + self.__timezone = None + self.__name = None + self.__key_modified = dict() + + def get_same_as_everyday(self): + """ + The method to get the same_as_everyday + + Returns: + bool: A bool representing the same_as_everyday + """ + + return self.__same_as_everyday + + def set_same_as_everyday(self, same_as_everyday): + """ + The method to set the value to same_as_everyday + + Parameters: + same_as_everyday (bool) : A bool representing the same_as_everyday + """ + + if same_as_everyday is not None and not isinstance(same_as_everyday, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: same_as_everyday EXPECTED TYPE: bool', None, None) + + self.__same_as_everyday = same_as_everyday + self.__key_modified['same_as_everyday'] = 1 + + def get_shift_days(self): + """ + The method to get the shift_days + + Returns: + list: An instance of list + """ + + return self.__shift_days + + def set_shift_days(self, shift_days): + """ + The method to set the value to shift_days + + Parameters: + shift_days (list) : An instance of list + """ + + if shift_days is not None and not isinstance(shift_days, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_days EXPECTED TYPE: list', None, None) + + self.__shift_days = shift_days + self.__key_modified['shift_days'] = 1 + + def get_daily_timing(self): + """ + The method to get the daily_timing + + Returns: + list: An instance of list + """ + + return self.__daily_timing + + def set_daily_timing(self, daily_timing): + """ + The method to set the value to daily_timing + + Parameters: + daily_timing (list) : An instance of list + """ + + if daily_timing is not None and not isinstance(daily_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: daily_timing EXPECTED TYPE: list', None, None) + + self.__daily_timing = daily_timing + self.__key_modified['daily_timing'] = 1 + + def get_custom_timing(self): + """ + The method to get the custom_timing + + Returns: + list: An instance of list + """ + + return self.__custom_timing + + def set_custom_timing(self, custom_timing): + """ + The method to set the value to custom_timing + + Parameters: + custom_timing (list) : An instance of list + """ + + if custom_timing is not None and not isinstance(custom_timing, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_timing EXPECTED TYPE: list', None, None) + + self.__custom_timing = custom_timing + self.__key_modified['custom_timing'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_break_hours(self): + """ + The method to get the break_hours + + Returns: + list: An instance of list + """ + + return self.__break_hours + + def set_break_hours(self, break_hours): + """ + The method to set the value to break_hours + + Parameters: + break_hours (list) : An instance of list + """ + + if break_hours is not None and not isinstance(break_hours, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: break_hours EXPECTED TYPE: list', None, None) + + self.__break_hours = break_hours + self.__key_modified['break_hours'] = 1 + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_holidays(self): + """ + The method to get the holidays + + Returns: + list: An instance of list + """ + + return self.__holidays + + def set_holidays(self, holidays): + """ + The method to set the value to holidays + + Parameters: + holidays (list) : An instance of list + """ + + if holidays is not None and not isinstance(holidays, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: holidays EXPECTED TYPE: list', None, None) + + self.__holidays = holidays + self.__key_modified['holidays'] = 1 + + def get_users_count(self): + """ + The method to get the users_count + + Returns: + int: An int representing the users_count + """ + + return self.__users_count + + def set_users_count(self, users_count): + """ + The method to set the value to users_count + + Parameters: + users_count (int) : An int representing the users_count + """ + + if users_count is not None and not isinstance(users_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_count EXPECTED TYPE: int', None, None) + + self.__users_count = users_count + self.__key_modified['users_count'] = 1 + + def get_timezone(self): + """ + The method to get the timezone + + Returns: + string: An instance of string + """ + + return self.__timezone + + def set_timezone(self, timezone): + """ + The method to set the value to timezone + + Parameters: + timezone (string) : An instance of string + """ + + self.__timezone = timezone + self.__key_modified['timezone'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours_operations.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours_operations.py new file mode 100644 index 0000000..a83333c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/shift_hours_operations.py @@ -0,0 +1,253 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..header import Header + + +class ShiftHoursOperations(object): + def __init__(self, x_crm_org=None): + """ + Creates an instance of ShiftHoursOperations with the given parameters + + Parameters: + x_crm_org (string) : A string representing the x_crm_org + """ + + if x_crm_org is not None and not isinstance(x_crm_org, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: x_crm_org EXPECTED TYPE: str', None, None) + + self.__x_crm_org = x_crm_org + + + def get_shift_hours(self): + """ + The method to get shift hours + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours/shift_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.GetShiftHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_shifts_hours(self, request): + """ + The method to create shifts hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours/shift_hours' + 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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.CreateShiftsHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_shift_hours(self, request): + """ + The method to update shift hours + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/business_hours/shift_hours' + 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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.UpdateShiftHoursHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_shift_hour(self, shift_id): + """ + The method to get shift hour + + Parameters: + shift_id (int) : An int representing the shift_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(shift_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours/shift_hours/' + api_path = api_path + str(shift_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_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.GetShiftHourHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_shift_hour(self, shift_id, request): + """ + The method to update shift hour + + Parameters: + shift_id (int) : An int representing the shift_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(shift_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_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/v7/settings/business_hours/shift_hours/' + api_path = api_path + str(shift_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.set_mandatory_checker(True) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.UpdateShiftHourHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_shift_hour(self, shift_id): + """ + The method to delete shift hour + + Parameters: + shift_id (int) : An int representing the shift_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(shift_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shift_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/business_hours/shift_hours/' + api_path = api_path + str(shift_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_header(Header('X-CRM-ORG', 'com.zoho.crm.api.ShiftHours.DeleteShiftHourHeader'), self.__x_crm_org) + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetShiftHoursHeader(object): + pass + + +class CreateShiftsHoursHeader(object): + pass + + +class UpdateShiftHoursHeader(object): + pass + + +class GetShiftHourHeader(object): + pass + + +class UpdateShiftHourHeader(object): + pass + + +class DeleteShiftHourHeader(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/success_response.py new file mode 100644 index 0000000..1d93c4c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/shift_hours/users.py b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/users.py new file mode 100644 index 0000000..e604e26 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/shift_hours/users.py @@ -0,0 +1,206 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Users(object): + def __init__(self): + """Creates an instance of Users""" + + self.__role = None + self.__name = None + self.__id = None + self.__email = None + self.__zuid = None + self.__effective_from = None + self.__key_modified = dict() + + def get_role(self): + """ + The method to get the role + + Returns: + Role: An instance of Role + """ + + return self.__role + + def set_role(self, role): + """ + The method to set the value to role + + Parameters: + role (Role) : An instance of Role + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.shift_hours.role import Role + except Exception: + from .role import Role + + if role is not None and not isinstance(role, Role): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role EXPECTED TYPE: Role', None, None) + + self.__role = role + self.__key_modified['role'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def get_effective_from(self): + """ + The method to get the effective_from + + Returns: + date: An instance of date + """ + + return self.__effective_from + + def set_effective_from(self, effective_from): + """ + The method to set the value to effective_from + + Parameters: + effective_from (date) : An instance of date + """ + + from datetime import date as date1 + + if effective_from is not None and not isinstance(effective_from, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: effective_from EXPECTED TYPE: date1', None, None) + + self.__effective_from = effective_from + self.__key_modified['effective_from'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/tags/__init__.py new file mode 100644 index 0000000..b4ffa2e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/__init__.py @@ -0,0 +1,26 @@ +from .count_response_wrapper import CountResponseWrapper +from .record_detail_tag import RecordDetailTag +from .tags_operations import TagsOperations, GetTagsParam, CreateTagsParam, UpdateTagsParam, UpdateTagParam, AddTagsParam, AddTagsToMultipleRecordsParam, RemoveTagsFromMultipleRecordsParam, GetRecordCountForTagParam +from .existing_tag import ExistingTag +from .new_tag_request_wrapper import NewTagRequestWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .error_details import ErrorDetails +from .success_response import SuccessResponse +from .record_success_response import RecordSuccessResponse +from .action_handler import ActionHandler +from .tag import Tag +from .associated_places import AssociatedPlaces +from .info import Info +from .action_wrapper import ActionWrapper +from .merge_wrapper import MergeWrapper +from .record_action_wrapper import RecordActionWrapper +from .resources import Resources +from .body_wrapper import BodyWrapper +from .record_action_handler import RecordActionHandler +from .existing_tag_request_wrapper import ExistingTagRequestWrapper +from .conflict_wrapper import ConflictWrapper +from .response_wrapper import ResponseWrapper +from .record_action_response import RecordActionResponse +from .success_wrapper import SuccessWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/tags/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/tags/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/action_wrapper.py new file mode 100644 index 0000000..713fc4d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/tags/api_exception.py new file mode 100644 index 0000000..a43507c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_response import RecordActionResponse + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + from .record_action_response import RecordActionResponse + from .record_action_handler import RecordActionHandler + + +class APIException(ActionResponse, RecordActionResponse, ResponseHandler, ActionHandler, RecordActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/associated_places.py b/zohocrmsdk/src/com/zoho/crm/api/tags/associated_places.py new file mode 100644 index 0000000..e3fd0e1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/associated_places.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedPlaces(object): + def __init__(self): + """Creates an instance of AssociatedPlaces""" + + self.__type = None + self.__resources = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resources(self): + """ + The method to get the resources + + Returns: + list: An instance of list + """ + + return self.__resources + + def set_resources(self, resources): + """ + The method to set the value to resources + + Parameters: + resources (list) : An instance of list + """ + + if resources is not None and not isinstance(resources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resources EXPECTED TYPE: list', None, None) + + self.__resources = resources + self.__key_modified['resources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/body_wrapper.py new file mode 100644 index 0000000..c1de2c4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/conflict_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/conflict_wrapper.py new file mode 100644 index 0000000..415f22c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/conflict_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ConflictWrapper(object): + def __init__(self): + """Creates an instance of ConflictWrapper""" + + self.__conflict_id = None + self.__key_modified = dict() + + def get_conflict_id(self): + """ + The method to get the conflict_id + + Returns: + string: A string representing the conflict_id + """ + + return self.__conflict_id + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/count_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/count_response_wrapper.py new file mode 100644 index 0000000..bb72950 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/count_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class CountResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of CountResponseWrapper""" + super().__init__() + + self.__count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + string: A string representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (string) : A string representing the count + """ + + if count is not None and not isinstance(count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: str', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/error_details.py b/zohocrmsdk/src/com/zoho/crm/api/tags/error_details.py new file mode 100644 index 0000000..34bf24e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/error_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ErrorDetails(object): + def __init__(self): + """Creates an instance of ErrorDetails""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag.py b/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag.py new file mode 100644 index 0000000..c78c1a4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExistingTag(object): + def __init__(self): + """Creates an instance of ExistingTag""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag_request_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag_request_wrapper.py new file mode 100644 index 0000000..f0201bc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/existing_tag_request_wrapper.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExistingTagRequestWrapper(object): + def __init__(self): + """Creates an instance of ExistingTagRequestWrapper""" + + self.__tags = None + self.__ids = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/info.py b/zohocrmsdk/src/com/zoho/crm/api/tags/info.py new file mode 100644 index 0000000..1d3e270 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/info.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__allowed_count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_allowed_count(self): + """ + The method to get the allowed_count + + Returns: + int: An int representing the allowed_count + """ + + return self.__allowed_count + + def set_allowed_count(self, allowed_count): + """ + The method to set the value to allowed_count + + Parameters: + allowed_count (int) : An int representing the allowed_count + """ + + if allowed_count is not None and not isinstance(allowed_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_count EXPECTED TYPE: int', None, None) + + self.__allowed_count = allowed_count + self.__key_modified['allowed_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/merge_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/merge_wrapper.py new file mode 100644 index 0000000..1f34624 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/merge_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MergeWrapper(object): + def __init__(self): + """Creates an instance of MergeWrapper""" + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/new_tag_request_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/new_tag_request_wrapper.py new file mode 100644 index 0000000..37f16d7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/new_tag_request_wrapper.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NewTagRequestWrapper(object): + def __init__(self): + """Creates an instance of NewTagRequestWrapper""" + + self.__tags = None + self.__over_write = None + self.__ids = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_over_write(self): + """ + The method to get the over_write + + Returns: + bool: A bool representing the over_write + """ + + return self.__over_write + + def set_over_write(self, over_write): + """ + The method to set the value to over_write + + Parameters: + over_write (bool) : A bool representing the over_write + """ + + if over_write is not None and not isinstance(over_write, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: over_write EXPECTED TYPE: bool', None, None) + + self.__over_write = over_write + self.__key_modified['over_write'] = 1 + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_handler.py new file mode 100644 index 0000000..e711e65 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class RecordActionHandler(ABC): + def __init__(self): + """Creates an instance of RecordActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_response.py new file mode 100644 index 0000000..bee98ec --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class RecordActionResponse(ABC): + def __init__(self): + """Creates an instance of RecordActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_wrapper.py new file mode 100644 index 0000000..a0401a4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/record_action_wrapper.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .record_action_handler import RecordActionHandler + + +class RecordActionWrapper(RecordActionHandler): + def __init__(self): + """Creates an instance of RecordActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + self.__wf_scheduler = None + self.__success_count = None + self.__locked_count = None + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification + + def get_wf_scheduler(self): + """ + The method to get the wf_scheduler + + Returns: + bool: A bool representing the wf_scheduler + """ + + return self.__wf_scheduler + + def set_wf_scheduler(self, wf_scheduler): + """ + The method to set the value to wf_scheduler + + Parameters: + wf_scheduler (bool) : A bool representing the wf_scheduler + """ + + if wf_scheduler is not None and not isinstance(wf_scheduler, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wf_scheduler EXPECTED TYPE: bool', None, None) + + self.__wf_scheduler = wf_scheduler + self.__key_modified['wf_scheduler'] = 1 + + def get_success_count(self): + """ + The method to get the success_count + + Returns: + string: A string representing the success_count + """ + + return self.__success_count + + def set_success_count(self, success_count): + """ + The method to set the value to success_count + + Parameters: + success_count (string) : A string representing the success_count + """ + + if success_count is not None and not isinstance(success_count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: success_count EXPECTED TYPE: str', None, None) + + self.__success_count = success_count + self.__key_modified['success_count'] = 1 + + def get_locked_count(self): + """ + The method to get the locked_count + + Returns: + string: A string representing the locked_count + """ + + return self.__locked_count + + def set_locked_count(self, locked_count): + """ + The method to set the value to locked_count + + Parameters: + locked_count (string) : A string representing the locked_count + """ + + if locked_count is not None and not isinstance(locked_count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locked_count EXPECTED TYPE: str', None, None) + + self.__locked_count = locked_count + self.__key_modified['locked_count'] = 1 diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/record_detail_tag.py b/zohocrmsdk/src/com/zoho/crm/api/tags/record_detail_tag.py new file mode 100644 index 0000000..d7fb174 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/record_detail_tag.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RecordDetailTag(object): + def __init__(self): + """Creates an instance of RecordDetailTag""" + + self.__id = None + self.__name = None + self.__color_code = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_color_code(self): + """ + The method to get the color_code + + Returns: + string: A string representing the color_code + """ + + return self.__color_code + + def set_color_code(self, color_code): + """ + The method to set the value to color_code + + Parameters: + color_code (string) : A string representing the color_code + """ + + if color_code is not None and not isinstance(color_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: str', None, None) + + self.__color_code = color_code + self.__key_modified['color_code'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/record_success_response.py b/zohocrmsdk/src/com/zoho/crm/api/tags/record_success_response.py new file mode 100644 index 0000000..abca4e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/record_success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_response import RecordActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .record_action_response import RecordActionResponse + + +class RecordSuccessResponse(RecordActionResponse): + def __init__(self): + """Creates an instance of RecordSuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/resources.py b/zohocrmsdk/src/com/zoho/crm/api/tags/resources.py new file mode 100644 index 0000000..71aea97 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/resources.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resources(object): + def __init__(self): + """Creates an instance of Resources""" + + self.__name = None + self.__id = None + self.__details = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/tags/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/response_wrapper.py new file mode 100644 index 0000000..44c0722 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__tags = None + self.__info = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/tags/success_response.py new file mode 100644 index 0000000..e5b21c6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/success_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/tags/success_wrapper.py new file mode 100644 index 0000000..fabbe2f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/success_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class SuccessWrapper(ActionHandler): + def __init__(self): + """Creates an instance of SuccessWrapper""" + super().__init__() + + self.__tags = None + self.__key_modified = dict() + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/tag.py b/zohocrmsdk/src/com/zoho/crm/api/tags/tag.py new file mode 100644 index 0000000..9984242 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/tag.py @@ -0,0 +1,238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Tag(object): + def __init__(self): + """Creates an instance of Tag""" + + self.__name = None + self.__color_code = None + self.__created_time = None + self.__modified_time = None + self.__modified_by = None + self.__created_by = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_color_code(self): + """ + The method to get the color_code + + Returns: + Choice: An instance of Choice + """ + + return self.__color_code + + def set_color_code(self, color_code): + """ + The method to set the value to color_code + + Parameters: + color_code (Choice) : An instance of Choice + """ + + if color_code is not None and not isinstance(color_code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_code EXPECTED TYPE: Choice', None, None) + + self.__color_code = color_code + self.__key_modified['color_code'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/tags/tags_operations.py b/zohocrmsdk/src/com/zoho/crm/api/tags/tags_operations.py new file mode 100644 index 0000000..ba1b111 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/tags/tags_operations.py @@ -0,0 +1,556 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class TagsOperations(object): + def __init__(self): + """Creates an instance of TagsOperations""" + pass + + def get_tags(self, param_instance=None): + """ + The method to get tags + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_tags(self, request, param_instance=None): + """ + The method to create tags + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_tags(self, request, param_instance=None): + """ + The method to update tags + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/settings/tags' + 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.set_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_tag(self, id, request, param_instance=None): + """ + The method to update tag + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + 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/v7/settings/tags/' + api_path = api_path + str(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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_tag(self, id): + """ + The method to delete tag + + 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/v7/settings/tags/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def merge_tags(self, id, request): + """ + The method to merge tags + + Parameters: + id (int) : An int representing the id + request (MergeWrapper) : An instance of MergeWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.merge_wrapper import MergeWrapper + except Exception: + from .merge_wrapper import MergeWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, MergeWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: MergeWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/tags/' + api_path = api_path + str(id) + api_path = api_path + '/actions/merge' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def add_tags(self, record_id, module_api_name, request, param_instance=None): + """ + The method to add tags + + Parameters: + record_id (int) : An int representing the record_id + module_api_name (string) : A string representing the module_api_name + request (NewTagRequestWrapper) : An instance of NewTagRequestWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.new_tag_request_wrapper import NewTagRequestWrapper + except Exception: + from .new_tag_request_wrapper import NewTagRequestWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, NewTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: NewTagRequestWrapper', None, None) + + 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/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/actions/add_tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def remove_tags(self, record_id, module_api_name, request): + """ + The method to remove tags + + Parameters: + record_id (int) : An int representing the record_id + module_api_name (string) : A string representing the module_api_name + request (ExistingTagRequestWrapper) : An instance of ExistingTagRequestWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.existing_tag_request_wrapper import ExistingTagRequestWrapper + except Exception: + from .existing_tag_request_wrapper import ExistingTagRequestWrapper + + if not isinstance(record_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: int', None, None) + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, ExistingTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ExistingTagRequestWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/actions/remove_tags' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def add_tags_to_multiple_records(self, module_api_name, request, param_instance=None): + """ + The method to add tags to multiple records + + Parameters: + module_api_name (string) : A string representing the module_api_name + request (NewTagRequestWrapper) : An instance of NewTagRequestWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.new_tag_request_wrapper import NewTagRequestWrapper + except Exception: + from .new_tag_request_wrapper import NewTagRequestWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, NewTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: NewTagRequestWrapper', None, None) + + 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/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/actions/add_tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def remove_tags_from_multiple_records(self, module_api_name, request, param_instance=None): + """ + The method to remove tags from multiple records + + Parameters: + module_api_name (string) : A string representing the module_api_name + request (ExistingTagRequestWrapper) : An instance of ExistingTagRequestWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.existing_tag_request_wrapper import ExistingTagRequestWrapper + except Exception: + from .existing_tag_request_wrapper import ExistingTagRequestWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module_api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_api_name EXPECTED TYPE: str', None, None) + + if request is not None and not isinstance(request, ExistingTagRequestWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: ExistingTagRequestWrapper', None, None) + + 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/v7/' + api_path = api_path + str(module_api_name) + api_path = api_path + '/actions/remove_tags' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.record_action_handler import RecordActionHandler + except Exception: + from .record_action_handler import RecordActionHandler + return handler_instance.api_call(RecordActionHandler.__module__, 'application/json') + + def get_record_count_for_tag(self, id, param_instance=None): + """ + The method to get record count for tag + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/tags/' + api_path = api_path + str(id) + api_path = api_path + '/actions/records_count' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.tags.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetTagsParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.GetTagsParam') + my_tags = Param('my_tags', 'com.zoho.crm.api.Tags.GetTagsParam') + include = Param('include', 'com.zoho.crm.api.Tags.GetTagsParam') + + +class CreateTagsParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.CreateTagsParam') + + +class UpdateTagsParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.UpdateTagsParam') + + +class UpdateTagParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.UpdateTagParam') + + +class AddTagsParam(object): + over_write = Param('over_write', 'com.zoho.crm.api.Tags.AddTagsParam') + + +class AddTagsToMultipleRecordsParam(object): + over_write = Param('over_write', 'com.zoho.crm.api.Tags.AddTagsToMultipleRecordsParam') + + +class RemoveTagsFromMultipleRecordsParam(object): + ids = Param('ids', 'com.zoho.crm.api.Tags.RemoveTagsFromMultipleRecordsParam') + + +class GetRecordCountForTagParam(object): + module = Param('module', 'com.zoho.crm.api.Tags.GetRecordCountForTagParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/__init__.py new file mode 100644 index 0000000..f9e185b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/__init__.py @@ -0,0 +1,13 @@ +from .action_wrapper import ActionWrapper +from .org_tax import OrgTax +from .preference import Preference +from .body_wrapper import BodyWrapper +from .tax import Tax +from .expected_field import ExpectedField +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .taxes_operations import TaxesOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/action_wrapper.py new file mode 100644 index 0000000..8c12505 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/action_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__org_taxes = None + self.__key_modified = dict() + + def get_org_taxes(self): + """ + The method to get the org_taxes + + Returns: + ActionResponse: An instance of ActionResponse + """ + + return self.__org_taxes + + def set_org_taxes(self, org_taxes): + """ + The method to set the value to org_taxes + + Parameters: + org_taxes (ActionResponse) : An instance of ActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_response import ActionResponse + except Exception: + from .action_response import ActionResponse + + if org_taxes is not None and not isinstance(org_taxes, ActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_taxes EXPECTED TYPE: ActionResponse', None, None) + + self.__org_taxes = org_taxes + self.__key_modified['org_taxes'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/api_exception.py new file mode 100644 index 0000000..8cfd7f8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/body_wrapper.py new file mode 100644 index 0000000..4697356 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__org_taxes = None + self.__key_modified = dict() + + def get_org_taxes(self): + """ + The method to get the org_taxes + + Returns: + OrgTax: An instance of OrgTax + """ + + return self.__org_taxes + + def set_org_taxes(self, org_taxes): + """ + The method to set the value to org_taxes + + Parameters: + org_taxes (OrgTax) : An instance of OrgTax + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.org_tax import OrgTax + except Exception: + from .org_tax import OrgTax + + if org_taxes is not None and not isinstance(org_taxes, OrgTax): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_taxes EXPECTED TYPE: OrgTax', None, None) + + self.__org_taxes = org_taxes + self.__key_modified['org_taxes'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/expected_field.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/expected_field.py new file mode 100644 index 0000000..f7bbab1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/expected_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExpectedField(object): + def __init__(self): + """Creates an instance of ExpectedField""" + + self.__api_name = None + self.__json_path = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_json_path(self): + """ + The method to get the json_path + + Returns: + string: A string representing the json_path + """ + + return self.__json_path + + def set_json_path(self, json_path): + """ + The method to set the value to json_path + + Parameters: + json_path (string) : A string representing the json_path + """ + + if json_path is not None and not isinstance(json_path, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: json_path EXPECTED TYPE: str', None, None) + + self.__json_path = json_path + self.__key_modified['json_path'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/org_tax.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/org_tax.py new file mode 100644 index 0000000..7909bdb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/org_tax.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OrgTax(object): + def __init__(self): + """Creates an instance of OrgTax""" + + self.__taxes = None + self.__preference = None + self.__key_modified = dict() + + def get_taxes(self): + """ + The method to get the taxes + + Returns: + list: An instance of list + """ + + return self.__taxes + + def set_taxes(self, taxes): + """ + The method to set the value to taxes + + Parameters: + taxes (list) : An instance of list + """ + + if taxes is not None and not isinstance(taxes, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: taxes EXPECTED TYPE: list', None, None) + + self.__taxes = taxes + self.__key_modified['taxes'] = 1 + + def get_preference(self): + """ + The method to get the preference + + Returns: + Preference: An instance of Preference + """ + + return self.__preference + + def set_preference(self, preference): + """ + The method to set the value to preference + + Parameters: + preference (Preference) : An instance of Preference + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.preference import Preference + except Exception: + from .preference import Preference + + if preference is not None and not isinstance(preference, Preference): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: preference EXPECTED TYPE: Preference', None, None) + + self.__preference = preference + self.__key_modified['preference'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/preference.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/preference.py new file mode 100644 index 0000000..ea438a9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/preference.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Preference(object): + def __init__(self): + """Creates an instance of Preference""" + + self.__auto_populate_tax = None + self.__modify_tax_rates = None + self.__key_modified = dict() + + def get_auto_populate_tax(self): + """ + The method to get the auto_populate_tax + + Returns: + bool: A bool representing the auto_populate_tax + """ + + return self.__auto_populate_tax + + def set_auto_populate_tax(self, auto_populate_tax): + """ + The method to set the value to auto_populate_tax + + Parameters: + auto_populate_tax (bool) : A bool representing the auto_populate_tax + """ + + if auto_populate_tax is not None and not isinstance(auto_populate_tax, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_populate_tax EXPECTED TYPE: bool', None, None) + + self.__auto_populate_tax = auto_populate_tax + self.__key_modified['auto_populate_tax'] = 1 + + def get_modify_tax_rates(self): + """ + The method to get the modify_tax_rates + + Returns: + bool: A bool representing the modify_tax_rates + """ + + return self.__modify_tax_rates + + def set_modify_tax_rates(self, modify_tax_rates): + """ + The method to set the value to modify_tax_rates + + Parameters: + modify_tax_rates (bool) : A bool representing the modify_tax_rates + """ + + if modify_tax_rates is not None and not isinstance(modify_tax_rates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modify_tax_rates EXPECTED TYPE: bool', None, None) + + self.__modify_tax_rates = modify_tax_rates + self.__key_modified['modify_tax_rates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/response_wrapper.py new file mode 100644 index 0000000..ec33fe8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/response_wrapper.py @@ -0,0 +1,82 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__org_taxes = None + self.__key_modified = dict() + + def get_org_taxes(self): + """ + The method to get the org_taxes + + Returns: + OrgTax: An instance of OrgTax + """ + + return self.__org_taxes + + def set_org_taxes(self, org_taxes): + """ + The method to set the value to org_taxes + + Parameters: + org_taxes (OrgTax) : An instance of OrgTax + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.org_tax import OrgTax + except Exception: + from .org_tax import OrgTax + + if org_taxes is not None and not isinstance(org_taxes, OrgTax): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_taxes EXPECTED TYPE: OrgTax', None, None) + + self.__org_taxes = org_taxes + self.__key_modified['org_taxes'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/success_response.py new file mode 100644 index 0000000..eb9eb86 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/tax.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/tax.py new file mode 100644 index 0000000..6192fc0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/tax.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tax(object): + def __init__(self): + """Creates an instance of Tax""" + + self.__display_label = None + self.__sequence_number = None + self.__name = None + self.__id = None + self.__value = None + self.__delete = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + float: A float representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (float) : A float representing the value + """ + + if value is not None and not isinstance(value, float): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: float', None, None) + + self.__value = value + self.__key_modified['value'] = 1 + + def get_delete(self): + """ + The method to get the delete + + Returns: + bool: A bool representing the delete + """ + + return self.__delete + + def set_delete(self, delete): + """ + The method to set the value to delete + + Parameters: + delete (bool) : A bool representing the delete + """ + + if delete is not None and not isinstance(delete, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete EXPECTED TYPE: bool', None, None) + + self.__delete = delete + self.__key_modified['_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/taxes/taxes_operations.py b/zohocrmsdk/src/com/zoho/crm/api/taxes/taxes_operations.py new file mode 100644 index 0000000..5302040 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/taxes/taxes_operations.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class TaxesOperations(object): + def __init__(self): + """Creates an instance of TaxesOperations""" + pass + + def get_taxes(self): + """ + The method to get taxes + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org/taxes' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_taxes(self, request): + """ + The method to update taxes + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/org/taxes' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_tax(self, id): + """ + The method to get tax + + 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/v7/org/taxes/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.taxes.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/templates/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/templates/__init__.py new file mode 100644 index 0000000..0b2a9db --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/templates/__init__.py @@ -0,0 +1,4 @@ +from .api_exception import APIException +from .folder import Folder +from .templates import Templates +from .wrapper import Wrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/templates/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/templates/api_exception.py new file mode 100644 index 0000000..5161635 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/templates/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/templates/folder.py b/zohocrmsdk/src/com/zoho/crm/api/templates/folder.py new file mode 100644 index 0000000..03de6e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/templates/folder.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Folder(object): + def __init__(self): + """Creates an instance of Folder""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/templates/templates.py b/zohocrmsdk/src/com/zoho/crm/api/templates/templates.py new file mode 100644 index 0000000..7b84f1e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/templates/templates.py @@ -0,0 +1,311 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Templates(object): + def __init__(self): + """Creates an instance of Templates""" + + self.__folder = None + self.__modified_by = None + self.__module = None + self.__modified_time = None + self.__subject = None + self.__name = None + self.__consent_linked = None + self.__favourite = None + self.__attachment_present = None + self.__id = None + self.__key_modified = dict() + + def get_folder(self): + """ + The method to get the folder + + Returns: + Folder: An instance of Folder + """ + + return self.__folder + + def set_folder(self, folder): + """ + The method to set the value to folder + + Parameters: + folder (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.templates.folder import Folder + except Exception: + from .folder import Folder + + if folder is not None and not isinstance(folder, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: folder EXPECTED TYPE: Folder', None, None) + + self.__folder = folder + self.__key_modified['folder'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Folder: An instance of Folder + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Folder) : An instance of Folder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.templates.folder import Folder + except Exception: + from .folder import Folder + + if modified_by is not None and not isinstance(modified_by, Folder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Folder', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_subject(self): + """ + The method to get the subject + + Returns: + string: A string representing the subject + """ + + return self.__subject + + def set_subject(self, subject): + """ + The method to set the value to subject + + Parameters: + subject (string) : A string representing the subject + """ + + if subject is not None and not isinstance(subject, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subject EXPECTED TYPE: str', None, None) + + self.__subject = subject + self.__key_modified['subject'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_consent_linked(self): + """ + The method to get the consent_linked + + Returns: + bool: A bool representing the consent_linked + """ + + return self.__consent_linked + + def set_consent_linked(self, consent_linked): + """ + The method to set the value to consent_linked + + Parameters: + consent_linked (bool) : A bool representing the consent_linked + """ + + if consent_linked is not None and not isinstance(consent_linked, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: consent_linked EXPECTED TYPE: bool', None, None) + + self.__consent_linked = consent_linked + self.__key_modified['consent_linked'] = 1 + + def get_favourite(self): + """ + The method to get the favourite + + Returns: + bool: A bool representing the favourite + """ + + return self.__favourite + + def set_favourite(self, favourite): + """ + The method to set the value to favourite + + Parameters: + favourite (bool) : A bool representing the favourite + """ + + if favourite is not None and not isinstance(favourite, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: favourite EXPECTED TYPE: bool', None, None) + + self.__favourite = favourite + self.__key_modified['favourite'] = 1 + + def get_attachment_present(self): + """ + The method to get the attachment_present + + Returns: + bool: A bool representing the attachment_present + """ + + return self.__attachment_present + + def set_attachment_present(self, attachment_present): + """ + The method to set the value to attachment_present + + Parameters: + attachment_present (bool) : A bool representing the attachment_present + """ + + if attachment_present is not None and not isinstance(attachment_present, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: attachment_present EXPECTED TYPE: bool', None, None) + + self.__attachment_present = attachment_present + self.__key_modified['attachment_present'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/templates/wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/templates/wrapper.py new file mode 100644 index 0000000..e8b795d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/templates/wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wrapper(object): + def __init__(self): + """Creates an instance of Wrapper""" + + self.__templates = None + self.__key_modified = dict() + + def get_templates(self): + """ + The method to get the templates + + Returns: + list: An instance of list + """ + + return self.__templates + + def set_templates(self, templates): + """ + The method to set the value to templates + + Parameters: + templates (list) : An instance of list + """ + + if templates is not None and not isinstance(templates, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: templates EXPECTED TYPE: list', None, None) + + self.__templates = templates + self.__key_modified['templates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/territories/__init__.py new file mode 100644 index 0000000..a7b3375 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/__init__.py @@ -0,0 +1,22 @@ +from .deleted_associated_wrapper import DeletedAssociatedWrapper +from .action_wrapper import ActionWrapper +from .manager import Manager +from .criteria import Criteria +from .territories_operations import TerritoriesOperations, GetTerritoriesParam, DeleteTerritoriesParam, DeleteTerritoryParam, GetChildTerritoryParam +from .body_wrapper import BodyWrapper +from .reporting_to import ReportingTo +from .associated_users_count import AssociatedUsersCount +from .transfer_territory import TransferTerritory +from .minified_territory import MinifiedTerritory +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .field import Field +from .territories import Territories +from .transfer_body_wrapper import TransferBodyWrapper +from .deleted_associated_territories import DeletedAssociatedTerritories +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .associated_users_count_wrapper import AssociatedUsersCountWrapper +from .action_handler import ActionHandler +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/territories/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/territories/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territories/action_wrapper.py new file mode 100644 index 0000000..7e06161 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/territories/api_exception.py new file mode 100644 index 0000000..0da1da9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count.py b/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count.py new file mode 100644 index 0000000..06b8acd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedUsersCount(object): + def __init__(self): + """Creates an instance of AssociatedUsersCount""" + + self.__count = None + self.__territory = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + string: A string representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (string) : A string representing the count + """ + + if count is not None and not isinstance(count, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: str', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_territory(self): + """ + The method to get the territory + + Returns: + MinifiedTerritory: An instance of MinifiedTerritory + """ + + return self.__territory + + def set_territory(self, territory): + """ + The method to set the value to territory + + Parameters: + territory (MinifiedTerritory) : An instance of MinifiedTerritory + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.minified_territory import MinifiedTerritory + except Exception: + from .minified_territory import MinifiedTerritory + + if territory is not None and not isinstance(territory, MinifiedTerritory): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: MinifiedTerritory', None, None) + + self.__territory = territory + self.__key_modified['territory'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count_wrapper.py new file mode 100644 index 0000000..08b3fcb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/associated_users_count_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociatedUsersCountWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of AssociatedUsersCountWrapper""" + super().__init__() + + self.__associated_users_count = None + self.__info = None + self.__key_modified = dict() + + def get_associated_users_count(self): + """ + The method to get the associated_users_count + + Returns: + list: An instance of list + """ + + return self.__associated_users_count + + def set_associated_users_count(self, associated_users_count): + """ + The method to set the value to associated_users_count + + Parameters: + associated_users_count (list) : An instance of list + """ + + if associated_users_count is not None and not isinstance(associated_users_count, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_users_count EXPECTED TYPE: list', None, None) + + self.__associated_users_count = associated_users_count + self.__key_modified['associated_users_count'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territories/body_wrapper.py new file mode 100644 index 0000000..5e9566b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/territories/criteria.py new file mode 100644 index 0000000..82ea82b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_territories.py b/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_territories.py new file mode 100644 index 0000000..e75b2e9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_territories.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DeletedAssociatedTerritories(object): + def __init__(self): + """Creates an instance of DeletedAssociatedTerritories""" + + self.__name = None + self.__id = None + self.__deleted_time = None + self.__deleted_by = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_deleted_time(self): + """ + The method to get the deleted_time + + Returns: + datetime: An instance of datetime + """ + + return self.__deleted_time + + def set_deleted_time(self, deleted_time): + """ + The method to set the value to deleted_time + + Parameters: + deleted_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if deleted_time is not None and not isinstance(deleted_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_time EXPECTED TYPE: datetime', None, None) + + self.__deleted_time = deleted_time + self.__key_modified['deleted_time'] = 1 + + def get_deleted_by(self): + """ + The method to get the deleted_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__deleted_by + + def set_deleted_by(self, deleted_by): + """ + The method to set the value to deleted_by + + Parameters: + deleted_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if deleted_by is not None and not isinstance(deleted_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__deleted_by = deleted_by + self.__key_modified['deleted_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_wrapper.py new file mode 100644 index 0000000..73fb296 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/deleted_associated_wrapper.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DeletedAssociatedWrapper(object): + def __init__(self): + """Creates an instance of DeletedAssociatedWrapper""" + + self.__territories = None + self.__info = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/field.py b/zohocrmsdk/src/com/zoho/crm/api/territories/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/info.py b/zohocrmsdk/src/com/zoho/crm/api/territories/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/manager.py b/zohocrmsdk/src/com/zoho/crm/api/territories/manager.py new file mode 100644 index 0000000..b7a8f34 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/manager.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Manager(object): + def __init__(self): + """Creates an instance of Manager""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/minified_territory.py b/zohocrmsdk/src/com/zoho/crm/api/territories/minified_territory.py new file mode 100644 index 0000000..c561e16 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/minified_territory.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedTerritory(object): + def __init__(self): + """Creates an instance of MinifiedTerritory""" + + self.__name = None + self.__id = None + self.__subordinates = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/reporting_to.py b/zohocrmsdk/src/com/zoho/crm/api/territories/reporting_to.py new file mode 100644 index 0000000..ddb09b9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/reporting_to.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ReportingTo(object): + def __init__(self): + """Creates an instance of ReportingTo""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/territories/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territories/response_wrapper.py new file mode 100644 index 0000000..8a3559f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__territories = None + self.__info = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/territories/success_response.py new file mode 100644 index 0000000..442d442 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territories.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/territories.py b/zohocrmsdk/src/com/zoho/crm/api/territories/territories.py new file mode 100644 index 0000000..034bf9c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/territories.py @@ -0,0 +1,438 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Territories(object): + def __init__(self): + """Creates an instance of Territories""" + + self.__created_time = None + self.__modified_time = None + self.__manager = None + self.__reporting_to = None + self.__permission_type = None + self.__modified_by = None + self.__description = None + self.__id = None + self.__created_by = None + self.__account_rule_criteria = None + self.__deal_rule_criteria = None + self.__lead_rule_criteria = None + self.__name = None + self.__api_name = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_manager(self): + """ + The method to get the manager + + Returns: + Manager: An instance of Manager + """ + + return self.__manager + + def set_manager(self, manager): + """ + The method to set the value to manager + + Parameters: + manager (Manager) : An instance of Manager + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.manager import Manager + except Exception: + from .manager import Manager + + if manager is not None and not isinstance(manager, Manager): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: manager EXPECTED TYPE: Manager', None, None) + + self.__manager = manager + self.__key_modified['manager'] = 1 + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + ReportingTo: An instance of ReportingTo + """ + + return self.__reporting_to + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (ReportingTo) : An instance of ReportingTo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.reporting_to import ReportingTo + except Exception: + from .reporting_to import ReportingTo + + if reporting_to is not None and not isinstance(reporting_to, ReportingTo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: ReportingTo', None, None) + + self.__reporting_to = reporting_to + self.__key_modified['reporting_to'] = 1 + + def get_permission_type(self): + """ + The method to get the permission_type + + Returns: + Choice: An instance of Choice + """ + + return self.__permission_type + + def set_permission_type(self, permission_type): + """ + The method to set the value to permission_type + + Parameters: + permission_type (Choice) : An instance of Choice + """ + + if permission_type is not None and not isinstance(permission_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: permission_type EXPECTED TYPE: Choice', None, None) + + self.__permission_type = permission_type + self.__key_modified['permission_type'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_account_rule_criteria(self): + """ + The method to get the account_rule_criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__account_rule_criteria + + def set_account_rule_criteria(self, account_rule_criteria): + """ + The method to set the value to account_rule_criteria + + Parameters: + account_rule_criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.criteria import Criteria + except Exception: + from .criteria import Criteria + + if account_rule_criteria is not None and not isinstance(account_rule_criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: account_rule_criteria EXPECTED TYPE: Criteria', None, None) + + self.__account_rule_criteria = account_rule_criteria + self.__key_modified['account_rule_criteria'] = 1 + + def get_deal_rule_criteria(self): + """ + The method to get the deal_rule_criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__deal_rule_criteria + + def set_deal_rule_criteria(self, deal_rule_criteria): + """ + The method to set the value to deal_rule_criteria + + Parameters: + deal_rule_criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.criteria import Criteria + except Exception: + from .criteria import Criteria + + if deal_rule_criteria is not None and not isinstance(deal_rule_criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deal_rule_criteria EXPECTED TYPE: Criteria', None, None) + + self.__deal_rule_criteria = deal_rule_criteria + self.__key_modified['deal_rule_criteria'] = 1 + + def get_lead_rule_criteria(self): + """ + The method to get the lead_rule_criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__lead_rule_criteria + + def set_lead_rule_criteria(self, lead_rule_criteria): + """ + The method to set the value to lead_rule_criteria + + Parameters: + lead_rule_criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.criteria import Criteria + except Exception: + from .criteria import Criteria + + if lead_rule_criteria is not None and not isinstance(lead_rule_criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: lead_rule_criteria EXPECTED TYPE: Criteria', None, None) + + self.__lead_rule_criteria = lead_rule_criteria + self.__key_modified['lead_rule_criteria'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/territories_operations.py b/zohocrmsdk/src/com/zoho/crm/api/territories/territories_operations.py new file mode 100644 index 0000000..3d6fdb7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/territories_operations.py @@ -0,0 +1,431 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class TerritoriesOperations(object): + def __init__(self): + """Creates an instance of TerritoriesOperations""" + pass + + def get_territories(self, param_instance=None): + """ + The method to get territories + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/territories' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_territories(self, request): + """ + The method to create territories + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/territories' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_territories(self, request): + """ + The method to update territories + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/territories' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_territories(self, param_instance=None): + """ + The method to delete territories + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/territories' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_territory(self, id): + """ + The method to get territory + + 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/v7/settings/territories/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_territory(self, id, request): + """ + The method to update territory + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/territories/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_territory(self, id, param_instance=None): + """ + The method to delete territory + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/territories/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_child_territory(self, id, param_instance=None): + """ + The method to get child territory + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/territories/' + api_path = api_path + str(id) + api_path = api_path + '/__child_territories' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associated_user_count(self): + """ + The method to get associated user count + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/actions/associated_users_count' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def transfer_and_delete_territory(self, id, request): + """ + The method to transfer and delete territory + + Parameters: + id (int) : An int representing the id + request (TransferBodyWrapper) : An instance of TransferBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.transfer_body_wrapper import TransferBodyWrapper + except Exception: + from .transfer_body_wrapper import TransferBodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, TransferBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(id) + api_path = api_path + '/actions/transfer_and_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def transfer_and_delete_territories(self, request): + """ + The method to transfer and delete territories + + Parameters: + request (TransferBodyWrapper) : An instance of TransferBodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.transfer_body_wrapper import TransferBodyWrapper + except Exception: + from .transfer_body_wrapper import TransferBodyWrapper + + if request is not None and not isinstance(request, TransferBodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferBodyWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/actions/transfer_and_delete' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetTerritoriesParam(object): + filters = Param('filters', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + include = Param('include', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + page = Param('page', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + per_page = Param('per_page', 'com.zoho.crm.api.Territories.GetTerritoriesParam') + + +class DeleteTerritoriesParam(object): + ids = Param('ids', 'com.zoho.crm.api.Territories.DeleteTerritoriesParam') + delete_previous_forecasts = Param('delete_previous_forecasts', 'com.zoho.crm.api.Territories.DeleteTerritoriesParam') + + +class DeleteTerritoryParam(object): + delete_previous_forecasts = Param('delete_previous_forecasts', 'com.zoho.crm.api.Territories.DeleteTerritoryParam') + + +class GetChildTerritoryParam(object): + filters = Param('filters', 'com.zoho.crm.api.Territories.GetChildTerritoryParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_body_wrapper.py new file mode 100644 index 0000000..6ca28ce --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferBodyWrapper(object): + def __init__(self): + """Creates an instance of TransferBodyWrapper""" + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_territory.py b/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_territory.py new file mode 100644 index 0000000..be83663 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territories/transfer_territory.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferTerritory(object): + def __init__(self): + """Creates an instance of TransferTerritory""" + + self.__id = None + self.__transfer_to_id = None + self.__delete_previous_forecasts = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_transfer_to_id(self): + """ + The method to get the transfer_to_id + + Returns: + int: An int representing the transfer_to_id + """ + + return self.__transfer_to_id + + def set_transfer_to_id(self, transfer_to_id): + """ + The method to set the value to transfer_to_id + + Parameters: + transfer_to_id (int) : An int representing the transfer_to_id + """ + + if transfer_to_id is not None and not isinstance(transfer_to_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_to_id EXPECTED TYPE: int', None, None) + + self.__transfer_to_id = transfer_to_id + self.__key_modified['transfer_to_id'] = 1 + + def get_delete_previous_forecasts(self): + """ + The method to get the delete_previous_forecasts + + Returns: + bool: A bool representing the delete_previous_forecasts + """ + + return self.__delete_previous_forecasts + + def set_delete_previous_forecasts(self, delete_previous_forecasts): + """ + The method to set the value to delete_previous_forecasts + + Parameters: + delete_previous_forecasts (bool) : A bool representing the delete_previous_forecasts + """ + + if delete_previous_forecasts is not None and not isinstance(delete_previous_forecasts, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: delete_previous_forecasts EXPECTED TYPE: bool', None, None) + + self.__delete_previous_forecasts = delete_previous_forecasts + self.__key_modified['delete_previous_forecasts'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/__init__.py new file mode 100644 index 0000000..37586e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/__init__.py @@ -0,0 +1,10 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .territory_users_operations import TerritoryUsersOperations, DeassociateTerritoryUsersParam +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_wrapper.py new file mode 100644 index 0000000..0d43322 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/api_exception.py new file mode 100644 index 0000000..1f860ea --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/body_wrapper.py new file mode 100644 index 0000000..9160577 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/info.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_wrapper.py new file mode 100644 index 0000000..8eb9d8e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users = None + self.__info = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/success_response.py new file mode 100644 index 0000000..f4fcfd5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/territory_users/territory_users_operations.py b/zohocrmsdk/src/com/zoho/crm/api/territory_users/territory_users_operations.py new file mode 100644 index 0000000..d4e4f2c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/territory_users/territory_users_operations.py @@ -0,0 +1,241 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class TerritoryUsersOperations(object): + def __init__(self): + """Creates an instance of TerritoryUsersOperations""" + pass + + def get_territory_users(self, territory): + """ + The method to get territory users + + Parameters: + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_territory_users(self, territory, request): + """ + The method to update territory users + + Parameters: + territory (int) : An int representing the territory + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory 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/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def deassociate_territory_users(self, territory, param_instance=None): + """ + The method to deassociate territory users + + Parameters: + territory (int) : An int representing the territory + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + 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/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_territory_user(self, user, territory): + """ + The method to get territory user + + Parameters: + user (int) : An int representing the user + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users/' + api_path = api_path + str(user) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_territory_user(self, user, territory): + """ + The method to update territory user + + Parameters: + user (int) : An int representing the user + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users/' + api_path = api_path + str(user) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def deassociate_territory_user(self, user, territory): + """ + The method to deassociate territory user + + Parameters: + user (int) : An int representing the user + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/users/' + api_path = api_path + str(user) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.territory_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class DeassociateTerritoryUsersParam(object): + ids = Param('ids', 'com.zoho.crm.api.TerritoryUsers.DeassociateTerritoryUsersParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/__init__.py new file mode 100644 index 0000000..eda829f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/__init__.py @@ -0,0 +1,16 @@ +from .related_record import RelatedRecord +from .automation_detail import AutomationDetail +from .module import Module +from .picklist_detail import PicklistDetail +from .api_exception import APIException +from .response_handler import ResponseHandler +from .timelines_operations import TimelinesOperations, GetTimelinesParam +from .field_history_value import FieldHistoryValue +from .record import Record +from .path_finder import PathFinder +from .response_wrapper import ResponseWrapper +from .timeline import Timeline +from .state import State +from .name_id_structure import NameIdStructure +from .field_history import FieldHistory +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/api_exception.py new file mode 100644 index 0000000..54523ff --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.timelines.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/automation_detail.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/automation_detail.py new file mode 100644 index 0000000..a81556e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/automation_detail.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutomationDetail(object): + def __init__(self): + """Creates an instance of AutomationDetail""" + + self.__type = None + self.__rule = None + self.__pathfinder = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_rule(self): + """ + The method to get the rule + + Returns: + NameIdStructure: An instance of NameIdStructure + """ + + return self.__rule + + def set_rule(self, rule): + """ + The method to set the value to rule + + Parameters: + rule (NameIdStructure) : An instance of NameIdStructure + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.name_id_structure import NameIdStructure + except Exception: + from .name_id_structure import NameIdStructure + + if rule is not None and not isinstance(rule, NameIdStructure): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rule EXPECTED TYPE: NameIdStructure', None, None) + + self.__rule = rule + self.__key_modified['rule'] = 1 + + def get_pathfinder(self): + """ + The method to get the pathfinder + + Returns: + PathFinder: An instance of PathFinder + """ + + return self.__pathfinder + + def set_pathfinder(self, pathfinder): + """ + The method to set the value to pathfinder + + Parameters: + pathfinder (PathFinder) : An instance of PathFinder + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.path_finder import PathFinder + except Exception: + from .path_finder import PathFinder + + if pathfinder is not None and not isinstance(pathfinder, PathFinder): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pathfinder EXPECTED TYPE: PathFinder', None, None) + + self.__pathfinder = pathfinder + self.__key_modified['pathfinder'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history.py new file mode 100644 index 0000000..3199347 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history.py @@ -0,0 +1,229 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldHistory(object): + def __init__(self): + """Creates an instance of FieldHistory""" + + self.__data_type = None + self.__enable_colour_code = None + self.__pick_list_values = None + self.__field_label = None + self.__api_name = None + self.__id = None + self.__value = None + self.__key_modified = dict() + + def get_data_type(self): + """ + The method to get the data_type + + Returns: + string: A string representing the data_type + """ + + return self.__data_type + + def set_data_type(self, data_type): + """ + The method to set the value to data_type + + Parameters: + data_type (string) : A string representing the data_type + """ + + if data_type is not None and not isinstance(data_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_type EXPECTED TYPE: str', None, None) + + self.__data_type = data_type + self.__key_modified['data_type'] = 1 + + def get_enable_colour_code(self): + """ + The method to get the enable_colour_code + + Returns: + bool: A bool representing the enable_colour_code + """ + + return self.__enable_colour_code + + def set_enable_colour_code(self, enable_colour_code): + """ + The method to set the value to enable_colour_code + + Parameters: + enable_colour_code (bool) : A bool representing the enable_colour_code + """ + + if enable_colour_code is not None and not isinstance(enable_colour_code, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enable_colour_code EXPECTED TYPE: bool', None, None) + + self.__enable_colour_code = enable_colour_code + self.__key_modified['enable_colour_code'] = 1 + + def get_pick_list_values(self): + """ + The method to get the pick_list_values + + Returns: + list: An instance of list + """ + + return self.__pick_list_values + + def set_pick_list_values(self, pick_list_values): + """ + The method to set the value to pick_list_values + + Parameters: + pick_list_values (list) : An instance of list + """ + + if pick_list_values is not None and not isinstance(pick_list_values, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pick_list_values EXPECTED TYPE: list', None, None) + + self.__pick_list_values = pick_list_values + self.__key_modified['pick_list_values'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + FieldHistoryValue: An instance of FieldHistoryValue + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (FieldHistoryValue) : An instance of FieldHistoryValue + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.field_history_value import FieldHistoryValue + except Exception: + from .field_history_value import FieldHistoryValue + + if value is not None and not isinstance(value, FieldHistoryValue): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: value EXPECTED TYPE: FieldHistoryValue', None, None) + + self.__value = value + self.__key_modified['_value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history_value.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history_value.py new file mode 100644 index 0000000..b27e152 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/field_history_value.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FieldHistoryValue(object): + def __init__(self): + """Creates an instance of FieldHistoryValue""" + + self.__new = None + self.__old = None + self.__key_modified = dict() + + def get_new(self): + """ + The method to get the new + + Returns: + string: A string representing the new + """ + + return self.__new + + def set_new(self, new): + """ + The method to set the value to new + + Parameters: + new (string) : A string representing the new + """ + + if new is not None and not isinstance(new, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: new EXPECTED TYPE: str', None, None) + + self.__new = new + self.__key_modified['new'] = 1 + + def get_old(self): + """ + The method to get the old + + Returns: + string: A string representing the old + """ + + return self.__old + + def set_old(self, old): + """ + The method to set the value to old + + Parameters: + old (string) : A string representing the old + """ + + if old is not None and not isinstance(old, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: old EXPECTED TYPE: str', None, None) + + self.__old = old + self.__key_modified['old'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/info.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/info.py new file mode 100644 index 0000000..55b7d3d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/info.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__page = None + self.__count = None + self.__more_records = None + self.__next_page_token = None + self.__previous_page_token = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 get_next_page_token(self): + """ + The method to get the next_page_token + + Returns: + string: A string representing the next_page_token + """ + + return self.__next_page_token + + def set_next_page_token(self, next_page_token): + """ + The method to set the value to next_page_token + + Parameters: + next_page_token (string) : A string representing the next_page_token + """ + + if next_page_token is not None and not isinstance(next_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_page_token EXPECTED TYPE: str', None, None) + + self.__next_page_token = next_page_token + self.__key_modified['next_page_token'] = 1 + + def get_previous_page_token(self): + """ + The method to get the previous_page_token + + Returns: + string: A string representing the previous_page_token + """ + + return self.__previous_page_token + + def set_previous_page_token(self, previous_page_token): + """ + The method to set the value to previous_page_token + + Parameters: + previous_page_token (string) : A string representing the previous_page_token + """ + + if previous_page_token is not None and not isinstance(previous_page_token, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: previous_page_token EXPECTED TYPE: str', None, None) + + self.__previous_page_token = previous_page_token + self.__key_modified['previous_page_token'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/module.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/module.py new file mode 100644 index 0000000..e50dd52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/name_id_structure.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/name_id_structure.py new file mode 100644 index 0000000..0eca1ef --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/name_id_structure.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class NameIdStructure(object): + def __init__(self): + """Creates an instance of NameIdStructure""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/path_finder.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/path_finder.py new file mode 100644 index 0000000..d47fad2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/path_finder.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PathFinder(object): + def __init__(self): + """Creates an instance of PathFinder""" + + self.__process_entry = None + self.__process_exit = None + self.__state = None + self.__key_modified = dict() + + def get_process_entry(self): + """ + The method to get the process_entry + + Returns: + bool: A bool representing the process_entry + """ + + return self.__process_entry + + def set_process_entry(self, process_entry): + """ + The method to set the value to process_entry + + Parameters: + process_entry (bool) : A bool representing the process_entry + """ + + if process_entry is not None and not isinstance(process_entry, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_entry EXPECTED TYPE: bool', None, None) + + self.__process_entry = process_entry + self.__key_modified['process_entry'] = 1 + + def get_process_exit(self): + """ + The method to get the process_exit + + Returns: + bool: A bool representing the process_exit + """ + + return self.__process_exit + + def set_process_exit(self, process_exit): + """ + The method to set the value to process_exit + + Parameters: + process_exit (bool) : A bool representing the process_exit + """ + + if process_exit is not None and not isinstance(process_exit, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: process_exit EXPECTED TYPE: bool', None, None) + + self.__process_exit = process_exit + self.__key_modified['process_exit'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + State: An instance of State + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (State) : An instance of State + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.state import State + except Exception: + from .state import State + + if state is not None and not isinstance(state, State): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: State', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/picklist_detail.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/picklist_detail.py new file mode 100644 index 0000000..a180d30 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/picklist_detail.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PicklistDetail(object): + def __init__(self): + """Creates an instance of PicklistDetail""" + + self.__display_value = None + self.__sequence_number = None + self.__colour_code = None + self.__actual_value = None + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_display_value(self): + """ + The method to get the display_value + + Returns: + string: A string representing the display_value + """ + + return self.__display_value + + def set_display_value(self, display_value): + """ + The method to set the value to display_value + + Parameters: + display_value (string) : A string representing the display_value + """ + + if display_value is not None and not isinstance(display_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_value EXPECTED TYPE: str', None, None) + + self.__display_value = display_value + self.__key_modified['display_value'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_colour_code(self): + """ + The method to get the colour_code + + Returns: + string: A string representing the colour_code + """ + + return self.__colour_code + + def set_colour_code(self, colour_code): + """ + The method to set the value to colour_code + + Parameters: + colour_code (string) : A string representing the colour_code + """ + + if colour_code is not None and not isinstance(colour_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: colour_code EXPECTED TYPE: str', None, None) + + self.__colour_code = colour_code + self.__key_modified['colour_code'] = 1 + + def get_actual_value(self): + """ + The method to get the actual_value + + Returns: + string: A string representing the actual_value + """ + + return self.__actual_value + + def set_actual_value(self, actual_value): + """ + The method to set the value to actual_value + + Parameters: + actual_value (string) : A string representing the actual_value + """ + + if actual_value is not None and not isinstance(actual_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actual_value EXPECTED TYPE: str', None, None) + + self.__actual_value = actual_value + self.__key_modified['actual_value'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/record.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/record.py new file mode 100644 index 0000000..90a5187 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Record(object): + def __init__(self): + """Creates an instance of Record""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/related_record.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/related_record.py new file mode 100644 index 0000000..7fcd3bb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/related_record.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class RelatedRecord(object): + def __init__(self): + """Creates an instance of RelatedRecord""" + + self.__name = None + self.__id = None + self.__module = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + NameIdStructure: An instance of NameIdStructure + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (NameIdStructure) : An instance of NameIdStructure + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.name_id_structure import NameIdStructure + except Exception: + from .name_id_structure import NameIdStructure + + if module is not None and not isinstance(module, NameIdStructure): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: NameIdStructure', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/response_wrapper.py new file mode 100644 index 0000000..fadd169 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.timelines.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__timeline = None + self.__info = None + self.__key_modified = dict() + + def get_timeline(self): + """ + The method to get the timeline + + Returns: + list: An instance of list + """ + + return self.__timeline + + def set_timeline(self, timeline): + """ + The method to set the value to timeline + + Parameters: + timeline (list) : An instance of list + """ + + if timeline is not None and not isinstance(timeline, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: timeline EXPECTED TYPE: list', None, None) + + self.__timeline = timeline + self.__key_modified['__timeline'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/state.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/state.py new file mode 100644 index 0000000..990d92a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/state.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class State(object): + def __init__(self): + """Creates an instance of State""" + + self.__trigger_type = None + self.__name = None + self.__is_last_state = None + self.__id = None + self.__key_modified = dict() + + def get_trigger_type(self): + """ + The method to get the trigger_type + + Returns: + string: A string representing the trigger_type + """ + + return self.__trigger_type + + def set_trigger_type(self, trigger_type): + """ + The method to set the value to trigger_type + + Parameters: + trigger_type (string) : A string representing the trigger_type + """ + + if trigger_type is not None and not isinstance(trigger_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: trigger_type EXPECTED TYPE: str', None, None) + + self.__trigger_type = trigger_type + self.__key_modified['trigger_type'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_is_last_state(self): + """ + The method to get the is_last_state + + Returns: + bool: A bool representing the is_last_state + """ + + return self.__is_last_state + + def set_is_last_state(self, is_last_state): + """ + The method to set the value to is_last_state + + Parameters: + is_last_state (bool) : A bool representing the is_last_state + """ + + if is_last_state is not None and not isinstance(is_last_state, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: is_last_state EXPECTED TYPE: bool', None, None) + + self.__is_last_state = is_last_state + self.__key_modified['is_last_state'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/timeline.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/timeline.py new file mode 100644 index 0000000..0a355db --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/timeline.py @@ -0,0 +1,346 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Timeline(object): + def __init__(self): + """Creates an instance of Timeline""" + + self.__audited_time = None + self.__action = None + self.__id = None + self.__source = None + self.__extension = None + self.__type = None + self.__done_by = None + self.__related_record = None + self.__automation_details = None + self.__record = None + self.__field_history = None + self.__key_modified = dict() + + def get_audited_time(self): + """ + The method to get the audited_time + + Returns: + datetime: An instance of datetime + """ + + return self.__audited_time + + def set_audited_time(self, audited_time): + """ + The method to set the value to audited_time + + Parameters: + audited_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if audited_time is not None and not isinstance(audited_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: audited_time EXPECTED TYPE: datetime', None, None) + + self.__audited_time = audited_time + self.__key_modified['audited_time'] = 1 + + def get_action(self): + """ + The method to get the action + + Returns: + string: A string representing the action + """ + + return self.__action + + def set_action(self, action): + """ + The method to set the value to action + + Parameters: + action (string) : A string representing the action + """ + + if action is not None and not isinstance(action, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action EXPECTED TYPE: str', None, None) + + self.__action = action + self.__key_modified['action'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_extension(self): + """ + The method to get the extension + + Returns: + string: A string representing the extension + """ + + return self.__extension + + def set_extension(self, extension): + """ + The method to set the value to extension + + Parameters: + extension (string) : A string representing the extension + """ + + if extension is not None and not isinstance(extension, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: extension EXPECTED TYPE: str', None, None) + + self.__extension = extension + self.__key_modified['extension'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_done_by(self): + """ + The method to get the done_by + + Returns: + NameIdStructure: An instance of NameIdStructure + """ + + return self.__done_by + + def set_done_by(self, done_by): + """ + The method to set the value to done_by + + Parameters: + done_by (NameIdStructure) : An instance of NameIdStructure + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.name_id_structure import NameIdStructure + except Exception: + from .name_id_structure import NameIdStructure + + if done_by is not None and not isinstance(done_by, NameIdStructure): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: done_by EXPECTED TYPE: NameIdStructure', None, None) + + self.__done_by = done_by + self.__key_modified['done_by'] = 1 + + def get_related_record(self): + """ + The method to get the related_record + + Returns: + RelatedRecord: An instance of RelatedRecord + """ + + return self.__related_record + + def set_related_record(self, related_record): + """ + The method to set the value to related_record + + Parameters: + related_record (RelatedRecord) : An instance of RelatedRecord + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.related_record import RelatedRecord + except Exception: + from .related_record import RelatedRecord + + if related_record is not None and not isinstance(related_record, RelatedRecord): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_record EXPECTED TYPE: RelatedRecord', None, None) + + self.__related_record = related_record + self.__key_modified['related_record'] = 1 + + def get_automation_details(self): + """ + The method to get the automation_details + + Returns: + AutomationDetail: An instance of AutomationDetail + """ + + return self.__automation_details + + def set_automation_details(self, automation_details): + """ + The method to set the value to automation_details + + Parameters: + automation_details (AutomationDetail) : An instance of AutomationDetail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.automation_detail import AutomationDetail + except Exception: + from .automation_detail import AutomationDetail + + if automation_details is not None and not isinstance(automation_details, AutomationDetail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: automation_details EXPECTED TYPE: AutomationDetail', None, None) + + self.__automation_details = automation_details + self.__key_modified['automation_details'] = 1 + + def get_record(self): + """ + The method to get the record + + Returns: + Record: An instance of Record + """ + + return self.__record + + def set_record(self, record): + """ + The method to set the value to record + + Parameters: + record (Record) : An instance of Record + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.record import Record + except Exception: + from .record import Record + + if record is not None and not isinstance(record, Record): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record EXPECTED TYPE: Record', None, None) + + self.__record = record + self.__key_modified['record'] = 1 + + def get_field_history(self): + """ + The method to get the field_history + + Returns: + list: An instance of list + """ + + return self.__field_history + + def set_field_history(self, field_history): + """ + The method to set the value to field_history + + Parameters: + field_history (list) : An instance of list + """ + + if field_history is not None and not isinstance(field_history, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_history EXPECTED TYPE: list', None, None) + + self.__field_history = field_history + self.__key_modified['field_history'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/timelines/timelines_operations.py b/zohocrmsdk/src/com/zoho/crm/api/timelines/timelines_operations.py new file mode 100644 index 0000000..167545d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/timelines/timelines_operations.py @@ -0,0 +1,73 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class TimelinesOperations(object): + def __init__(self): + """Creates an instance of TimelinesOperations""" + pass + + def get_timelines(self, module, record_id, param_instance=None): + """ + The method to get timelines + + Parameters: + module (string) : A string representing the module + record_id (string) : A string representing the record_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + if not isinstance(record_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: record_id EXPECTED TYPE: str', None, None) + + 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/v7/' + api_path = api_path + str(module) + api_path = api_path + '/' + api_path = api_path + str(record_id) + api_path = api_path + '/__timeline' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.timelines.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetTimelinesParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + include_timeline_type = Param('include_timeline_type', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + include = Param('include', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + filters = Param('filters', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + per_page = Param('per_page', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + page = Param('page', 'com.zoho.crm.api.Timelines.GetTimelinesParam') + page_token = Param('page_token', 'com.zoho.crm.api.Timelines.GetTimelinesParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/__init__.py new file mode 100644 index 0000000..c76331c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/__init__.py @@ -0,0 +1,7 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .unblock_email_operations import UnblockEmailOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_wrapper.py new file mode 100644 index 0000000..5719d26 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__data = None + self.__key_modified = dict() + + def get_data(self): + """ + The method to get the data + + Returns: + list: An instance of list + """ + + return self.__data + + def set_data(self, data): + """ + The method to set the value to data + + Parameters: + data (list) : An instance of list + """ + + if data is not None and not isinstance(data, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data EXPECTED TYPE: list', None, None) + + self.__data = data + self.__key_modified['data'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/api_exception.py new file mode 100644 index 0000000..02f741e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_handler import ActionHandler + + +class APIException(ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/body_wrapper.py new file mode 100644 index 0000000..f1d58f3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/body_wrapper.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__ids = None + self.__unblock_fields = None + self.__key_modified = dict() + + def get_ids(self): + """ + The method to get the ids + + Returns: + list: An instance of list + """ + + return self.__ids + + def set_ids(self, ids): + """ + The method to set the value to ids + + Parameters: + ids (list) : An instance of list + """ + + if ids is not None and not isinstance(ids, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ids EXPECTED TYPE: list', None, None) + + self.__ids = ids + self.__key_modified['ids'] = 1 + + def get_unblock_fields(self): + """ + The method to get the unblock_fields + + Returns: + list: An instance of list + """ + + return self.__unblock_fields + + def set_unblock_fields(self, unblock_fields): + """ + The method to set the value to unblock_fields + + Parameters: + unblock_fields (list) : An instance of list + """ + + if unblock_fields is not None and not isinstance(unblock_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unblock_fields EXPECTED TYPE: list', None, None) + + self.__unblock_fields = unblock_fields + self.__key_modified['unblock_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/success_response.py new file mode 100644 index 0000000..e924303 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + string: A string representing the code + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (string) : A string representing the code + """ + + if code is not None and not isinstance(code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: str', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unblock_email/unblock_email_operations.py b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/unblock_email_operations.py new file mode 100644 index 0000000..c9d6373 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unblock_email/unblock_email_operations.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class UnblockEmailOperations(object): + def __init__(self, module): + """ + Creates an instance of UnblockEmailOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def unblock_emails(self, request): + """ + The method to unblock emails + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/actions/unblock_email' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def unblock_email(self, id, request): + """ + The method to unblock email + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/' + api_path = api_path + str(self.__module) + api_path = api_path + '/' + api_path = api_path + str(id) + api_path = api_path + '/actions/unblock_email' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_POST) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.unblock_email.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/__init__.py new file mode 100644 index 0000000..1eec210 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .associations_response_wrapper import AssociationsResponseWrapper +from .resource import Resource +from .module import Module +from .body_wrapper import BodyWrapper +from .associations_response_handler import AssociationsResponseHandler +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .association_details import AssociationDetails +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .unsubscribe_links import UnsubscribeLinks +from .action_handler import ActionHandler +from .detail import Detail +from .associated_places import AssociatedPlaces +from .unsubscribe_links_operations import UnsubscribeLinksOperations +from .user import User diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_wrapper.py new file mode 100644 index 0000000..d14d805 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__unsubscribe_links = None + self.__key_modified = dict() + + def get_unsubscribe_links(self): + """ + The method to get the unsubscribe_links + + Returns: + list: An instance of list + """ + + return self.__unsubscribe_links + + def set_unsubscribe_links(self, unsubscribe_links): + """ + The method to set the value to unsubscribe_links + + Parameters: + unsubscribe_links (list) : An instance of list + """ + + if unsubscribe_links is not None and not isinstance(unsubscribe_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_links EXPECTED TYPE: list', None, None) + + self.__unsubscribe_links = unsubscribe_links + self.__key_modified['unsubscribe_links'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/api_exception.py new file mode 100644 index 0000000..f37ac08 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.associations_response_handler import AssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + from .associations_response_handler import AssociationsResponseHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse, AssociationsResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associated_places.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associated_places.py new file mode 100644 index 0000000..555c79d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associated_places.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedPlaces(object): + def __init__(self): + """Creates an instance of AssociatedPlaces""" + + self.__type = None + self.__resource = None + self.__details = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + Resource: An instance of Resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Resource) : An instance of Resource + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.resource import Resource + except Exception: + from .resource import Resource + + if resource is not None and not isinstance(resource, Resource): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Resource', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + Detail: An instance of Detail + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (Detail) : An instance of Detail + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.detail import Detail + except Exception: + from .detail import Detail + + if details is not None and not isinstance(details, Detail): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: Detail', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/association_details.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/association_details.py new file mode 100644 index 0000000..48791db --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/association_details.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationDetails(object): + def __init__(self): + """Creates an instance of AssociationDetails""" + + self.__id = None + self.__associated_places = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_associated_places(self): + """ + The method to get the associated_places + + Returns: + list: An instance of list + """ + + return self.__associated_places + + def set_associated_places(self, associated_places): + """ + The method to set the value to associated_places + + Parameters: + associated_places (list) : An instance of list + """ + + if associated_places is not None and not isinstance(associated_places, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_places EXPECTED TYPE: list', None, None) + + self.__associated_places = associated_places + self.__key_modified['associated_places'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_handler.py new file mode 100644 index 0000000..0b460f7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class AssociationsResponseHandler(ABC): + def __init__(self): + """Creates an instance of AssociationsResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_wrapper.py new file mode 100644 index 0000000..e85a67e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/associations_response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.associations_response_handler import AssociationsResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .associations_response_handler import AssociationsResponseHandler + + +class AssociationsResponseWrapper(AssociationsResponseHandler): + def __init__(self): + """Creates an instance of AssociationsResponseWrapper""" + super().__init__() + + self.__associations = None + self.__key_modified = dict() + + def get_associations(self): + """ + The method to get the associations + + Returns: + list: An instance of list + """ + + return self.__associations + + def set_associations(self, associations): + """ + The method to set the value to associations + + Parameters: + associations (list) : An instance of list + """ + + if associations is not None and not isinstance(associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associations EXPECTED TYPE: list', None, None) + + self.__associations = associations + self.__key_modified['associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/body_wrapper.py new file mode 100644 index 0000000..4456831 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__unsubscribe_links = None + self.__key_modified = dict() + + def get_unsubscribe_links(self): + """ + The method to get the unsubscribe_links + + Returns: + list: An instance of list + """ + + return self.__unsubscribe_links + + def set_unsubscribe_links(self, unsubscribe_links): + """ + The method to set the value to unsubscribe_links + + Parameters: + unsubscribe_links (list) : An instance of list + """ + + if unsubscribe_links is not None and not isinstance(unsubscribe_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_links EXPECTED TYPE: list', None, None) + + self.__unsubscribe_links = unsubscribe_links + self.__key_modified['unsubscribe_links'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/detail.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/detail.py new file mode 100644 index 0000000..8241f38 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/detail.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Detail(object): + def __init__(self): + """Creates an instance of Detail""" + + self.__module = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/module.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/module.py new file mode 100644 index 0000000..93604c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/resource.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/resource.py new file mode 100644 index 0000000..ae2a6ea --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_wrapper.py new file mode 100644 index 0000000..782877f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__unsubscribe_links = None + self.__key_modified = dict() + + def get_unsubscribe_links(self): + """ + The method to get the unsubscribe_links + + Returns: + list: An instance of list + """ + + return self.__unsubscribe_links + + def set_unsubscribe_links(self, unsubscribe_links): + """ + The method to set the value to unsubscribe_links + + Parameters: + unsubscribe_links (list) : An instance of list + """ + + if unsubscribe_links is not None and not isinstance(unsubscribe_links, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: unsubscribe_links EXPECTED TYPE: list', None, None) + + self.__unsubscribe_links = unsubscribe_links + self.__key_modified['unsubscribe_links'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/success_response.py new file mode 100644 index 0000000..adfc738 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links.py new file mode 100644 index 0000000..d625fd8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links.py @@ -0,0 +1,438 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class UnsubscribeLinks(object): + def __init__(self): + """Creates an instance of UnsubscribeLinks""" + + self.__id = None + self.__name = None + self.__page_type = None + self.__custom_location_url = None + self.__standard_page_message = None + self.__submission_action_type = None + self.__submission_message = None + self.__submission_redirect_url = None + self.__location_url_type = None + self.__action_on_unsubscribe = None + self.__created_by = None + self.__modified_by = None + self.__modified_time = None + self.__created_time = None + self.__landing_url = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_page_type(self): + """ + The method to get the page_type + + Returns: + Choice: An instance of Choice + """ + + return self.__page_type + + def set_page_type(self, page_type): + """ + The method to set the value to page_type + + Parameters: + page_type (Choice) : An instance of Choice + """ + + if page_type is not None and not isinstance(page_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page_type EXPECTED TYPE: Choice', None, None) + + self.__page_type = page_type + self.__key_modified['page_type'] = 1 + + def get_custom_location_url(self): + """ + The method to get the custom_location_url + + Returns: + string: A string representing the custom_location_url + """ + + return self.__custom_location_url + + def set_custom_location_url(self, custom_location_url): + """ + The method to set the value to custom_location_url + + Parameters: + custom_location_url (string) : A string representing the custom_location_url + """ + + if custom_location_url is not None and not isinstance(custom_location_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: custom_location_url EXPECTED TYPE: str', None, None) + + self.__custom_location_url = custom_location_url + self.__key_modified['custom_location_url'] = 1 + + def get_standard_page_message(self): + """ + The method to get the standard_page_message + + Returns: + string: A string representing the standard_page_message + """ + + return self.__standard_page_message + + def set_standard_page_message(self, standard_page_message): + """ + The method to set the value to standard_page_message + + Parameters: + standard_page_message (string) : A string representing the standard_page_message + """ + + if standard_page_message is not None and not isinstance(standard_page_message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: standard_page_message EXPECTED TYPE: str', None, None) + + self.__standard_page_message = standard_page_message + self.__key_modified['standard_page_message'] = 1 + + def get_submission_action_type(self): + """ + The method to get the submission_action_type + + Returns: + Choice: An instance of Choice + """ + + return self.__submission_action_type + + def set_submission_action_type(self, submission_action_type): + """ + The method to set the value to submission_action_type + + Parameters: + submission_action_type (Choice) : An instance of Choice + """ + + if submission_action_type is not None and not isinstance(submission_action_type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: submission_action_type EXPECTED TYPE: Choice', None, None) + + self.__submission_action_type = submission_action_type + self.__key_modified['submission_action_type'] = 1 + + def get_submission_message(self): + """ + The method to get the submission_message + + Returns: + string: A string representing the submission_message + """ + + return self.__submission_message + + def set_submission_message(self, submission_message): + """ + The method to set the value to submission_message + + Parameters: + submission_message (string) : A string representing the submission_message + """ + + if submission_message is not None and not isinstance(submission_message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: submission_message EXPECTED TYPE: str', None, None) + + self.__submission_message = submission_message + self.__key_modified['submission_message'] = 1 + + def get_submission_redirect_url(self): + """ + The method to get the submission_redirect_url + + Returns: + string: A string representing the submission_redirect_url + """ + + return self.__submission_redirect_url + + def set_submission_redirect_url(self, submission_redirect_url): + """ + The method to set the value to submission_redirect_url + + Parameters: + submission_redirect_url (string) : A string representing the submission_redirect_url + """ + + if submission_redirect_url is not None and not isinstance(submission_redirect_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: submission_redirect_url EXPECTED TYPE: str', None, None) + + self.__submission_redirect_url = submission_redirect_url + self.__key_modified['submission_redirect_url'] = 1 + + def get_location_url_type(self): + """ + The method to get the location_url_type + + Returns: + string: A string representing the location_url_type + """ + + return self.__location_url_type + + def set_location_url_type(self, location_url_type): + """ + The method to set the value to location_url_type + + Parameters: + location_url_type (string) : A string representing the location_url_type + """ + + if location_url_type is not None and not isinstance(location_url_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: location_url_type EXPECTED TYPE: str', None, None) + + self.__location_url_type = location_url_type + self.__key_modified['location_url_type'] = 1 + + def get_action_on_unsubscribe(self): + """ + The method to get the action_on_unsubscribe + + Returns: + string: A string representing the action_on_unsubscribe + """ + + return self.__action_on_unsubscribe + + def set_action_on_unsubscribe(self, action_on_unsubscribe): + """ + The method to set the value to action_on_unsubscribe + + Parameters: + action_on_unsubscribe (string) : A string representing the action_on_unsubscribe + """ + + if action_on_unsubscribe is not None and not isinstance(action_on_unsubscribe, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_on_unsubscribe EXPECTED TYPE: str', None, None) + + self.__action_on_unsubscribe = action_on_unsubscribe + self.__key_modified['action_on_unsubscribe'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_landing_url(self): + """ + The method to get the landing_url + + Returns: + string: A string representing the landing_url + """ + + return self.__landing_url + + def set_landing_url(self, landing_url): + """ + The method to set the value to landing_url + + Parameters: + landing_url (string) : A string representing the landing_url + """ + + if landing_url is not None and not isinstance(landing_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: landing_url EXPECTED TYPE: str', None, None) + + self.__landing_url = landing_url + self.__key_modified['landing_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links_operations.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links_operations.py new file mode 100644 index 0000000..106ec75 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/unsubscribe_links_operations.py @@ -0,0 +1,233 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class UnsubscribeLinksOperations(object): + def __init__(self): + """Creates an instance of UnsubscribeLinksOperations""" + pass + + def get_unsubscribe_links(self): + """ + The method to get unsubscribe links + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/unsubscribe_links' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_unsubscribe_link(self, request): + """ + The method to create unsubscribe link + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/unsubscribe_links' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_unsubscribe_links(self, request): + """ + The method to update unsubscribe links + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/unsubscribe_links' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_unsubscribe_link(self, id): + """ + The method to get unsubscribe link + + 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/v7/settings/unsubscribe_links/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_unsubscribe_link(self, id, request): + """ + The method to update unsubscribe link + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/settings/unsubscribe_links/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_unsubscribe_link(self, id): + """ + The method to delete unsubscribe link + + 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/v7/settings/unsubscribe_links/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_associated_unsubscribe_links(self): + """ + The method to get associated unsubscribe links + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/unsubscribe_link/actions/associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.associations_response_handler import AssociationsResponseHandler + except Exception: + from .associations_response_handler import AssociationsResponseHandler + return handler_instance.api_call(AssociationsResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/user.py b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/user.py new file mode 100644 index 0000000..65fd721 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/unsubscribe_links/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/__init__.py new file mode 100644 index 0000000..a89efed --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/__init__.py @@ -0,0 +1,38 @@ +from .un_assigned_action_response import UnAssignedActionResponse +from .get_assign_body_wrapper import GetAssignBodyWrapper +from .association_wrapper import AssociationWrapper +from .sources import Sources +from .sources_wrapper import SourcesWrapper +from .criteria import Criteria +from .get_unassign_body_wrapper import GetUnassignBodyWrapper +from .associated_user_count import AssociatedUserCount +from .source import Source +from .association_module import AssociationModule +from .api_exception import APIException +from .sources_count import SourcesCount +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .jobs_wrapper import JobsWrapper +from .sources_count_wrapper import SourcesCountWrapper +from .un_assigned_action_wrapper import UnAssignedActionWrapper +from .action_handler import ActionHandler +from .assigned_action_wrapper import AssignedActionWrapper +from .info import Info +from .action_wrapper import ActionWrapper +from .owner import Owner +from .user_group import UserGroup +from .resource import Resource +from .jobs import Jobs +from .grouped_count import GroupedCount +from .groups import Groups +from .body_wrapper import BodyWrapper +from .users import Users +from .association_response import AssociationResponse +from .field import Field +from .grouped_count_wrapper import GroupedCountWrapper +from .response_wrapper import ResponseWrapper +from .assigned_action_response import AssignedActionResponse +from .associated_user import AssociatedUser +from .user_groups_operations import UserGroupsOperations, GetGroupsParam, GetSourcesParam, GetGroupedCountsParam +from .assign import Assign diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_wrapper.py new file mode 100644 index 0000000..5361a5c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__user_groups = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/api_exception.py new file mode 100644 index 0000000..8e6645f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.un_assigned_action_response import UnAssignedActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assigned_action_response import AssignedActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .un_assigned_action_response import UnAssignedActionResponse + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + from .assigned_action_response import AssignedActionResponse + + +class APIException(ActionResponse, AssignedActionResponse, UnAssignedActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/assign.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/assign.py new file mode 100644 index 0000000..282dc18 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/assign.py @@ -0,0 +1,204 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Assign(object): + def __init__(self): + """Creates an instance of Assign""" + + self.__feature = None + self.__related_entity_id = None + self.__page = None + self.__per_page = None + self.__id = None + self.__filters = None + self.__key_modified = dict() + + def get_feature(self): + """ + The method to get the feature + + Returns: + Choice: An instance of Choice + """ + + return self.__feature + + def set_feature(self, feature): + """ + The method to set the value to feature + + Parameters: + feature (Choice) : An instance of Choice + """ + + if feature is not None and not isinstance(feature, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feature EXPECTED TYPE: Choice', None, None) + + self.__feature = feature + self.__key_modified['feature'] = 1 + + def get_related_entity_id(self): + """ + The method to get the related_entity_id + + Returns: + int: An int representing the related_entity_id + """ + + return self.__related_entity_id + + def set_related_entity_id(self, related_entity_id): + """ + The method to set the value to related_entity_id + + Parameters: + related_entity_id (int) : An int representing the related_entity_id + """ + + if related_entity_id is not None and not isinstance(related_entity_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: related_entity_id EXPECTED TYPE: int', None, None) + + self.__related_entity_id = related_entity_id + self.__key_modified['related_entity_id'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_filters(self): + """ + The method to get the filters + + Returns: + Criteria: An instance of Criteria + """ + + return self.__filters + + def set_filters(self, filters): + """ + The method to set the value to filters + + Parameters: + filters (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.criteria import Criteria + except Exception: + from .criteria import Criteria + + if filters is not None and not isinstance(filters, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: filters EXPECTED TYPE: Criteria', None, None) + + self.__filters = filters + self.__key_modified['filters'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_response.py new file mode 100644 index 0000000..5a878cc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class AssignedActionResponse(ABC): + def __init__(self): + """Creates an instance of AssignedActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_wrapper.py new file mode 100644 index 0000000..72ddc3e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/assigned_action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignedActionWrapper(object): + def __init__(self): + """Creates an instance of AssignedActionWrapper""" + + self.__get_assigned = None + self.__key_modified = dict() + + def get_get_assigned(self): + """ + The method to get the get_assigned + + Returns: + AssignedActionResponse: An instance of AssignedActionResponse + """ + + return self.__get_assigned + + def set_get_assigned(self, get_assigned): + """ + The method to set the value to get_assigned + + Parameters: + get_assigned (AssignedActionResponse) : An instance of AssignedActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assigned_action_response import AssignedActionResponse + except Exception: + from .assigned_action_response import AssignedActionResponse + + if get_assigned is not None and not isinstance(get_assigned, AssignedActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_assigned EXPECTED TYPE: AssignedActionResponse', None, None) + + self.__get_assigned = get_assigned + self.__key_modified['get_assigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user.py new file mode 100644 index 0000000..fab62e4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedUser(object): + def __init__(self): + """Creates an instance of AssociatedUser""" + + self.__user_group = None + self.__count = None + self.__key_modified = dict() + + def get_user_group(self): + """ + The method to get the user_group + + Returns: + UserGroup: An instance of UserGroup + """ + + return self.__user_group + + def set_user_group(self, user_group): + """ + The method to set the value to user_group + + Parameters: + user_group (UserGroup) : An instance of UserGroup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.user_group import UserGroup + except Exception: + from .user_group import UserGroup + + if user_group is not None and not isinstance(user_group, UserGroup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_group EXPECTED TYPE: UserGroup', None, None) + + self.__user_group = user_group + self.__key_modified['user_group'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user_count.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user_count.py new file mode 100644 index 0000000..06f7a7f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/associated_user_count.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociatedUserCount(ResponseHandler): + def __init__(self): + """Creates an instance of AssociatedUserCount""" + super().__init__() + + self.__associated_users_count = None + self.__info = None + self.__key_modified = dict() + + def get_associated_users_count(self): + """ + The method to get the associated_users_count + + Returns: + list: An instance of list + """ + + return self.__associated_users_count + + def set_associated_users_count(self, associated_users_count): + """ + The method to set the value to associated_users_count + + Parameters: + associated_users_count (list) : An instance of list + """ + + if associated_users_count is not None and not isinstance(associated_users_count, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associated_users_count EXPECTED TYPE: list', None, None) + + self.__associated_users_count = associated_users_count + self.__key_modified['associated_users_count'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_module.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_module.py new file mode 100644 index 0000000..687e8ee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_module.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationModule(object): + def __init__(self): + """Creates an instance of AssociationModule""" + + self.__module = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + MinifiedModule: An instance of MinifiedModule + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (MinifiedModule) : An instance of MinifiedModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import MinifiedModule + except Exception: + from ..modules import MinifiedModule + + if module is not None and not isinstance(module, MinifiedModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: MinifiedModule', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_response.py new file mode 100644 index 0000000..82d8373 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_response.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociationResponse(object): + def __init__(self): + """Creates an instance of AssociationResponse""" + + self.__type = None + self.__resource = None + self.__detail = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + Resource: An instance of Resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Resource) : An instance of Resource + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.resource import Resource + except Exception: + from .resource import Resource + + if resource is not None and not isinstance(resource, Resource): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Resource', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_detail(self): + """ + The method to get the detail + + Returns: + AssociationModule: An instance of AssociationModule + """ + + return self.__detail + + def set_detail(self, detail): + """ + The method to set the value to detail + + Parameters: + detail (AssociationModule) : An instance of AssociationModule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.association_module import AssociationModule + except Exception: + from .association_module import AssociationModule + + if detail is not None and not isinstance(detail, AssociationModule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: detail EXPECTED TYPE: AssociationModule', None, None) + + self.__detail = detail + self.__key_modified['detail'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_wrapper.py new file mode 100644 index 0000000..d1c10b3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/association_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociationWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of AssociationWrapper""" + super().__init__() + + self.__associations = None + self.__key_modified = dict() + + def get_associations(self): + """ + The method to get the associations + + Returns: + list: An instance of list + """ + + return self.__associations + + def set_associations(self, associations): + """ + The method to set the value to associations + + Parameters: + associations (list) : An instance of list + """ + + if associations is not None and not isinstance(associations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: associations EXPECTED TYPE: list', None, None) + + self.__associations = associations + self.__key_modified['associations'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/body_wrapper.py new file mode 100644 index 0000000..eb064c5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__user_groups = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/criteria.py new file mode 100644 index 0000000..0c70771 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__group_operator = None + self.__group = None + self.__value = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + Choice: An instance of Choice + """ + + return self.__group_operator + + 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 get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/field.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/field.py new file mode 100644 index 0000000..4fee76b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_assign_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_assign_body_wrapper.py new file mode 100644 index 0000000..260f606 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_assign_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class GetAssignBodyWrapper(object): + def __init__(self): + """Creates an instance of GetAssignBodyWrapper""" + + self.__get_assigned = None + self.__key_modified = dict() + + def get_get_assigned(self): + """ + The method to get the get_assigned + + Returns: + Assign: An instance of Assign + """ + + return self.__get_assigned + + def set_get_assigned(self, get_assigned): + """ + The method to set the value to get_assigned + + Parameters: + get_assigned (Assign) : An instance of Assign + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assign import Assign + except Exception: + from .assign import Assign + + if get_assigned is not None and not isinstance(get_assigned, Assign): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_assigned EXPECTED TYPE: Assign', None, None) + + self.__get_assigned = get_assigned + self.__key_modified['get_assigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_unassign_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_unassign_body_wrapper.py new file mode 100644 index 0000000..5f1ec93 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/get_unassign_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class GetUnassignBodyWrapper(object): + def __init__(self): + """Creates an instance of GetUnassignBodyWrapper""" + + self.__get_unassigned = None + self.__key_modified = dict() + + def get_get_unassigned(self): + """ + The method to get the get_unassigned + + Returns: + Assign: An instance of Assign + """ + + return self.__get_unassigned + + def set_get_unassigned(self, get_unassigned): + """ + The method to set the value to get_unassigned + + Parameters: + get_unassigned (Assign) : An instance of Assign + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.assign import Assign + except Exception: + from .assign import Assign + + if get_unassigned is not None and not isinstance(get_unassigned, Assign): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_unassigned EXPECTED TYPE: Assign', None, None) + + self.__get_unassigned = get_unassigned + self.__key_modified['get_unassigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count.py new file mode 100644 index 0000000..db3a96d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class GroupedCount(object): + def __init__(self): + """Creates an instance of GroupedCount""" + + self.__status = None + self.__count = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count_wrapper.py new file mode 100644 index 0000000..78c1834 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/grouped_count_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class GroupedCountWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of GroupedCountWrapper""" + super().__init__() + + self.__grouped_counts = None + self.__info = None + self.__key_modified = dict() + + def get_grouped_counts(self): + """ + The method to get the grouped_counts + + Returns: + list: An instance of list + """ + + return self.__grouped_counts + + def set_grouped_counts(self, grouped_counts): + """ + The method to set the value to grouped_counts + + Parameters: + grouped_counts (list) : An instance of list + """ + + if grouped_counts is not None and not isinstance(grouped_counts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: grouped_counts EXPECTED TYPE: list', None, None) + + self.__grouped_counts = grouped_counts + self.__key_modified['grouped_counts'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/groups.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/groups.py new file mode 100644 index 0000000..5662b2b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/groups.py @@ -0,0 +1,293 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Groups(object): + def __init__(self): + """Creates an instance of Groups""" + + self.__created_by = None + self.__modified_by = None + self.__modified_time = None + self.__created_time = None + self.__description = None + self.__id = None + self.__name = None + self.__sources_count = None + self.__sources = None + self.__key_modified = dict() + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + Owner: An instance of Owner + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.owner import Owner + except Exception: + from .owner import Owner + + if created_by is not None and not isinstance(created_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: Owner', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + Owner: An instance of Owner + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.owner import Owner + except Exception: + from .owner import Owner + + if modified_by is not None and not isinstance(modified_by, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: Owner', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_sources_count(self): + """ + The method to get the sources_count + + Returns: + SourcesCount: An instance of SourcesCount + """ + + return self.__sources_count + + def set_sources_count(self, sources_count): + """ + The method to set the value to sources_count + + Parameters: + sources_count (SourcesCount) : An instance of SourcesCount + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.sources_count import SourcesCount + except Exception: + from .sources_count import SourcesCount + + if sources_count is not None and not isinstance(sources_count, SourcesCount): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources_count EXPECTED TYPE: SourcesCount', None, None) + + self.__sources_count = sources_count + self.__key_modified['sources_count'] = 1 + + def get_sources(self): + """ + The method to get the sources + + Returns: + list: An instance of list + """ + + return self.__sources + + def set_sources(self, sources): + """ + The method to set the value to sources + + Parameters: + sources (list) : An instance of list + """ + + if sources is not None and not isinstance(sources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources EXPECTED TYPE: list', None, None) + + self.__sources = sources + self.__key_modified['sources'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/info.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs.py new file mode 100644 index 0000000..a00bcb6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Jobs(object): + def __init__(self): + """Creates an instance of Jobs""" + + self.__status = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['Status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs_wrapper.py new file mode 100644 index 0000000..929408f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/jobs_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class JobsWrapper(object): + def __init__(self): + """Creates an instance of JobsWrapper""" + + self.__deletion_jobs = None + self.__key_modified = dict() + + def get_deletion_jobs(self): + """ + The method to get the deletion_jobs + + Returns: + list: An instance of list + """ + + return self.__deletion_jobs + + def set_deletion_jobs(self, deletion_jobs): + """ + The method to set the value to deletion_jobs + + Parameters: + deletion_jobs (list) : An instance of list + """ + + if deletion_jobs is not None and not isinstance(deletion_jobs, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deletion_jobs EXPECTED TYPE: list', None, None) + + self.__deletion_jobs = deletion_jobs + self.__key_modified['deletion_jobs'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/owner.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/resource.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/resource.py new file mode 100644 index 0000000..ae2a6ea --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_wrapper.py new file mode 100644 index 0000000..a8935af --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__user_groups = None + self.__info = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/source.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/source.py new file mode 100644 index 0000000..bb1b4b7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/source.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Source(object): + def __init__(self): + """Creates an instance of Source""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources.py new file mode 100644 index 0000000..06aa2eb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Sources(object): + def __init__(self): + """Creates an instance of Sources""" + + self.__type = None + self.__source = None + self.__subordinates = None + self.__sub_territories = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + Source: An instance of Source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (Source) : An instance of Source + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.source import Source + except Exception: + from .source import Source + + if source is not None and not isinstance(source, Source): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: Source', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_subordinates(self): + """ + The method to get the subordinates + + Returns: + bool: A bool representing the subordinates + """ + + return self.__subordinates + + def set_subordinates(self, subordinates): + """ + The method to set the value to subordinates + + Parameters: + subordinates (bool) : A bool representing the subordinates + """ + + if subordinates is not None and not isinstance(subordinates, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: subordinates EXPECTED TYPE: bool', None, None) + + self.__subordinates = subordinates + self.__key_modified['subordinates'] = 1 + + def get_sub_territories(self): + """ + The method to get the sub_territories + + Returns: + bool: A bool representing the sub_territories + """ + + return self.__sub_territories + + def set_sub_territories(self, sub_territories): + """ + The method to set the value to sub_territories + + Parameters: + sub_territories (bool) : A bool representing the sub_territories + """ + + if sub_territories is not None and not isinstance(sub_territories, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sub_territories EXPECTED TYPE: bool', None, None) + + self.__sub_territories = sub_territories + self.__key_modified['sub_territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count.py new file mode 100644 index 0000000..af627b5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SourcesCount(object): + def __init__(self): + """Creates an instance of SourcesCount""" + + self.__territories = None + self.__roles = None + self.__groups = None + self.__users = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + int: An int representing the territories + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (int) : An int representing the territories + """ + + if territories is not None and not isinstance(territories, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: int', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_roles(self): + """ + The method to get the roles + + Returns: + int: An int representing the roles + """ + + return self.__roles + + def set_roles(self, roles): + """ + The method to set the value to roles + + Parameters: + roles (int) : An int representing the roles + """ + + if roles is not None and not isinstance(roles, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: roles EXPECTED TYPE: int', None, None) + + self.__roles = roles + self.__key_modified['roles'] = 1 + + def get_groups(self): + """ + The method to get the groups + + Returns: + int: An int representing the groups + """ + + return self.__groups + + def set_groups(self, groups): + """ + The method to set the value to groups + + Parameters: + groups (int) : An int representing the groups + """ + + if groups is not None and not isinstance(groups, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: groups EXPECTED TYPE: int', None, None) + + self.__groups = groups + self.__key_modified['groups'] = 1 + + def get_users(self): + """ + The method to get the users + + Returns: + Users: An instance of Users + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (Users) : An instance of Users + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.users import Users + except Exception: + from .users import Users + + if users is not None and not isinstance(users, Users): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: Users', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count_wrapper.py new file mode 100644 index 0000000..0637c02 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_count_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class SourcesCountWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of SourcesCountWrapper""" + super().__init__() + + self.__sources_count = None + self.__key_modified = dict() + + def get_sources_count(self): + """ + The method to get the sources_count + + Returns: + list: An instance of list + """ + + return self.__sources_count + + def set_sources_count(self, sources_count): + """ + The method to set the value to sources_count + + Parameters: + sources_count (list) : An instance of list + """ + + if sources_count is not None and not isinstance(sources_count, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources_count EXPECTED TYPE: list', None, None) + + self.__sources_count = sources_count + self.__key_modified['sources_count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_wrapper.py new file mode 100644 index 0000000..64dfedf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/sources_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class SourcesWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of SourcesWrapper""" + super().__init__() + + self.__sources = None + self.__info = None + self.__key_modified = dict() + + def get_sources(self): + """ + The method to get the sources + + Returns: + list: An instance of list + """ + + return self.__sources + + def set_sources(self, sources): + """ + The method to set the value to sources + + Parameters: + sources (list) : An instance of list + """ + + if sources is not None and not isinstance(sources, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sources EXPECTED TYPE: list', None, None) + + self.__sources = sources + self.__key_modified['sources'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/success_response.py new file mode 100644 index 0000000..a68bbc8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_response.py new file mode 100644 index 0000000..93ba015 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class UnAssignedActionResponse(ABC): + def __init__(self): + """Creates an instance of UnAssignedActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_wrapper.py new file mode 100644 index 0000000..7419b77 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/un_assigned_action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UnAssignedActionWrapper(object): + def __init__(self): + """Creates an instance of UnAssignedActionWrapper""" + + self.__get_unassigned = None + self.__key_modified = dict() + + def get_get_unassigned(self): + """ + The method to get the get_unassigned + + Returns: + UnAssignedActionResponse: An instance of UnAssignedActionResponse + """ + + return self.__get_unassigned + + def set_get_unassigned(self, get_unassigned): + """ + The method to set the value to get_unassigned + + Parameters: + get_unassigned (UnAssignedActionResponse) : An instance of UnAssignedActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.un_assigned_action_response import UnAssignedActionResponse + except Exception: + from .un_assigned_action_response import UnAssignedActionResponse + + if get_unassigned is not None and not isinstance(get_unassigned, UnAssignedActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: get_unassigned EXPECTED TYPE: UnAssignedActionResponse', None, None) + + self.__get_unassigned = get_unassigned + self.__key_modified['get_unassigned'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_group.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_group.py new file mode 100644 index 0000000..c400cd0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_group.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UserGroup(object): + def __init__(self): + """Creates an instance of UserGroup""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_groups_operations.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_groups_operations.py new file mode 100644 index 0000000..c656c7a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/user_groups_operations.py @@ -0,0 +1,411 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UserGroupsOperations(object): + def __init__(self): + """Creates an instance of UserGroupsOperations""" + pass + + def get_groups(self, param_instance=None): + """ + The method to get groups + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/user_groups' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_groups(self, request): + """ + The method to create groups + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/user_groups' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_groups(self, request): + """ + The method to update groups + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/user_groups' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_group(self, group): + """ + The method to get group + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_group(self, group, request): + """ + The method to update group + + Parameters: + group (int) : An int representing the group + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group 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/v7/settings/user_groups/' + api_path = api_path + str(group) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_group(self, group): + """ + The method to delete group + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_sources(self, group, param_instance=None): + """ + The method to get sources + + Parameters: + group (int) : An int representing the group + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + 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/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/sources' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_sources_count(self, group): + """ + The method to get sources count + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/actions/sources_count' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associations(self, group): + """ + The method to get associations + + Parameters: + group (int) : An int representing the group + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/actions/associations' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_associated_users_count(self): + """ + The method to get associated users count + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/user_groups/actions/associated_users_count' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_grouped_counts(self, group, param_instance=None): + """ + The method to get grouped counts + + Parameters: + group (int) : An int representing the group + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(group, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: int', None, None) + + 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/v7/settings/user_groups/' + api_path = api_path + str(group) + api_path = api_path + '/associated_users/actions/grouped_counts' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetGroupsParam(object): + include = Param('include', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + name = Param('name', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + page = Param('page', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + per_page = Param('per_page', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + filters = Param('filters', 'com.zoho.crm.api.UserGroups.GetGroupsParam') + + +class GetSourcesParam(object): + type = Param('type', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + user_type = Param('user_type', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + page = Param('page', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + per_page = Param('per_page', 'com.zoho.crm.api.UserGroups.GetSourcesParam') + + +class GetGroupedCountsParam(object): + group_by = Param('group_by', 'com.zoho.crm.api.UserGroups.GetGroupedCountsParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_groups/users.py b/zohocrmsdk/src/com/zoho/crm/api/user_groups/users.py new file mode 100644 index 0000000..8ab92e6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_groups/users.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Users(object): + def __init__(self): + """Creates an instance of Users""" + + self.__inactive = None + self.__deleted = None + self.__active = None + self.__key_modified = dict() + + def get_inactive(self): + """ + The method to get the inactive + + Returns: + int: An int representing the inactive + """ + + return self.__inactive + + def set_inactive(self, inactive): + """ + The method to set the value to inactive + + Parameters: + inactive (int) : An int representing the inactive + """ + + if inactive is not None and not isinstance(inactive, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: inactive EXPECTED TYPE: int', None, None) + + self.__inactive = inactive + self.__key_modified['inactive'] = 1 + + def get_deleted(self): + """ + The method to get the deleted + + Returns: + int: An int representing the deleted + """ + + return self.__deleted + + def set_deleted(self, deleted): + """ + The method to set the value to deleted + + Parameters: + deleted (int) : An int representing the deleted + """ + + if deleted is not None and not isinstance(deleted, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: deleted EXPECTED TYPE: int', None, None) + + self.__deleted = deleted + self.__key_modified['deleted'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + int: An int representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (int) : An int representing the active + """ + + if active is not None and not isinstance(active, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: int', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_signature.py b/zohocrmsdk/src/com/zoho/crm/api/user_signature.py new file mode 100755 index 0000000..726bdec --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_signature.py @@ -0,0 +1,36 @@ +try: + import re + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + +except Exception: + import re + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + from .util.constants import Constants + + +class UserSignature(object): + + """ + This class represents the Zoho CRM User. + """ + + def __init__(self, name): + + """ + Creates an UserSignature class instance with the specified user email. + + Parameters: + email (str) : A string containing the CRM user email + """ + self.__name = name + + def get_name(self): + """ + This is a getter method to get __name. + + Returns: + string: A string representing __name + """ + + return self.__name diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/__init__.py new file mode 100644 index 0000000..95cee17 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/__init__.py @@ -0,0 +1,14 @@ +from .status_action_response import StatusActionResponse +from .action_wrapper import ActionWrapper +from .status_action_wrapper import StatusActionWrapper +from .status_action_handler import StatusActionHandler +from .body_wrapper import BodyWrapper +from .users import Users +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .user_type_users_operations import UserTypeUsersOperations, GetUsersOfUserTypeParam, DeleteUserFromThePortalParam, TransferUsersOfAUserTypeParam, ChangeUsersStatusParam +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_wrapper.py new file mode 100644 index 0000000..0b97467 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/api_exception.py new file mode 100644 index 0000000..a880afd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_response import StatusActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_handler import StatusActionHandler + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .status_action_handler import StatusActionHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse, StatusActionHandler, StatusActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/body_wrapper.py new file mode 100644 index 0000000..9160577 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/info.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/info.py new file mode 100644 index 0000000..69c3623 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/info.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__total_count = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_total_count(self): + """ + The method to get the total_count + + Returns: + int: An int representing the total_count + """ + + return self.__total_count + + def set_total_count(self, total_count): + """ + The method to set the value to total_count + + Parameters: + total_count (int) : An int representing the total_count + """ + + if total_count is not None and not isinstance(total_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: total_count EXPECTED TYPE: int', None, None) + + self.__total_count = total_count + self.__key_modified['total_count'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_wrapper.py new file mode 100644 index 0000000..524a23b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users = None + self.__info = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_handler.py new file mode 100644 index 0000000..e42d843 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusActionHandler(ABC): + def __init__(self): + """Creates an instance of StatusActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_response.py new file mode 100644 index 0000000..ff1c58b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class StatusActionResponse(ABC): + def __init__(self): + """Creates an instance of StatusActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_wrapper.py new file mode 100644 index 0000000..bdbc4e5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/status_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_handler import StatusActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .status_action_handler import StatusActionHandler + + +class StatusActionWrapper(StatusActionHandler): + def __init__(self): + """Creates an instance of StatusActionWrapper""" + super().__init__() + + self.__change_status = None + self.__key_modified = dict() + + def get_change_status(self): + """ + The method to get the change_status + + Returns: + list: An instance of list + """ + + return self.__change_status + + def set_change_status(self, change_status): + """ + The method to set the value to change_status + + Parameters: + change_status (list) : An instance of list + """ + + if change_status is not None and not isinstance(change_status, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: change_status EXPECTED TYPE: list', None, None) + + self.__change_status = change_status + self.__key_modified['change_status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/success_response.py new file mode 100644 index 0000000..181018e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_response import StatusActionResponse + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .status_action_response import StatusActionResponse + from .action_response import ActionResponse + + +class SuccessResponse(StatusActionResponse, ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/user_type_users_operations.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/user_type_users_operations.py new file mode 100644 index 0000000..8b04090 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/user_type_users_operations.py @@ -0,0 +1,211 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UserTypeUsersOperations(object): + def __init__(self, user_type_id, portal_name): + """ + Creates an instance of UserTypeUsersOperations with the given parameters + + Parameters: + user_type_id (int) : An int representing the user_type_id + portal_name (string) : A string representing the portal_name + """ + + if not isinstance(user_type_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type_id EXPECTED TYPE: int', None, None) + + if not isinstance(portal_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_name EXPECTED TYPE: str', None, None) + + self.__user_type_id = user_type_id + self.__portal_name = portal_name + + + def get_users_of_user_type(self, param_instance=None): + """ + The method to get users of user type + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_user_from_the_portal(self, param_instance=None): + """ + The method to delete user from the portal + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def transfer_users_of_a_user_type(self, param_instance=None): + """ + The method to transfer users of a user type + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users/action/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_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def change_users_status(self, user_id, param_instance=None): + """ + The method to change users status + + Parameters: + user_id (int) : An int representing the user_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(user_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_id EXPECTED TYPE: int', None, None) + + 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/v7/settings/portals/' + api_path = api_path + str(self.__portal_name) + api_path = api_path + '/user_type/' + api_path = api_path + str(self.__user_type_id) + api_path = api_path + '/users/' + api_path = api_path + str(user_id) + api_path = api_path + '/actions/change_status' + 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_mandatory_checker(True) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.user_type_users.status_action_handler import StatusActionHandler + except Exception: + from .status_action_handler import StatusActionHandler + return handler_instance.api_call(StatusActionHandler.__module__, 'application/json') + + +class GetUsersOfUserTypeParam(object): + filter = Param('filter', 'com.zoho.crm.api.UserTypeUsers.GetUsersOfUserTypeParam') + type = Param('type', 'com.zoho.crm.api.UserTypeUsers.GetUsersOfUserTypeParam') + + +class DeleteUserFromThePortalParam(object): + personality_ids = Param('personality_ids', 'com.zoho.crm.api.UserTypeUsers.DeleteUserFromThePortalParam') + + +class TransferUsersOfAUserTypeParam(object): + personality_ids = Param('personality_ids', 'com.zoho.crm.api.UserTypeUsers.TransferUsersOfAUserTypeParam') + transfer_to = Param('transfer_To', 'com.zoho.crm.api.UserTypeUsers.TransferUsersOfAUserTypeParam') + + +class ChangeUsersStatusParam(object): + active = Param('active', 'com.zoho.crm.api.UserTypeUsers.ChangeUsersStatusParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/user_type_users/users.py b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/users.py new file mode 100644 index 0000000..6a55577 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/user_type_users/users.py @@ -0,0 +1,251 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Users(object): + def __init__(self): + """Creates an instance of Users""" + + self.__personality_id = None + self.__confirm = None + self.__status_reason__s = None + self.__invited_time = None + self.__module = None + self.__name = None + self.__active = None + self.__email = None + self.__key_modified = dict() + + def get_personality_id(self): + """ + The method to get the personality_id + + Returns: + int: An int representing the personality_id + """ + + return self.__personality_id + + def set_personality_id(self, personality_id): + """ + The method to set the value to personality_id + + Parameters: + personality_id (int) : An int representing the personality_id + """ + + if personality_id is not None and not isinstance(personality_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: personality_id EXPECTED TYPE: int', None, None) + + self.__personality_id = personality_id + self.__key_modified['personality_id'] = 1 + + def get_confirm(self): + """ + The method to get the confirm + + Returns: + bool: A bool representing the confirm + """ + + return self.__confirm + + def set_confirm(self, confirm): + """ + The method to set the value to confirm + + Parameters: + confirm (bool) : A bool representing the confirm + """ + + if confirm is not None and not isinstance(confirm, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: confirm EXPECTED TYPE: bool', None, None) + + self.__confirm = confirm + self.__key_modified['confirm'] = 1 + + def get_status_reason__s(self): + """ + The method to get the status_reason__s + + Returns: + string: A string representing the status_reason__s + """ + + return self.__status_reason__s + + def set_status_reason__s(self, status_reason__s): + """ + The method to set the value to status_reason__s + + Parameters: + status_reason__s (string) : A string representing the status_reason__s + """ + + if status_reason__s is not None and not isinstance(status_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status_reason__s EXPECTED TYPE: str', None, None) + + self.__status_reason__s = status_reason__s + self.__key_modified['status_reason__s'] = 1 + + def get_invited_time(self): + """ + The method to get the invited_time + + Returns: + datetime: An instance of datetime + """ + + return self.__invited_time + + def set_invited_time(self, invited_time): + """ + The method to set the value to invited_time + + Parameters: + invited_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if invited_time is not None and not isinstance(invited_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: invited_time EXPECTED TYPE: datetime', None, None) + + self.__invited_time = invited_time + self.__key_modified['invited_time'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + string: A string representing the module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/users/__init__.py new file mode 100644 index 0000000..c92a57a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/__init__.py @@ -0,0 +1,23 @@ +from .owner import Owner +from .action_wrapper import ActionWrapper +from .users_operations import UsersOperations, GetUsersParam, GetUsersHeader, GetUserHeader, GetAssociatedGroupsParam, UsersCountParam +from .customize_info import CustomizeInfo +from .role import Role +from .associated_group import AssociatedGroup +from .minified_user import MinifiedUser +from .profile import Profile +from .shift import Shift +from .associated_groups_wrapper import AssociatedGroupsWrapper +from .body_wrapper import BodyWrapper +from .users import Users +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .count_wrapper import CountWrapper +from .tab import Tab +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .count_handler import CountHandler +from .action_handler import ActionHandler +from .theme import Theme +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/users/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users/action_wrapper.py new file mode 100644 index 0000000..514fe13 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.territory_users import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from ..territory_users import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/users/api_exception.py new file mode 100644 index 0000000..3831d9d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/api_exception.py @@ -0,0 +1,158 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users.count_handler import CountHandler + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .count_handler import CountHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler, CountHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/associated_group.py b/zohocrmsdk/src/com/zoho/crm/api/users/associated_group.py new file mode 100644 index 0000000..0c9822c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/associated_group.py @@ -0,0 +1,238 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssociatedGroup(object): + def __init__(self): + """Creates an instance of AssociatedGroup""" + + self.__id = None + self.__name = None + self.__description = None + self.__created_time = None + self.__modified_time = None + self.__created_by = None + self.__modified_by = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/associated_groups_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users/associated_groups_wrapper.py new file mode 100644 index 0000000..74065ff --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/associated_groups_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class AssociatedGroupsWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of AssociatedGroupsWrapper""" + super().__init__() + + self.__user_groups = None + self.__info = None + self.__key_modified = dict() + + def get_user_groups(self): + """ + The method to get the user_groups + + Returns: + list: An instance of list + """ + + return self.__user_groups + + def set_user_groups(self, user_groups): + """ + The method to set the value to user_groups + + Parameters: + user_groups (list) : An instance of list + """ + + if user_groups is not None and not isinstance(user_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_groups EXPECTED TYPE: list', None, None) + + self.__user_groups = user_groups + self.__key_modified['user_groups'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users/body_wrapper.py new file mode 100644 index 0000000..9160577 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/count_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users/count_handler.py new file mode 100644 index 0000000..6c4eb60 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/count_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class CountHandler(ABC): + def __init__(self): + """Creates an instance of CountHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/count_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users/count_wrapper.py new file mode 100644 index 0000000..d34cbe0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/count_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users.count_handler import CountHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .count_handler import CountHandler + + +class CountWrapper(CountHandler): + def __init__(self): + """Creates an instance of CountWrapper""" + super().__init__() + + self.__count = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/customize_info.py b/zohocrmsdk/src/com/zoho/crm/api/users/customize_info.py new file mode 100644 index 0000000..e309911 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/customize_info.py @@ -0,0 +1,187 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CustomizeInfo(object): + def __init__(self): + """Creates an instance of CustomizeInfo""" + + self.__notes_desc = None + self.__show_right_panel = None + self.__bc_view = None + self.__unpin_recent_item = None + self.__show_home = None + self.__show_detail_view = None + self.__key_modified = dict() + + def get_notes_desc(self): + """ + The method to get the notes_desc + + Returns: + Object: A Object representing the notes_desc + """ + + return self.__notes_desc + + def set_notes_desc(self, notes_desc): + """ + The method to set the value to notes_desc + + Parameters: + notes_desc (Object) : A Object representing the notes_desc + """ + + self.__notes_desc = notes_desc + self.__key_modified['notes_desc'] = 1 + + def get_show_right_panel(self): + """ + The method to get the show_right_panel + + Returns: + Object: A Object representing the show_right_panel + """ + + return self.__show_right_panel + + def set_show_right_panel(self, show_right_panel): + """ + The method to set the value to show_right_panel + + Parameters: + show_right_panel (Object) : A Object representing the show_right_panel + """ + + self.__show_right_panel = show_right_panel + self.__key_modified['show_right_panel'] = 1 + + def get_bc_view(self): + """ + The method to get the bc_view + + Returns: + Object: A Object representing the bc_view + """ + + return self.__bc_view + + def set_bc_view(self, bc_view): + """ + The method to set the value to bc_view + + Parameters: + bc_view (Object) : A Object representing the bc_view + """ + + self.__bc_view = bc_view + self.__key_modified['bc_view'] = 1 + + def get_unpin_recent_item(self): + """ + The method to get the unpin_recent_item + + Returns: + Object: A Object representing the unpin_recent_item + """ + + return self.__unpin_recent_item + + def set_unpin_recent_item(self, unpin_recent_item): + """ + The method to set the value to unpin_recent_item + + Parameters: + unpin_recent_item (Object) : A Object representing the unpin_recent_item + """ + + self.__unpin_recent_item = unpin_recent_item + self.__key_modified['unpin_recent_item'] = 1 + + def get_show_home(self): + """ + The method to get the show_home + + Returns: + bool: A bool representing the show_home + """ + + return self.__show_home + + def set_show_home(self, show_home): + """ + The method to set the value to show_home + + Parameters: + show_home (bool) : A bool representing the show_home + """ + + if show_home is not None and not isinstance(show_home, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_home EXPECTED TYPE: bool', None, None) + + self.__show_home = show_home + self.__key_modified['show_home'] = 1 + + def get_show_detail_view(self): + """ + The method to get the show_detail_view + + Returns: + bool: A bool representing the show_detail_view + """ + + return self.__show_detail_view + + def set_show_detail_view(self, show_detail_view): + """ + The method to set the value to show_detail_view + + Parameters: + show_detail_view (bool) : A bool representing the show_detail_view + """ + + if show_detail_view is not None and not isinstance(show_detail_view, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: show_detail_view EXPECTED TYPE: bool', None, None) + + self.__show_detail_view = show_detail_view + self.__key_modified['show_detail_view'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/info.py b/zohocrmsdk/src/com/zoho/crm/api/users/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/minified_user.py b/zohocrmsdk/src/com/zoho/crm/api/users/minified_user.py new file mode 100644 index 0000000..70e582a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/minified_user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedUser(object): + def __init__(self): + """Creates an instance of MinifiedUser""" + + self.__name = None + self.__id = None + self.__email = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/owner.py b/zohocrmsdk/src/com/zoho/crm/api/users/owner.py new file mode 100644 index 0000000..58dfca6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/owner.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__last_name = None + self.__first_name = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_last_name(self): + """ + The method to get the last_name + + Returns: + string: A string representing the last_name + """ + + return self.__last_name + + def set_last_name(self, last_name): + """ + The method to set the value to last_name + + Parameters: + last_name (string) : A string representing the last_name + """ + + if last_name is not None and not isinstance(last_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_name EXPECTED TYPE: str', None, None) + + self.__last_name = last_name + self.__key_modified['last_name'] = 1 + + def get_first_name(self): + """ + The method to get the first_name + + Returns: + string: A string representing the first_name + """ + + return self.__first_name + + def set_first_name(self, first_name): + """ + The method to set the value to first_name + + Parameters: + first_name (string) : A string representing the first_name + """ + + if first_name is not None and not isinstance(first_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_name EXPECTED TYPE: str', None, None) + + self.__first_name = first_name + self.__key_modified['first_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/profile.py b/zohocrmsdk/src/com/zoho/crm/api/users/profile.py new file mode 100644 index 0000000..fa877f9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/profile.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Profile(object): + def __init__(self): + """Creates an instance of Profile""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users/response_wrapper.py new file mode 100644 index 0000000..8ccfef8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users = None + self.__info = None + self.__key_modified = dict() + + def get_users(self): + """ + The method to get the users + + Returns: + list: An instance of list + """ + + return self.__users + + def set_users(self, users): + """ + The method to set the value to users + + Parameters: + users (list) : An instance of list + """ + + if users is not None and not isinstance(users, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users EXPECTED TYPE: list', None, None) + + self.__users = users + self.__key_modified['users'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/role.py b/zohocrmsdk/src/com/zoho/crm/api/users/role.py new file mode 100644 index 0000000..bba4d98 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/role.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Role(object): + def __init__(self): + """Creates an instance of Role""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/shift.py b/zohocrmsdk/src/com/zoho/crm/api/users/shift.py new file mode 100644 index 0000000..160ad67 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/shift.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Shift(object): + def __init__(self): + """Creates an instance of Shift""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/users/success_response.py new file mode 100644 index 0000000..d3f9b45 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/tab.py b/zohocrmsdk/src/com/zoho/crm/api/users/tab.py new file mode 100644 index 0000000..f9be85e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/tab.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Tab(object): + def __init__(self): + """Creates an instance of Tab""" + + self.__font_color = None + self.__background = None + self.__key_modified = dict() + + def get_font_color(self): + """ + The method to get the font_color + + Returns: + Choice: An instance of Choice + """ + + return self.__font_color + + def set_font_color(self, font_color): + """ + The method to set the value to font_color + + Parameters: + font_color (Choice) : An instance of Choice + """ + + if font_color is not None and not isinstance(font_color, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: font_color EXPECTED TYPE: Choice', None, None) + + self.__font_color = font_color + self.__key_modified['font_color'] = 1 + + def get_background(self): + """ + The method to get the background + + Returns: + Choice: An instance of Choice + """ + + return self.__background + + def set_background(self, background): + """ + The method to set the value to background + + Parameters: + background (Choice) : An instance of Choice + """ + + if background is not None and not isinstance(background, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: background EXPECTED TYPE: Choice', None, None) + + self.__background = background + self.__key_modified['background'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/theme.py b/zohocrmsdk/src/com/zoho/crm/api/users/theme.py new file mode 100644 index 0000000..b123ef6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/theme.py @@ -0,0 +1,209 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Theme(object): + def __init__(self): + """Creates an instance of Theme""" + + self.__normal_tab = None + self.__selected_tab = None + self.__new_background = None + self.__background = None + self.__screen = None + self.__type = None + self.__key_modified = dict() + + def get_normal_tab(self): + """ + The method to get the normal_tab + + Returns: + Tab: An instance of Tab + """ + + return self.__normal_tab + + def set_normal_tab(self, normal_tab): + """ + The method to set the value to normal_tab + + Parameters: + normal_tab (Tab) : An instance of Tab + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.tab import Tab + except Exception: + from .tab import Tab + + if normal_tab is not None and not isinstance(normal_tab, Tab): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: normal_tab EXPECTED TYPE: Tab', None, None) + + self.__normal_tab = normal_tab + self.__key_modified['normal_tab'] = 1 + + def get_selected_tab(self): + """ + The method to get the selected_tab + + Returns: + Tab: An instance of Tab + """ + + return self.__selected_tab + + def set_selected_tab(self, selected_tab): + """ + The method to set the value to selected_tab + + Parameters: + selected_tab (Tab) : An instance of Tab + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.tab import Tab + except Exception: + from .tab import Tab + + if selected_tab is not None and not isinstance(selected_tab, Tab): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: selected_tab EXPECTED TYPE: Tab', None, None) + + self.__selected_tab = selected_tab + self.__key_modified['selected_tab'] = 1 + + def get_new_background(self): + """ + The method to get the new_background + + Returns: + string: A string representing the new_background + """ + + return self.__new_background + + def set_new_background(self, new_background): + """ + The method to set the value to new_background + + Parameters: + new_background (string) : A string representing the new_background + """ + + if new_background is not None and not isinstance(new_background, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: new_background EXPECTED TYPE: str', None, None) + + self.__new_background = new_background + self.__key_modified['new_background'] = 1 + + def get_background(self): + """ + The method to get the background + + Returns: + Choice: An instance of Choice + """ + + return self.__background + + def set_background(self, background): + """ + The method to set the value to background + + Parameters: + background (Choice) : An instance of Choice + """ + + if background is not None and not isinstance(background, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: background EXPECTED TYPE: Choice', None, None) + + self.__background = background + self.__key_modified['background'] = 1 + + def get_screen(self): + """ + The method to get the screen + + Returns: + Choice: An instance of Choice + """ + + return self.__screen + + def set_screen(self, screen): + """ + The method to set the value to screen + + Parameters: + screen (Choice) : An instance of Choice + """ + + if screen is not None and not isinstance(screen, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screen EXPECTED TYPE: Choice', None, None) + + self.__screen = screen + self.__key_modified['screen'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/users.py b/zohocrmsdk/src/com/zoho/crm/api/users/users.py new file mode 100644 index 0000000..87b6864 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/users.py @@ -0,0 +1,1516 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.record import Record +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from ..record import Record + + +class Users(Record): + def __init__(self): + """Creates an instance of Users""" + super().__init__() + + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.get_key_value('country') + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.add_key_value('country', country) + + def get_language(self): + """ + The method to get the language + + Returns: + string: A string representing the language + """ + + return self.get_key_value('language') + + def set_language(self, language): + """ + The method to set the value to language + + Parameters: + language (string) : A string representing the language + """ + + if language is not None and not isinstance(language, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: language EXPECTED TYPE: str', None, None) + + self.add_key_value('language', language) + + def get_microsoft(self): + """ + The method to get the microsoft + + Returns: + bool: A bool representing the microsoft + """ + + return self.get_key_value('microsoft') + + def set_microsoft(self, microsoft): + """ + The method to set the value to microsoft + + Parameters: + microsoft (bool) : A bool representing the microsoft + """ + + if microsoft is not None and not isinstance(microsoft, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: microsoft EXPECTED TYPE: bool', None, None) + + self.add_key_value('microsoft', microsoft) + + def get_shift_effective_from(self): + """ + The method to get the shift_effective_from + + Returns: + Object: A Object representing the shift_effective_from + """ + + return self.get_key_value('$shift_effective_from') + + def set_shift_effective_from(self, shift_effective_from): + """ + The method to set the value to shift_effective_from + + Parameters: + shift_effective_from (Object) : A Object representing the shift_effective_from + """ + + self.add_key_value('$shift_effective_from', shift_effective_from) + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.get_key_value('id') + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.add_key_value('id', id) + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.get_key_value('state') + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.add_key_value('state', state) + + def get_fax(self): + """ + The method to get the fax + + Returns: + string: A string representing the fax + """ + + return self.get_key_value('fax') + + def set_fax(self, fax): + """ + The method to set the value to fax + + Parameters: + fax (string) : A string representing the fax + """ + + if fax is not None and not isinstance(fax, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fax EXPECTED TYPE: str', None, None) + + self.add_key_value('fax', fax) + + def get_country_locale(self): + """ + The method to get the country_locale + + Returns: + string: A string representing the country_locale + """ + + return self.get_key_value('country_locale') + + def set_country_locale(self, country_locale): + """ + The method to set the value to country_locale + + Parameters: + country_locale (string) : A string representing the country_locale + """ + + if country_locale is not None and not isinstance(country_locale, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country_locale EXPECTED TYPE: str', None, None) + + self.add_key_value('country_locale', country_locale) + + def get_zip(self): + """ + The method to get the zip + + Returns: + string: A string representing the zip + """ + + return self.get_key_value('zip') + + def set_zip(self, zip): + """ + The method to set the value to zip + + Parameters: + zip (string) : A string representing the zip + """ + + if zip is not None and not isinstance(zip, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zip EXPECTED TYPE: str', None, None) + + self.add_key_value('zip', zip) + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('created_time') + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.add_key_value('created_time', created_time) + + def get_time_format(self): + """ + The method to get the time_format + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('time_format') + + def set_time_format(self, time_format): + """ + The method to set the value to time_format + + Parameters: + time_format (Choice) : An instance of Choice + """ + + if time_format is not None and not isinstance(time_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: time_format EXPECTED TYPE: Choice', None, None) + + self.add_key_value('time_format', time_format) + + def get_offset(self): + """ + The method to get the offset + + Returns: + int: An int representing the offset + """ + + return self.get_key_value('offset') + + def set_offset(self, offset): + """ + The method to set the value to offset + + Parameters: + offset (int) : An int representing the offset + """ + + if offset is not None and not isinstance(offset, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: offset EXPECTED TYPE: int', None, None) + + self.add_key_value('offset', offset) + + def get_imap_status(self): + """ + The method to get the imap_status + + Returns: + bool: A bool representing the imap_status + """ + + return self.get_key_value('imap_status') + + def set_imap_status(self, imap_status): + """ + The method to set the value to imap_status + + Parameters: + imap_status (bool) : A bool representing the imap_status + """ + + if imap_status is not None and not isinstance(imap_status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: imap_status EXPECTED TYPE: bool', None, None) + + self.add_key_value('imap_status', imap_status) + + def get_image_link(self): + """ + The method to get the image_link + + Returns: + string: A string representing the image_link + """ + + return self.get_key_value('image_link') + + def set_image_link(self, image_link): + """ + The method to set the value to image_link + + Parameters: + image_link (string) : A string representing the image_link + """ + + if image_link is not None and not isinstance(image_link, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: image_link EXPECTED TYPE: str', None, None) + + self.add_key_value('image_link', image_link) + + def get_ezuid(self): + """ + The method to get the ezuid + + Returns: + string: A string representing the ezuid + """ + + return self.get_key_value('ezuid') + + def set_ezuid(self, ezuid): + """ + The method to set the value to ezuid + + Parameters: + ezuid (string) : A string representing the ezuid + """ + + if ezuid is not None and not isinstance(ezuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ezuid EXPECTED TYPE: str', None, None) + + self.add_key_value('ezuid', ezuid) + + def get_profile(self): + """ + The method to get the profile + + Returns: + Profile: An instance of Profile + """ + + return self.get_key_value('profile') + + def set_profile(self, profile): + """ + The method to set the value to profile + + Parameters: + profile (Profile) : An instance of Profile + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.profile import Profile + except Exception: + from .profile import Profile + + if profile is not None and not isinstance(profile, Profile): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profile EXPECTED TYPE: Profile', None, None) + + self.add_key_value('profile', profile) + + def get_role(self): + """ + The method to get the role + + Returns: + Role: An instance of Role + """ + + return self.get_key_value('role') + + def set_role(self, role): + """ + The method to set the value to role + + Parameters: + role (Role) : An instance of Role + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.role import Role + except Exception: + from .role import Role + + if role is not None and not isinstance(role, Role): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: role EXPECTED TYPE: Role', None, None) + + self.add_key_value('role', role) + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('created_by') + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('created_by', created_by) + + def get_full_name(self): + """ + The method to get the full_name + + Returns: + string: A string representing the full_name + """ + + return self.get_key_value('full_name') + + def set_full_name(self, full_name): + """ + The method to set the value to full_name + + Parameters: + full_name (string) : A string representing the full_name + """ + + if full_name is not None and not isinstance(full_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: full_name EXPECTED TYPE: str', None, None) + + self.add_key_value('full_name', full_name) + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.get_key_value('zuid') + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.add_key_value('zuid', zuid) + + def get_phone(self): + """ + The method to get the phone + + Returns: + string: A string representing the phone + """ + + return self.get_key_value('phone') + + def set_phone(self, phone): + """ + The method to set the value to phone + + Parameters: + phone (string) : A string representing the phone + """ + + if phone is not None and not isinstance(phone, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: phone EXPECTED TYPE: str', None, None) + + self.add_key_value('phone', phone) + + def get_dob(self): + """ + The method to get the dob + + Returns: + date: An instance of date + """ + + return self.get_key_value('dob') + + def set_dob(self, dob): + """ + The method to set the value to dob + + Parameters: + dob (date) : An instance of date + """ + + from datetime import date as date1 + + if dob is not None and not isinstance(dob, date1): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: dob EXPECTED TYPE: date1', None, None) + + self.add_key_value('dob', dob) + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.get_key_value('status') + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.add_key_value('status', status) + + def get_customize_info(self): + """ + The method to get the customize_info + + Returns: + CustomizeInfo: An instance of CustomizeInfo + """ + + return self.get_key_value('customize_info') + + def set_customize_info(self, customize_info): + """ + The method to set the value to customize_info + + Parameters: + customize_info (CustomizeInfo) : An instance of CustomizeInfo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.customize_info import CustomizeInfo + except Exception: + from .customize_info import CustomizeInfo + + if customize_info is not None and not isinstance(customize_info, CustomizeInfo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: customize_info EXPECTED TYPE: CustomizeInfo', None, None) + + self.add_key_value('customize_info', customize_info) + + def get_city(self): + """ + The method to get the city + + Returns: + string: A string representing the city + """ + + return self.get_key_value('city') + + def set_city(self, city): + """ + The method to set the value to city + + Parameters: + city (string) : A string representing the city + """ + + if city is not None and not isinstance(city, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: city EXPECTED TYPE: str', None, None) + + self.add_key_value('city', city) + + def get_signature(self): + """ + The method to get the signature + + Returns: + string: A string representing the signature + """ + + return self.get_key_value('signature') + + def set_signature(self, signature): + """ + The method to set the value to signature + + Parameters: + signature (string) : A string representing the signature + """ + + if signature is not None and not isinstance(signature, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: signature EXPECTED TYPE: str', None, None) + + self.add_key_value('signature', signature) + + def get_sort_order_preference__s(self): + """ + The method to get the sort_order_preference__s + + Returns: + string: A string representing the sort_order_preference__s + """ + + return self.get_key_value('sort_order_preference__s') + + def set_sort_order_preference__s(self, sort_order_preference__s): + """ + The method to set the value to sort_order_preference__s + + Parameters: + sort_order_preference__s (string) : A string representing the sort_order_preference__s + """ + + if sort_order_preference__s is not None and not isinstance(sort_order_preference__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sort_order_preference__s EXPECTED TYPE: str', None, None) + + self.add_key_value('sort_order_preference__s', sort_order_preference__s) + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.get_key_value('category') + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.add_key_value('category', category) + + def get_date_format(self): + """ + The method to get the date_format + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('date_format') + + def set_date_format(self, date_format): + """ + The method to set the value to date_format + + Parameters: + date_format (Choice) : An instance of Choice + """ + + if date_format is not None and not isinstance(date_format, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date_format EXPECTED TYPE: Choice', None, None) + + self.add_key_value('date_format', date_format) + + def get_confirm(self): + """ + The method to get the confirm + + Returns: + bool: A bool representing the confirm + """ + + return self.get_key_value('confirm') + + def set_confirm(self, confirm): + """ + The method to set the value to confirm + + Parameters: + confirm (bool) : A bool representing the confirm + """ + + if confirm is not None and not isinstance(confirm, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: confirm EXPECTED TYPE: bool', None, None) + + self.add_key_value('confirm', confirm) + + def get_decimal_separator(self): + """ + The method to get the decimal_separator + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('decimal_separator') + + def set_decimal_separator(self, decimal_separator): + """ + The method to set the value to decimal_separator + + Parameters: + decimal_separator (Choice) : An instance of Choice + """ + + if decimal_separator is not None and not isinstance(decimal_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: decimal_separator EXPECTED TYPE: Choice', None, None) + + self.add_key_value('decimal_separator', decimal_separator) + + def get_number_separator(self): + """ + The method to get the number_separator + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('number_separator') + + def set_number_separator(self, number_separator): + """ + The method to set the value to number_separator + + Parameters: + number_separator (Choice) : An instance of Choice + """ + + if number_separator is not None and not isinstance(number_separator, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: number_separator EXPECTED TYPE: Choice', None, None) + + self.add_key_value('number_separator', number_separator) + + def get_time_zone(self): + """ + The method to get the time_zone + + Returns: + string: An instance of string + """ + + return self.get_key_value('time_zone') + + def set_time_zone(self, time_zone): + """ + The method to set the value to time_zone + + Parameters: + time_zone (string) : An instance of string + """ + + self.add_key_value('time_zone', time_zone) + + def get_last_name(self): + """ + The method to get the last_name + + Returns: + string: A string representing the last_name + """ + + return self.get_key_value('last_name') + + def set_last_name(self, last_name): + """ + The method to set the value to last_name + + Parameters: + last_name (string) : A string representing the last_name + """ + + if last_name is not None and not isinstance(last_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_name EXPECTED TYPE: str', None, None) + + self.add_key_value('last_name', last_name) + + def get_mobile(self): + """ + The method to get the mobile + + Returns: + string: A string representing the mobile + """ + + return self.get_key_value('mobile') + + def set_mobile(self, mobile): + """ + The method to set the value to mobile + + Parameters: + mobile (string) : A string representing the mobile + """ + + if mobile is not None and not isinstance(mobile, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: mobile EXPECTED TYPE: str', None, None) + + self.add_key_value('mobile', mobile) + + def get_current_shift(self): + """ + The method to get the current_shift + + Returns: + Shift: An instance of Shift + """ + + return self.get_key_value('$current_shift') + + def set_current_shift(self, current_shift): + """ + The method to set the value to current_shift + + Parameters: + current_shift (Shift) : An instance of Shift + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.shift import Shift + except Exception: + from .shift import Shift + + if current_shift is not None and not isinstance(current_shift, Shift): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: current_shift EXPECTED TYPE: Shift', None, None) + + self.add_key_value('$current_shift', current_shift) + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Reporting_To') + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if reporting_to is not None and not isinstance(reporting_to, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Reporting_To', reporting_to) + + def get_currency(self): + """ + The method to get the currency + + Returns: + string: A string representing the currency + """ + + return self.get_key_value('Currency') + + def set_currency(self, currency): + """ + The method to set the value to currency + + Parameters: + currency (string) : A string representing the currency + """ + + if currency is not None and not isinstance(currency, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: currency EXPECTED TYPE: str', None, None) + + self.add_key_value('Currency', currency) + + def get_next_shift(self): + """ + The method to get the next_shift + + Returns: + Shift: An instance of Shift + """ + + return self.get_key_value('$next_shift') + + def set_next_shift(self, next_shift): + """ + The method to set the value to next_shift + + Parameters: + next_shift (Shift) : An instance of Shift + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.shift import Shift + except Exception: + from .shift import Shift + + if next_shift is not None and not isinstance(next_shift, Shift): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: next_shift EXPECTED TYPE: Shift', None, None) + + self.add_key_value('$next_shift', next_shift) + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Modified_Time') + + 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.add_key_value('Modified_Time', modified_time) + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.get_key_value('website') + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.add_key_value('website', website) + + def get_status_reason__s(self): + """ + The method to get the status_reason__s + + Returns: + string: A string representing the status_reason__s + """ + + return self.get_key_value('status_reason__s') + + def set_status_reason__s(self, status_reason__s): + """ + The method to set the value to status_reason__s + + Parameters: + status_reason__s (string) : A string representing the status_reason__s + """ + + if status_reason__s is not None and not isinstance(status_reason__s, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status_reason__s EXPECTED TYPE: str', None, None) + + self.add_key_value('status_reason__s', status_reason__s) + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.get_key_value('email') + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.add_key_value('email', email) + + def get_first_name(self): + """ + The method to get the first_name + + Returns: + string: A string representing the first_name + """ + + return self.get_key_value('first_name') + + def set_first_name(self, first_name): + """ + The method to set the value to first_name + + Parameters: + first_name (string) : A string representing the first_name + """ + + if first_name is not None and not isinstance(first_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_name EXPECTED TYPE: str', None, None) + + self.add_key_value('first_name', first_name) + + def get_sandboxdeveloper(self): + """ + The method to get the sandboxdeveloper + + Returns: + bool: A bool representing the sandboxdeveloper + """ + + return self.get_key_value('sandboxDeveloper') + + 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 get_alias(self): + """ + The method to get the alias + + Returns: + string: A string representing the alias + """ + + return self.get_key_value('alias') + + def set_alias(self, alias): + """ + The method to set the value to alias + + Parameters: + alias (string) : A string representing the alias + """ + + if alias is not None and not isinstance(alias, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alias EXPECTED TYPE: str', None, None) + + self.add_key_value('alias', alias) + + def get_street(self): + """ + The method to get the street + + Returns: + string: A string representing the street + """ + + return self.get_key_value('street') + + def set_street(self, street): + """ + The method to set the value to street + + Parameters: + street (string) : A string representing the street + """ + + if street is not None and not isinstance(street, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: street EXPECTED TYPE: str', None, None) + + self.add_key_value('street', street) + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Modified_By') + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Modified_By', modified_by) + + def get_isonline(self): + """ + The method to get the isonline + + Returns: + bool: A bool representing the isonline + """ + + return self.get_key_value('Isonline') + + def set_isonline(self, isonline): + """ + The method to set the value to isonline + + Parameters: + isonline (bool) : A bool representing the isonline + """ + + if isonline is not None and not isinstance(isonline, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: isonline EXPECTED TYPE: bool', None, None) + + self.add_key_value('Isonline', isonline) + + def get_locale(self): + """ + The method to get the locale + + Returns: + string: A string representing the locale + """ + + return self.get_key_value('locale') + + def set_locale(self, locale): + """ + The method to set the value to locale + + Parameters: + locale (string) : A string representing the locale + """ + + if locale is not None and not isinstance(locale, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: locale EXPECTED TYPE: str', None, None) + + self.add_key_value('locale', locale) + + def get_name_format__s(self): + """ + The method to get the name_format__s + + Returns: + Choice: An instance of Choice + """ + + return self.get_key_value('name_format__s') + + def set_name_format__s(self, name_format__s): + """ + The method to set the value to name_format__s + + Parameters: + name_format__s (Choice) : An instance of Choice + """ + + if name_format__s is not None and not isinstance(name_format__s, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name_format__s EXPECTED TYPE: Choice', None, None) + + self.add_key_value('name_format__s', name_format__s) + + def get_personal_account(self): + """ + The method to get the personal_account + + Returns: + bool: A bool representing the personal_account + """ + + return self.get_key_value('personal_account') + + 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 get_default_tab_group(self): + """ + The method to get the default_tab_group + + Returns: + string: A string representing the default_tab_group + """ + + return self.get_key_value('default_tab_group') + + 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 get_theme(self): + """ + The method to get the theme + + Returns: + Theme: An instance of Theme + """ + + return self.get_key_value('theme') + + def set_theme(self, theme): + """ + The method to set the value to theme + + Parameters: + theme (Theme) : An instance of Theme + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.theme import Theme + except Exception: + from .theme import Theme + + if theme is not None and not isinstance(theme, Theme): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: theme EXPECTED TYPE: Theme', None, None) + + self.add_key_value('theme', theme) + + def get_ntc_notification_type(self): + """ + The method to get the ntc_notification_type + + Returns: + list: An instance of list + """ + + return self.get_key_value('ntc_notification_type') + + def set_ntc_notification_type(self, ntc_notification_type): + """ + The method to set the value to ntc_notification_type + + Parameters: + ntc_notification_type (list) : An instance of list + """ + + if ntc_notification_type is not None and not isinstance(ntc_notification_type, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ntc_notification_type EXPECTED TYPE: list', None, None) + + self.add_key_value('ntc_notification_type', ntc_notification_type) + + def get_ntc_enabled(self): + """ + The method to get the ntc_enabled + + Returns: + bool: A bool representing the ntc_enabled + """ + + return self.get_key_value('ntc_enabled') + + def set_ntc_enabled(self, ntc_enabled): + """ + The method to set the value to ntc_enabled + + Parameters: + ntc_enabled (bool) : A bool representing the ntc_enabled + """ + + if ntc_enabled is not None and not isinstance(ntc_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ntc_enabled EXPECTED TYPE: bool', None, None) + + self.add_key_value('ntc_enabled', ntc_enabled) + + def get_rtl_enabled(self): + """ + The method to get the rtl_enabled + + Returns: + bool: A bool representing the rtl_enabled + """ + + return self.get_key_value('rtl_enabled') + + def set_rtl_enabled(self, rtl_enabled): + """ + The method to set the value to rtl_enabled + + Parameters: + rtl_enabled (bool) : A bool representing the rtl_enabled + """ + + if rtl_enabled is not None and not isinstance(rtl_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: rtl_enabled EXPECTED TYPE: bool', None, None) + + self.add_key_value('rtl_enabled', rtl_enabled) + + def get_telephony_enabled(self): + """ + The method to get the telephony_enabled + + Returns: + bool: A bool representing the telephony_enabled + """ + + return self.get_key_value('telephony_enabled') + + def set_telephony_enabled(self, telephony_enabled): + """ + The method to set the value to telephony_enabled + + Parameters: + telephony_enabled (bool) : A bool representing the telephony_enabled + """ + + if telephony_enabled is not None and not isinstance(telephony_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: telephony_enabled EXPECTED TYPE: bool', None, None) + + self.add_key_value('telephony_enabled', telephony_enabled) + + def get_sort_order_preference(self): + """ + The method to get the sort_order_preference + + Returns: + string: A string representing the sort_order_preference + """ + + return self.get_key_value('sort_order_preference') + + 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 get_created_by_17(self): + """ + The method to get the created_by_17 + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.get_key_value('Created_By') + + def set_created_by_17(self, created_by_17): + """ + The method to set the value to created_by_17 + + Parameters: + created_by_17 (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.minified_user import MinifiedUser + except Exception: + from .minified_user import MinifiedUser + + if created_by_17 is not None and not isinstance(created_by_17, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by_17 EXPECTED TYPE: MinifiedUser', None, None) + + self.add_key_value('Created_By', created_by_17) + + def get_created_time_9(self): + """ + The method to get the created_time_9 + + Returns: + datetime: An instance of datetime + """ + + return self.get_key_value('Created_Time') + + def set_created_time_9(self, created_time_9): + """ + The method to set the value to created_time_9 + + Parameters: + created_time_9 (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time_9 is not None and not isinstance(created_time_9, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time_9 EXPECTED TYPE: datetime', None, None) + + self.add_key_value('Created_Time', created_time_9) + + def get_tag(self): + """ + The method to get the tag + + Returns: + list: An instance of list + """ + + return self.get_key_value('Tag') + + def set_tag(self, tag): + """ + The method to set the value to tag + + Parameters: + tag (list) : An instance of list + """ + + if tag is not None and not isinstance(tag, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tag EXPECTED TYPE: list', None, None) + + self.add_key_value('Tag', tag) + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.get_key_value('name') + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.add_key_value('name', name) diff --git a/zohocrmsdk/src/com/zoho/crm/api/users/users_operations.py b/zohocrmsdk/src/com/zoho/crm/api/users/users_operations.py new file mode 100644 index 0000000..21c4340 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users/users_operations.py @@ -0,0 +1,346 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.header import Header +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + from ..header import Header + + +class UsersOperations(object): + def __init__(self): + """Creates an instance of UsersOperations""" + pass + + def get_users(self, param_instance=None, header_instance=None): + """ + The method to get users + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + 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) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users' + 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.set_param(param_instance) + handler_instance.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_users(self, request): + """ + The method to create users + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_users(self, request): + """ + The method to update users + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_user(self, user, header_instance=None): + """ + The method to get user + + Parameters: + user (int) : An int representing the user + header_instance (HeaderMap) : An instance of HeaderMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import HeaderMap + except Exception: + from ..header_map import HeaderMap + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + if header_instance is not None and not isinstance(header_instance, HeaderMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: header_instance EXPECTED TYPE: HeaderMap', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(user) + 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.set_header(header_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_user(self, user, request): + """ + The method to update user + + Parameters: + user (int) : An int representing the user + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user 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/v7/users/' + api_path = api_path + str(user) + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_user(self, user): + """ + The method to delete user + + Parameters: + user (int) : An int representing the user + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(user) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_associated_groups(self, user, param_instance=None): + """ + The method to get associated groups + + Parameters: + user (int) : An int representing the user + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + 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/v7/users/' + api_path = api_path + str(user) + api_path = api_path + '/actions/associated_groups' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def users_count(self, param_instance=None): + """ + The method to users count + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/users/actions/count' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users.count_handler import CountHandler + except Exception: + from .count_handler import CountHandler + return handler_instance.api_call(CountHandler.__module__, 'application/json') + + +class GetUsersParam(object): + type = Param('type', 'com.zoho.crm.api.Users.GetUsersParam') + page = Param('page', 'com.zoho.crm.api.Users.GetUsersParam') + per_page = Param('per_page', 'com.zoho.crm.api.Users.GetUsersParam') + ids = Param('ids', 'com.zoho.crm.api.Users.GetUsersParam') + + +class GetUsersHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Users.GetUsersHeader') + + +class GetUserHeader(object): + if_modified_since = Header('If-Modified-Since', 'com.zoho.crm.api.Users.GetUserHeader') + + +class GetAssociatedGroupsParam(object): + include = Param('include', 'com.zoho.crm.api.Users.GetAssociatedGroupsParam') + + +class UsersCountParam(object): + type = Param('type', 'com.zoho.crm.api.Users.UsersCountParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/__init__.py new file mode 100644 index 0000000..65ce794 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/__init__.py @@ -0,0 +1,24 @@ +from .action_wrapper import ActionWrapper +from .transfer_and_delink import TransferAndDelink +from .transfer_action_wrapper import TransferActionWrapper +from .users_territories_operations import UsersTerritoriesOperations +from .transfer_action_handler import TransferActionHandler +from .manager import Manager +from .transfer_action_response import TransferActionResponse +from .body_wrapper import BodyWrapper +from .validation_wrapper import ValidationWrapper +from .bulk_validation import BulkValidation +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .action_wrappe import ActionWrappe +from .transfer_wrapper import TransferWrapper +from .validation_handler import ValidationHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .validation_group import ValidationGroup +from .action_handler import ActionHandler +from .transfer_to_user import TransferToUser +from .validation import Validation +from .territory import Territory +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrappe.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrappe.py new file mode 100644 index 0000000..1fa20bd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrappe.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrappe(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrappe""" + super().__init__() + + self.__transfer_and_delink = None + self.__key_modified = dict() + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrapper.py new file mode 100644 index 0000000..f0febca --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/action_wrapper.py @@ -0,0 +1,102 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__transfer_and_delink = None + self.__key_modified = dict() + self.__territories = None + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/api_exception.py new file mode 100644 index 0000000..791d4e9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/api_exception.py @@ -0,0 +1,160 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .transfer_action_handler import TransferActionHandler + from .validation_handler import ValidationHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler, ValidationHandler, TransferActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/body_wrapper.py new file mode 100644 index 0000000..5e9566b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__territories = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/bulk_validation.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/bulk_validation.py new file mode 100644 index 0000000..a2ef705 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/bulk_validation.py @@ -0,0 +1,177 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_group import ValidationGroup +except Exception: + from ..exception import SDKException + from ..util import Constants + from .validation_group import ValidationGroup + + +class BulkValidation(ValidationGroup): + def __init__(self): + """Creates an instance of BulkValidation""" + super().__init__() + + self.__alert = None + self.__assignment = None + self.__criteria = None + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_alert(self): + """ + The method to get the alert + + Returns: + bool: A bool representing the alert + """ + + return self.__alert + + def set_alert(self, alert): + """ + The method to set the value to alert + + Parameters: + alert (bool) : A bool representing the alert + """ + + if alert is not None and not isinstance(alert, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: alert EXPECTED TYPE: bool', None, None) + + self.__alert = alert + self.__key_modified['alert'] = 1 + + def get_assignment(self): + """ + The method to get the assignment + + Returns: + bool: A bool representing the assignment + """ + + return self.__assignment + + def set_assignment(self, assignment): + """ + The method to set the value to assignment + + Parameters: + assignment (bool) : A bool representing the assignment + """ + + if assignment is not None and not isinstance(assignment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment EXPECTED TYPE: bool', None, None) + + self.__assignment = assignment + self.__key_modified['assignment'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + bool: A bool representing the criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (bool) : A bool representing the criteria + """ + + if criteria is not None and not isinstance(criteria, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: bool', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/info.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/info.py new file mode 100644 index 0000000..d656bd3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__count = None + self.__page = None + self.__per_page = None + self.__more_records = None + self.__key_modified = dict() + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/manager.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/manager.py new file mode 100644 index 0000000..cf6176a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/manager.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Manager(object): + def __init__(self): + """Creates an instance of Manager""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_wrapper.py new file mode 100644 index 0000000..0925122 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__territories = None + self.__info = None + self.__key_modified = dict() + + def get_territories(self): + """ + The method to get the territories + + Returns: + list: An instance of list + """ + + return self.__territories + + def set_territories(self, territories): + """ + The method to set the value to territories + + Parameters: + territories (list) : An instance of list + """ + + if territories is not None and not isinstance(territories, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territories EXPECTED TYPE: list', None, None) + + self.__territories = territories + self.__key_modified['territories'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/success_response.py new file mode 100644 index 0000000..181b350 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/success_response.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_response import TransferActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .transfer_action_response import TransferActionResponse + + +class SuccessResponse(ActionResponse, TransferActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/territory.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/territory.py new file mode 100644 index 0000000..43f59a9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/territory.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Territory(object): + def __init__(self): + """Creates an instance of Territory""" + + self.__id = None + self.__manager = None + self.__reporting_to = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_manager(self): + """ + The method to get the manager + + Returns: + Manager: An instance of Manager + """ + + return self.__manager + + def set_manager(self, manager): + """ + The method to set the value to manager + + Parameters: + manager (Manager) : An instance of Manager + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.manager import Manager + except Exception: + from .manager import Manager + + if manager is not None and not isinstance(manager, Manager): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: manager EXPECTED TYPE: Manager', None, None) + + self.__manager = manager + self.__key_modified['Manager'] = 1 + + def get_reporting_to(self): + """ + The method to get the reporting_to + + Returns: + Manager: An instance of Manager + """ + + return self.__reporting_to + + def set_reporting_to(self, reporting_to): + """ + The method to set the value to reporting_to + + Parameters: + reporting_to (Manager) : An instance of Manager + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.manager import Manager + except Exception: + from .manager import Manager + + if reporting_to is not None and not isinstance(reporting_to, Manager): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reporting_to EXPECTED TYPE: Manager', None, None) + + self.__reporting_to = reporting_to + self.__key_modified['Reporting_To'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_handler.py new file mode 100644 index 0000000..574e9c4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferActionHandler(ABC): + def __init__(self): + """Creates an instance of TransferActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_response.py new file mode 100644 index 0000000..ebad40c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class TransferActionResponse(ABC): + def __init__(self): + """Creates an instance of TransferActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_wrapper.py new file mode 100644 index 0000000..1555d5e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .transfer_action_handler import TransferActionHandler + + +class TransferActionWrapper(TransferActionHandler): + def __init__(self): + """Creates an instance of TransferActionWrapper""" + super().__init__() + + self.__transfer_and_delink = None + self.__key_modified = dict() + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_and_delink.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_and_delink.py new file mode 100644 index 0000000..f87ecae --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_and_delink.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferAndDelink(object): + def __init__(self): + """Creates an instance of TransferAndDelink""" + + self.__id = None + self.__transfer_to_user = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_transfer_to_user(self): + """ + The method to get the transfer_to_user + + Returns: + TransferToUser: An instance of TransferToUser + """ + + return self.__transfer_to_user + + def set_transfer_to_user(self, transfer_to_user): + """ + The method to set the value to transfer_to_user + + Parameters: + transfer_to_user (TransferToUser) : An instance of TransferToUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_to_user import TransferToUser + except Exception: + from .transfer_to_user import TransferToUser + + if transfer_to_user is not None and not isinstance(transfer_to_user, TransferToUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_to_user EXPECTED TYPE: TransferToUser', None, None) + + self.__transfer_to_user = transfer_to_user + self.__key_modified['transfer_to_user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_to_user.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_to_user.py new file mode 100644 index 0000000..c41febd --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_to_user.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferToUser(object): + def __init__(self): + """Creates an instance of TransferToUser""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_wrapper.py new file mode 100644 index 0000000..0b16e6a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/transfer_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferWrapper(object): + def __init__(self): + """Creates an instance of TransferWrapper""" + + self.__transfer_and_delink = None + self.__key_modified = dict() + + def get_transfer_and_delink(self): + """ + The method to get the transfer_and_delink + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delink + + def set_transfer_and_delink(self, transfer_and_delink): + """ + The method to set the value to transfer_and_delink + + Parameters: + transfer_and_delink (list) : An instance of list + """ + + if transfer_and_delink is not None and not isinstance(transfer_and_delink, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delink EXPECTED TYPE: list', None, None) + + self.__transfer_and_delink = transfer_and_delink + self.__key_modified['transfer_and_delink'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/users_territories_operations.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/users_territories_operations.py new file mode 100644 index 0000000..90efbe3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/users_territories_operations.py @@ -0,0 +1,258 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class UsersTerritoriesOperations(object): + def __init__(self, user): + """ + Creates an instance of UsersTerritoriesOperations with the given parameters + + Parameters: + user (int) : An int representing the user + """ + + if not isinstance(user, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: int', None, None) + + self.__user = user + + + def get_territories_of_user(self): + """ + The method to get territories of user + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def associate_territories_to_user(self, request): + """ + The method to associate territories to user + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_territory_of_user(self, territory): + """ + The method to get territory of user + + Parameters: + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/' + api_path = api_path + str(territory) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def validate_before_transfer_for_all_territories(self): + """ + The method to validate before transfer for all territories + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/actions/validate_before_transfer' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler + except Exception: + from .validation_handler import ValidationHandler + return handler_instance.api_call(ValidationHandler.__module__, 'application/json') + + def validate_before_transfer(self, territory): + """ + The method to validate before transfer + + Parameters: + territory (int) : An int representing the territory + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/actions/validate_before_transfer' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_GET) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler + except Exception: + from .validation_handler import ValidationHandler + return handler_instance.api_call(ValidationHandler.__module__, 'application/json') + + def delink_and_transfer_from_all_territories(self, request): + """ + The method to delink and transfer from all territories + + Parameters: + request (TransferWrapper) : An instance of TransferWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_wrapper import TransferWrapper + except Exception: + from .transfer_wrapper import TransferWrapper + + if request is not None and not isinstance(request, TransferWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/actions/transfer_and_delink' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler + except Exception: + from .transfer_action_handler import TransferActionHandler + return handler_instance.api_call(TransferActionHandler.__module__, 'application/json') + + def delink_and_transfer_from_specific_territory(self, territory, request): + """ + The method to delink and transfer from specific territory + + Parameters: + territory (int) : An int representing the territory + request (TransferWrapper) : An instance of TransferWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_wrapper import TransferWrapper + except Exception: + from .transfer_wrapper import TransferWrapper + + if not isinstance(territory, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory EXPECTED TYPE: int', None, None) + + if request is not None and not isinstance(request, TransferWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: TransferWrapper', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users/' + api_path = api_path + str(self.__user) + api_path = api_path + '/territories/' + api_path = api_path + str(territory) + api_path = api_path + '/actions/transfer_and_delink' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_territories.transfer_action_handler import TransferActionHandler + except Exception: + from .transfer_action_handler import TransferActionHandler + return handler_instance.api_call(TransferActionHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation.py new file mode 100644 index 0000000..dfb8b0c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation.py @@ -0,0 +1,127 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_group import ValidationGroup +except Exception: + from ..exception import SDKException + from ..util import Constants + from .validation_group import ValidationGroup + + +class Validation(ValidationGroup): + def __init__(self): + """Creates an instance of Validation""" + super().__init__() + + self.__id = None + self.__name = None + self.__records = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['Name'] = 1 + + def get_records(self): + """ + The method to get the records + + Returns: + bool: A bool representing the records + """ + + return self.__records + + def set_records(self, records): + """ + The method to set the value to records + + Parameters: + records (bool) : A bool representing the records + """ + + if records is not None and not isinstance(records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: records EXPECTED TYPE: bool', None, None) + + self.__records = records + self.__key_modified['records'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_group.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_group.py new file mode 100644 index 0000000..0bb2748 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_group.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ValidationGroup(ABC): + def __init__(self): + """Creates an instance of ValidationGroup""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_handler.py new file mode 100644 index 0000000..c3ab80f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ValidationHandler(ABC): + def __init__(self): + """Creates an instance of ValidationHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_wrapper.py new file mode 100644 index 0000000..5c02b93 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_territories/validation_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_territories.validation_handler import ValidationHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .validation_handler import ValidationHandler + + +class ValidationWrapper(ValidationHandler): + def __init__(self): + """Creates an instance of ValidationWrapper""" + super().__init__() + + self.__validate_before_transfer = None + self.__key_modified = dict() + + def get_validate_before_transfer(self): + """ + The method to get the validate_before_transfer + + Returns: + list: An instance of list + """ + + return self.__validate_before_transfer + + def set_validate_before_transfer(self, validate_before_transfer): + """ + The method to set the value to validate_before_transfer + + Parameters: + validate_before_transfer (list) : An instance of list + """ + + if validate_before_transfer is not None and not isinstance(validate_before_transfer, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: validate_before_transfer EXPECTED TYPE: list', None, None) + + self.__validate_before_transfer = validate_before_transfer + self.__key_modified['validate_before_transfer'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/__init__.py new file mode 100644 index 0000000..cdf886e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/__init__.py @@ -0,0 +1,14 @@ +from .action_wrapper import ActionWrapper +from .move_subordinate import MoveSubordinate +from .body_wrapper import BodyWrapper +from .transfer_and_delete_by_id import TransferAndDeleteByID +from .transfer_and_delete import TransferAndDelete +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .transfer import Transfer +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .users_transfer_delete_operations import UsersTransferDeleteOperations, GetStatusParam +from .status import Status diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_wrapper.py new file mode 100644 index 0000000..9a4b0ee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__transfer_and_delete = None + self.__key_modified = dict() + + def get_transfer_and_delete(self): + """ + The method to get the transfer_and_delete + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delete + + def set_transfer_and_delete(self, transfer_and_delete): + """ + The method to set the value to transfer_and_delete + + Parameters: + transfer_and_delete (list) : An instance of list + """ + + if transfer_and_delete is not None and not isinstance(transfer_and_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delete EXPECTED TYPE: list', None, None) + + self.__transfer_and_delete = transfer_and_delete + self.__key_modified['transfer_and_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/api_exception.py new file mode 100644 index 0000000..e6d47ee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionHandler, ActionResponse, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/body_wrapper.py new file mode 100644 index 0000000..14ed9e3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__transfer_and_delete = None + self.__key_modified = dict() + + def get_transfer_and_delete(self): + """ + The method to get the transfer_and_delete + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delete + + def set_transfer_and_delete(self, transfer_and_delete): + """ + The method to set the value to transfer_and_delete + + Parameters: + transfer_and_delete (list) : An instance of list + """ + + if transfer_and_delete is not None and not isinstance(transfer_and_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delete EXPECTED TYPE: list', None, None) + + self.__transfer_and_delete = transfer_and_delete + self.__key_modified['transfer_and_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/move_subordinate.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/move_subordinate.py new file mode 100644 index 0000000..228e1b4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/move_subordinate.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MoveSubordinate(object): + def __init__(self): + """Creates an instance of MoveSubordinate""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_wrapper.py new file mode 100644 index 0000000..21173a3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__transfer_and_delete = None + self.__key_modified = dict() + + def get_transfer_and_delete(self): + """ + The method to get the transfer_and_delete + + Returns: + list: An instance of list + """ + + return self.__transfer_and_delete + + def set_transfer_and_delete(self, transfer_and_delete): + """ + The method to set the value to transfer_and_delete + + Parameters: + transfer_and_delete (list) : An instance of list + """ + + if transfer_and_delete is not None and not isinstance(transfer_and_delete, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer_and_delete EXPECTED TYPE: list', None, None) + + self.__transfer_and_delete = transfer_and_delete + self.__key_modified['transfer_and_delete'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/status.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/status.py new file mode 100644 index 0000000..65aab16 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/status.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Status(object): + def __init__(self): + """Creates an instance of Status""" + + self.__status = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/success_response.py new file mode 100644 index 0000000..c794901 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer.py new file mode 100644 index 0000000..51ab88c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Transfer(object): + def __init__(self): + """Creates an instance of Transfer""" + + self.__records = None + self.__assignment = None + self.__criteria = None + self.__id = None + self.__key_modified = dict() + + def get_records(self): + """ + The method to get the records + + Returns: + bool: A bool representing the records + """ + + return self.__records + + def set_records(self, records): + """ + The method to set the value to records + + Parameters: + records (bool) : A bool representing the records + """ + + if records is not None and not isinstance(records, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: records EXPECTED TYPE: bool', None, None) + + self.__records = records + self.__key_modified['records'] = 1 + + def get_assignment(self): + """ + The method to get the assignment + + Returns: + bool: A bool representing the assignment + """ + + return self.__assignment + + def set_assignment(self, assignment): + """ + The method to set the value to assignment + + Parameters: + assignment (bool) : A bool representing the assignment + """ + + if assignment is not None and not isinstance(assignment, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment EXPECTED TYPE: bool', None, None) + + self.__assignment = assignment + self.__key_modified['assignment'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + bool: A bool representing the criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (bool) : A bool representing the criteria + """ + + if criteria is not None and not isinstance(criteria, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: bool', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete.py new file mode 100644 index 0000000..fc457a3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferAndDelete(object): + def __init__(self): + """Creates an instance of TransferAndDelete""" + + self.__id = None + self.__transfer = None + self.__move_subordinate = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_transfer(self): + """ + The method to get the transfer + + Returns: + Transfer: An instance of Transfer + """ + + return self.__transfer + + def set_transfer(self, transfer): + """ + The method to set the value to transfer + + Parameters: + transfer (Transfer) : An instance of Transfer + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.transfer import Transfer + except Exception: + from .transfer import Transfer + + if transfer is not None and not isinstance(transfer, Transfer): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer EXPECTED TYPE: Transfer', None, None) + + self.__transfer = transfer + self.__key_modified['transfer'] = 1 + + def get_move_subordinate(self): + """ + The method to get the move_subordinate + + Returns: + MoveSubordinate: An instance of MoveSubordinate + """ + + return self.__move_subordinate + + def set_move_subordinate(self, move_subordinate): + """ + The method to set the value to move_subordinate + + Parameters: + move_subordinate (MoveSubordinate) : An instance of MoveSubordinate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.move_subordinate import MoveSubordinate + except Exception: + from .move_subordinate import MoveSubordinate + + if move_subordinate is not None and not isinstance(move_subordinate, MoveSubordinate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_subordinate EXPECTED TYPE: MoveSubordinate', None, None) + + self.__move_subordinate = move_subordinate + self.__key_modified['move_subordinate'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.py new file mode 100644 index 0000000..76758b1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/transfer_and_delete_by_id.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class TransferAndDeleteByID(object): + def __init__(self): + """Creates an instance of TransferAndDeleteByID""" + + self.__transfer = None + self.__move_subordinate = None + self.__key_modified = dict() + + def get_transfer(self): + """ + The method to get the transfer + + Returns: + Transfer: An instance of Transfer + """ + + return self.__transfer + + def set_transfer(self, transfer): + """ + The method to set the value to transfer + + Parameters: + transfer (Transfer) : An instance of Transfer + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.transfer import Transfer + except Exception: + from .transfer import Transfer + + if transfer is not None and not isinstance(transfer, Transfer): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transfer EXPECTED TYPE: Transfer', None, None) + + self.__transfer = transfer + self.__key_modified['transfer'] = 1 + + def get_move_subordinate(self): + """ + The method to get the move_subordinate + + Returns: + MoveSubordinate: An instance of MoveSubordinate + """ + + return self.__move_subordinate + + def set_move_subordinate(self, move_subordinate): + """ + The method to set the value to move_subordinate + + Parameters: + move_subordinate (MoveSubordinate) : An instance of MoveSubordinate + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.move_subordinate import MoveSubordinate + except Exception: + from .move_subordinate import MoveSubordinate + + if move_subordinate is not None and not isinstance(move_subordinate, MoveSubordinate): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: move_subordinate EXPECTED TYPE: MoveSubordinate', None, None) + + self.__move_subordinate = move_subordinate + self.__key_modified['move_subordinate'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/users_transfer_delete_operations.py b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/users_transfer_delete_operations.py new file mode 100644 index 0000000..b7e8312 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_transfer_delete/users_transfer_delete_operations.py @@ -0,0 +1,133 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UsersTransferDeleteOperations(object): + def __init__(self): + """Creates an instance of UsersTransferDeleteOperations""" + pass + + def users_transfer_and_delete(self, request): + """ + The method to users transfer and delete + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/users/actions/transfer_and_delete' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_status(self, param_instance=None): + """ + The method to get status + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/users/actions/transfer_and_delete' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def user_transfer_and_delete(self, id, request): + """ + The method to user transfer and delete + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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/v7/users/' + api_path = api_path + str(id) + api_path = api_path + '/actions/transfer_and_delete' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetStatusParam(object): + job_id = Param('job_id', 'com.zoho.crm.api.UsersTransferDelete.GetStatusParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/__init__.py new file mode 100644 index 0000000..6aa4c02 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/__init__.py @@ -0,0 +1,12 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .users_unavailability_operations import UsersUnavailabilityOperations, GetUsersUnavailabilityParam, GetUserUnavailabilityParam +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .users_unavailability import UsersUnavailability +from .body_wrapper import BodyWrapper +from .user import User +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_wrapper.py new file mode 100644 index 0000000..8e0c513 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__users_unavailability = None + self.__key_modified = dict() + + def get_users_unavailability(self): + """ + The method to get the users_unavailability + + Returns: + list: An instance of list + """ + + return self.__users_unavailability + + def set_users_unavailability(self, users_unavailability): + """ + The method to set the value to users_unavailability + + Parameters: + users_unavailability (list) : An instance of list + """ + + if users_unavailability is not None and not isinstance(users_unavailability, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_unavailability EXPECTED TYPE: list', None, None) + + self.__users_unavailability = users_unavailability + self.__key_modified['users_unavailability'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/api_exception.py new file mode 100644 index 0000000..339233c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ActionHandler, ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/body_wrapper.py new file mode 100644 index 0000000..93395f0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__users_unavailability = None + self.__key_modified = dict() + + def get_users_unavailability(self): + """ + The method to get the users_unavailability + + Returns: + list: An instance of list + """ + + return self.__users_unavailability + + def set_users_unavailability(self, users_unavailability): + """ + The method to set the value to users_unavailability + + Parameters: + users_unavailability (list) : An instance of list + """ + + if users_unavailability is not None and not isinstance(users_unavailability, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_unavailability EXPECTED TYPE: list', None, None) + + self.__users_unavailability = users_unavailability + self.__key_modified['users_unavailability'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/info.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_wrapper.py new file mode 100644 index 0000000..d4ab94e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__users_unavailability = None + self.__info = None + self.__key_modified = dict() + + def get_users_unavailability(self): + """ + The method to get the users_unavailability + + Returns: + list: An instance of list + """ + + return self.__users_unavailability + + def set_users_unavailability(self, users_unavailability): + """ + The method to set the value to users_unavailability + + Parameters: + users_unavailability (list) : An instance of list + """ + + if users_unavailability is not None and not isinstance(users_unavailability, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: users_unavailability EXPECTED TYPE: list', None, None) + + self.__users_unavailability = users_unavailability + self.__key_modified['users_unavailability'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/success_response.py new file mode 100644 index 0000000..038347a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/user.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/user.py new file mode 100644 index 0000000..7305eca --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/user.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__zuid = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_zuid(self): + """ + The method to get the zuid + + Returns: + string: A string representing the zuid + """ + + return self.__zuid + + def set_zuid(self, zuid): + """ + The method to set the value to zuid + + Parameters: + zuid (string) : A string representing the zuid + """ + + if zuid is not None and not isinstance(zuid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zuid EXPECTED TYPE: str', None, None) + + self.__zuid = zuid + self.__key_modified['zuid'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability.py new file mode 100644 index 0000000..9875fc8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability.py @@ -0,0 +1,308 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class UsersUnavailability(object): + def __init__(self): + """Creates an instance of UsersUnavailability""" + + self.__service = None + self.__title = None + self.__all_day = None + self.__tp_calendar_id = None + self.__tp_event_id = None + self.__comments = None + self.__from_1 = None + self.__id = None + self.__to = None + self.__user = None + self.__key_modified = dict() + + def get_service(self): + """ + The method to get the service + + Returns: + string: A string representing the service + """ + + return self.__service + + def set_service(self, service): + """ + The method to set the value to service + + Parameters: + service (string) : A string representing the service + """ + + if service is not None and not isinstance(service, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: service EXPECTED TYPE: str', None, None) + + self.__service = service + self.__key_modified['service'] = 1 + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_all_day(self): + """ + The method to get the all_day + + Returns: + bool: A bool representing the all_day + """ + + return self.__all_day + + def set_all_day(self, all_day): + """ + The method to set the value to all_day + + Parameters: + all_day (bool) : A bool representing the all_day + """ + + if all_day is not None and not isinstance(all_day, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: all_day EXPECTED TYPE: bool', None, None) + + self.__all_day = all_day + self.__key_modified['all_day'] = 1 + + def get_tp_calendar_id(self): + """ + The method to get the tp_calendar_id + + Returns: + string: A string representing the tp_calendar_id + """ + + return self.__tp_calendar_id + + def set_tp_calendar_id(self, tp_calendar_id): + """ + The method to set the value to tp_calendar_id + + Parameters: + tp_calendar_id (string) : A string representing the tp_calendar_id + """ + + if tp_calendar_id is not None and not isinstance(tp_calendar_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tp_calendar_id EXPECTED TYPE: str', None, None) + + self.__tp_calendar_id = tp_calendar_id + self.__key_modified['tp_calendar_id'] = 1 + + def get_tp_event_id(self): + """ + The method to get the tp_event_id + + Returns: + string: A string representing the tp_event_id + """ + + return self.__tp_event_id + + def set_tp_event_id(self, tp_event_id): + """ + The method to set the value to tp_event_id + + Parameters: + tp_event_id (string) : A string representing the tp_event_id + """ + + if tp_event_id is not None and not isinstance(tp_event_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tp_event_id EXPECTED TYPE: str', None, None) + + self.__tp_event_id = tp_event_id + self.__key_modified['tp_event_id'] = 1 + + def get_comments(self): + """ + The method to get the comments + + Returns: + string: A string representing the comments + """ + + return self.__comments + + def set_comments(self, comments): + """ + The method to set the value to comments + + Parameters: + comments (string) : A string representing the comments + """ + + if comments is not None and not isinstance(comments, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comments EXPECTED TYPE: str', None, None) + + self.__comments = comments + self.__key_modified['comments'] = 1 + + def get_from(self): + """ + The method to get the from + + Returns: + datetime: An instance of datetime + """ + + return self.__from_1 + + def set_from(self, from_1): + """ + The method to set the value to from + + Parameters: + from_1 (datetime) : An instance of datetime + """ + + from datetime import datetime + + if from_1 is not None and not isinstance(from_1, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_1 EXPECTED TYPE: datetime', None, None) + + self.__from_1 = from_1 + self.__key_modified['from'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_to(self): + """ + The method to get the to + + Returns: + datetime: An instance of datetime + """ + + return self.__to + + def set_to(self, to): + """ + The method to set the value to to + + Parameters: + to (datetime) : An instance of datetime + """ + + from datetime import datetime + + if to is not None and not isinstance(to, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: to EXPECTED TYPE: datetime', None, None) + + self.__to = to + self.__key_modified['to'] = 1 + + def get_user(self): + """ + The method to get the user + + Returns: + User: An instance of User + """ + + return self.__user + + def set_user(self, user): + """ + The method to set the value to user + + Parameters: + user (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.user import User + except Exception: + from .user import User + + if user is not None and not isinstance(user, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user EXPECTED TYPE: User', None, None) + + self.__user = user + self.__key_modified['user'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability_operations.py b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability_operations.py new file mode 100644 index 0000000..cd9a775 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/users_unavailability/users_unavailability_operations.py @@ -0,0 +1,247 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class UsersUnavailabilityOperations(object): + def __init__(self): + """Creates an instance of UsersUnavailabilityOperations""" + pass + + def create_users_unavailability(self, request): + """ + The method to create users unavailability + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/users_unavailability' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_users_unavailability(self, request): + """ + The method to update users unavailability + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/users_unavailability' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_users_unavailability(self, param_instance=None): + """ + The method to get users unavailability + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/users_unavailability' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_user_unavailability(self, id, request): + """ + The method to update user unavailability + + Parameters: + id (string) : A string representing the id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', 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/v7/settings/users_unavailability/' + api_path = api_path + str(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) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_user_unavailability(self, id, param_instance=None): + """ + The method to get user unavailability + + Parameters: + id (string) : A string representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + 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/v7/settings/users_unavailability/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def delete_user_unavailability(self, id): + """ + The method to delete user unavailability + + Parameters: + id (string) : A string representing the id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/users_unavailability/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_READ) + try: + from zohocrmsdk.src.com.zoho.crm.api.users_unavailability.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetUsersUnavailabilityParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + group_ids = Param('group_ids', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + role_ids = Param('role_ids', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + territory_ids = Param('territory_ids', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + filters = Param('filters', 'com.zoho.crm.api.UsersUnavailability.GetUsersUnavailabilityParam') + + +class GetUserUnavailabilityParam(object): + include_inner_details = Param('include_inner_details', 'com.zoho.crm.api.UsersUnavailability.GetUserUnavailabilityParam') + filters = Param('filters', 'com.zoho.crm.api.UsersUnavailability.GetUserUnavailabilityParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/util/__init__.py new file mode 100755 index 0000000..f4c05da --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/__init__.py @@ -0,0 +1,15 @@ +from .common_api_handler import CommonAPIHandler +from .converter import Converter +from .json_converter import JSONConverter +from .xml_converter import XMLConverter +from .form_data_converter import FormDataConverter +from .downloader import Downloader +from .api_http_connector import APIHTTPConnector +from .api_response import APIResponse +from .constants import Constants +from .utility import Utility +from .datatype_converter import DataTypeConverter +from .stream_wrapper import StreamWrapper +from .choice import Choice +from .header_param_validator import HeaderParamValidator +from .module_fields_handler import ModuleFieldsHandler diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/api_http_connector.py b/zohocrmsdk/src/com/zoho/crm/api/util/api_http_connector.py new file mode 100755 index 0000000..a890b76 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/api_http_connector.py @@ -0,0 +1,177 @@ +try: + import requests + import logging + import json + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + +except Exception: + from .constants import Constants + import requests + import logging + import json + from ..initializer import Initializer + + +class APIHTTPConnector(object): + """ + This module is to make HTTP connections, trigger the requests and receive the response. + """ + + def __init__(self): + + """ + Creates an APIHTTPConnector class instance with the specified parameters. + """ + + self.url = None + self.request_method = None + self.headers = dict() + self.parameters = dict() + self.request_body = None + self.content_type = None + self.file = False + + def add_header(self, header_name, header_value): + + """ + The method to add API request header name and value. + + Parameters: + header_name (str) : A String containing the API request header name. + header_value (str) : A String containing the API request header value. + """ + + self.headers[header_name] = header_value + + def add_param(self, param_name, param_value): + + """ + The method to add API request parameter name and value. + + Parameters: + param_name (str) : A String containing the API request parameter name. + param_value (str) : A String containing the API request parameter value. + """ + + self.parameters[param_name] = param_value + + def fire_request(self, converter_instance): + + """ + This method makes a request to the Zoho CRM Rest API + + Parameters: + converter_instance (Converter) : A Converter class instance to call append_to_request method. + + Returns: + requests.Response : An object of requests.Response + """ + + response = None + proxies = None + logger = logging.getLogger('SDKLogger') + initializer = Initializer.get_initializer() + sdk_config = initializer.sdk_config + read_timeout = sdk_config.get_read_timeout() + connect_timeout = sdk_config.get_connect_timeout() + + if read_timeout is None and connect_timeout is None: + timeout = None + elif read_timeout is None: + timeout = connect_timeout + elif connect_timeout is None: + timeout = read_timeout + else: + timeout = (connect_timeout, read_timeout) + + if self.content_type is not None: + self.set_content_type_header() + + if initializer.request_proxy is not None: + request_proxy = initializer.request_proxy + auth = "" + + if request_proxy is not None: + auth = request_proxy.get_user() + ':' + request_proxy.get_password() + '@' + + if Constants.HTTP in request_proxy.get_host(): + host_split = request_proxy.get_host().split('://') + scheme = host_split[0] + proxies = { + scheme: scheme + '://' + auth + host_split[1] + ':' + str(request_proxy.get_port()) + } + + else: + proxies = { + Constants.HTTP: Constants.HTTP + '://' + auth + request_proxy.get_host() + ':' + str( + request_proxy.get_port()), + Constants.HTTPS: Constants.HTTPS + '://' + auth + request_proxy.get_host() + ':' + str( + request_proxy.get_port()) + } + + logger.info(self.proxy_log(request_proxy)) + + logger.info(self.__str__()) + + if self.request_method == Constants.REQUEST_METHOD_GET: + response = requests.get(url=self.url, headers=self.headers, params=self.parameters, allow_redirects=False, + proxies=proxies, timeout=timeout) + + elif self.request_method == Constants.REQUEST_METHOD_PUT: + data = None + if self.request_body is not None: + data = converter_instance.append_to_request(self, self.request_body) + + response = requests.put(url=self.url, data=data, params=self.parameters, headers=self.headers, + allow_redirects=False, proxies=proxies) + + elif self.request_method == Constants.REQUEST_METHOD_POST: + data = None + if self.request_body is not None: + data = converter_instance.append_to_request(self, self.request_body) + + if self.file: + response = requests.post(url=self.url, files=data, headers=self.headers, allow_redirects=False, data={}, + proxies=proxies) + + else: + response = requests.post(url=self.url, data=data, params=self.parameters, headers=self.headers, + allow_redirects=False, proxies=proxies) + + elif self.request_method == Constants.REQUEST_METHOD_PATCH: + data = None + if self.request_body is not None: + data = converter_instance.append_to_request(self, self.request_body) + + response = requests.patch(url=self.url, data=data, headers=self.headers, params=self.parameters, + allow_redirects=False, proxies=proxies) + + elif self.request_method == Constants.REQUEST_METHOD_DELETE: + response = requests.delete(url=self.url, headers=self.headers, params=self.parameters, + allow_redirects=False, proxies=proxies) + + return response + + def __str__(self): + request_headers = self.headers.copy() + request_headers[Constants.AUTHORIZATION] = Constants.CANT_DISCLOSE + + return self.request_method + ' - ' + Constants.URL + ' = ' + self.url + ' , ' + Constants.HEADERS + ' = ' + \ + json.dumps(request_headers) \ + + ' , ' + Constants.PARAMS + ' = ' + json.dumps(self.parameters) + '.' + + @staticmethod + def proxy_log(request_proxy): + proxy_details = Constants.PROXY_SETTINGS + Constants.PROXY_HOST + str( + request_proxy.get_host()) + ', ' + Constants.PROXY_PORT + str(request_proxy.get_port()) + if request_proxy.user is not None: + proxy_details = proxy_details + ', ' + Constants.PROXY_USER + str(request_proxy.get_user()) + + return proxy_details + + def set_content_type_header(self): + for url in Constants.SET_CONTENT_TYPE_HEADER: + if url in self.url: + self.headers[Constants.CONTENT_TYPE_HEADER] = self.content_type + return diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/api_response.py b/zohocrmsdk/src/com/zoho/crm/api/util/api_response.py new file mode 100755 index 0000000..2f93cef --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/api_response.py @@ -0,0 +1,54 @@ + +class APIResponse(object): + + """ + This class is the common API response object. + """ + + def __init__(self, headers, status_code, object): + + """ + Creates an APIResponse class instance with the specified parameters. + + Parameters: + headers (dict) : A dict containing the API response headers. + status_code (int) : An integer containing the API response HTTP status code. + object (object) : An object containing the API response class instance. + """ + + self.__headers = headers + self.__status_code = status_code + self.__object = object + + def get_headers(self): + + """ + This is a getter method to get API response headers. + + Returns: + dict: A dict representing the API response headers. + """ + + return self.__headers + + def get_status_code(self): + + """ + This is a getter method to get the API response HTTP status code. + + Returns: + int: An integer representing the API response HTTP status code. + """ + + return self.__status_code + + def get_object(self): + + """ + This method to get an API response class instance. + + Returns: + object: An object containing the API response class instance. + """ + + return self.__object diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/choice.py b/zohocrmsdk/src/com/zoho/crm/api/util/choice.py new file mode 100755 index 0000000..71bf36e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/choice.py @@ -0,0 +1,13 @@ + +class Choice(object): + + """ + Common Class to provide or obtain a value, when there are multiple supported values. + """ + + def __init__(self, value): + self.__value = value + + def get_value(self): + return self.__value + diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/common_api_handler.py b/zohocrmsdk/src/com/zoho/crm/api/util/common_api_handler.py new file mode 100755 index 0000000..bb62f6c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/common_api_handler.py @@ -0,0 +1,481 @@ +try: + import json + import platform + import urllib3 + import logging + from zohocrmsdk.src.com.zoho.crm.api.util.api_http_connector import APIHTTPConnector + from zohocrmsdk.src.com.zoho.crm.api.util.json_converter import JSONConverter + from zohocrmsdk.src.com.zoho.crm.api.util.xml_converter import XMLConverter + from zohocrmsdk.src.com.zoho.crm.api.util.form_data_converter import FormDataConverter + from zohocrmsdk.src.com.zoho.crm.api.util.downloader import Downloader + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.api_response import APIResponse + from zohocrmsdk.src.com.zoho.crm.api.header_map import HeaderMap + from zohocrmsdk.src.com.zoho.crm.api.header import Header + from zohocrmsdk.src.com.zoho.crm.api.parameter_map import ParameterMap + from zohocrmsdk.src.com.zoho.crm.api.param import Param + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + +except Exception: + import json + import platform + import urllib3 + import logging + from .api_http_connector import APIHTTPConnector + from .json_converter import JSONConverter + from .constants import Constants + from .api_response import APIResponse + from ..header_map import HeaderMap + from ..header import Header + from ..parameter_map import ParameterMap + from ..param import Param + from ..exception import SDKException + + +class CommonAPIHandler(object): + """ + This class to process the API request and its response. + Construct the objects that are to be sent as parameters or request body with the API. + The Request parameter, header and body objects are constructed here. + Process the response JSON and converts it to relevant objects in the library. + """ + logger = logging.getLogger('SDKLogger') + + def __init__(self): + + self.__api_path = None + self.__header = HeaderMap() + self.__param = ParameterMap() + self.__request = None + self.__http_method = None + self.__module_api_name = None + self.__content_type = None + self.__category_method = None + self.__mandatory_checker = None + + def set_content_type(self, content_type): + """ + The method to set the Content Type + + Parameters: + content_type(str): A string containing the Content Type + """ + + self.__content_type = content_type + + def set_api_path(self, api_path): + """ + The method to set the API Path + + Parameters: + api_path(str) : A string containing the API Path + """ + + self.__api_path = api_path + + def add_param(self, param_instance, param_value): + + """ + The method to add an API request parameter. + + Parameters: + param_instance (Param) : A Param instance containing the API request parameter. + param_value (object) : An object containing the API request parameter value. + """ + + if param_value is None: + return + + if self.__param is None: + self.__param = ParameterMap() + + self.__param.add(param_instance, param_value) + + def add_header(self, header_instance, header_value): + """ + The method to add an API request header. + + Parameters: + header_instance (Header) : A Header instance containing the API request header. + header_value (object) : An object containing the API request header value. + """ + + if header_value is None: + return + + if self.__header is None: + self.__header = HeaderMap() + + self.__header.add(header_instance, header_value) + + def set_param(self, param): + """ + The method to set the API request parameter map. + + Parameters: + param(ParameterMap) : A ParameterMap class instance containing the API request parameters + """ + + if param is None: + return + + if self.__param.request_parameters is not None and self.__param.request_parameters: + self.__param.request_parameters.update(param.request_parameters) + else: + self.__param = param + + def get_module_api_name(self): + """ + The method to get the Module API Name + + Returns: + string: A string representing the Module API Name + """ + + return self.__module_api_name + + def set_module_api_name(self, module_api_name): + """ + The method to set the Module API Name + + Parameters: + module_api_name(str): A string containing the Module API Name + """ + + self.__module_api_name = module_api_name + + def set_header(self, header): + """ + The method to set the API request header map. + + Parameters: + header(HeaderMap): A HeaderMap class instance containing the API request headers + """ + + if header is None: + return + + if self.__header.request_headers is not None and self.__header.request_headers: + self.__header.request_headers.update(header.request_headers) + else: + self.__header = header + + def set_request(self, request): + """ + The method to set the request instance. + + Parameters: + request(object): An object containing the request body + + """ + self.__request = request + + def set_http_method(self, http_method): + """ + The method to set the HTTP Method + + Parameters: + http_method(str): A string containing the HTTP method. + """ + + self.__http_method = http_method + + def api_call(self, class_name, encode_type): + + """ + The method to construct API request and response details. To make the Zoho CRM API calls. + + Parameters: + class_name(str): A str containing the method return type. + encode_type(str): A str containing the expected API response content type. + + Returns: + APIResponse: An instance of APIResponse representing the Zoho CRM API response instance + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + if Initializer.get_initializer() is None: + raise SDKException(code=Constants.SDK_UNINITIALIZATION_ERROR, + message=Constants.SDK_UNINITIALIZATION_MESSAGE) + + connector = APIHTTPConnector() + try: + self.set_api_url(connector) + except SDKException as e: + CommonAPIHandler.logger.error(Constants.SET_API_URL_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.SET_API_URL_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + connector.request_method = self.__http_method + connector.content_type = self.__content_type + + if self.__header is not None and len(self.__header.request_headers) > 0: + connector.headers = self.__header.request_headers + + if self.__param is not None and len(self.__param.request_parameters) > 0: + connector.parameters = self.__param.request_parameters + + try: + Initializer.get_initializer().token.authenticate(connector) + except SDKException as e: + CommonAPIHandler.logger.info(Constants.AUTHENTICATION_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.AUTHENTICATION_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + convert_instance = None + + if self.__content_type is not None and \ + self.__http_method in [Constants.REQUEST_METHOD_PATCH, Constants.REQUEST_METHOD_POST, + Constants.REQUEST_METHOD_PUT]: + try: + convert_instance = self.get_converter_class_instance(self.__content_type.lower()) + request = convert_instance.form_request(self.__request, self.__request.__class__.__module__, None, None) + except SDKException as e: + CommonAPIHandler.logger.info(Constants.FORM_REQUEST_EXCEPTION + e.__str__()) + raise e + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.FORM_REQUEST_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + connector.request_body = request + + try: + connector.headers[ + Constants.ZOHO_SDK] = platform.system() + "/" + \ + platform.release() + "/python-7.0/" + platform.python_version() + ":" + \ + Constants.SDK_VERSION + response = connector.fire_request(convert_instance) + return_object = None + + if Constants.CONTENT_TYPE in response.headers: + content_type = response.headers[Constants.CONTENT_TYPE] + + if ";" in content_type: + content_type = content_type.rpartition(";")[0] + + convert_instance = self.get_converter_class_instance(str(content_type).lower()) + return_object = convert_instance.get_wrapped_response(response, class_name) + + else: + CommonAPIHandler.logger.info(response.__str__()) + + return APIResponse(response.headers, response.status_code, return_object) + except SDKException as e: + CommonAPIHandler.logger.info(Constants.API_CALL_EXCEPTION + e.__str__()) + except Exception as e: + sdk_exception = SDKException(cause=e) + CommonAPIHandler.logger.error(Constants.API_CALL_EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + def get_converter_class_instance(self, encode_type): + + """ + This method to get a Converter class instance. + :param encode_type: A str containing the API response content type. + :return: A Converter class instance. + """ + + switcher = { + + "application/json": JSONConverter(self), + + "text/plain": JSONConverter(self), + + "application/ld+json": JSONConverter(self), + + "application/xml": XMLConverter(self), + + "text/xml": XMLConverter(self), + + "multipart/form-data": FormDataConverter(self), + + "application/x-download": Downloader(self), + + "image/png": Downloader(self), + + "image/jpeg": Downloader(self), + + "image/gif": Downloader(self), + + "image/tiff": Downloader(self), + + "image/svg+xml": Downloader(self), + + "image/bmp": Downloader(self), + + "image/webp": Downloader(self), + + "text/html": Downloader(self), + + "text/css": Downloader(self), + + "text/javascript": Downloader(self), + + "text/calendar": Downloader(self), + + "application/zip": Downloader(self), + + "application/pdf": Downloader(self), + + "application/java-archive": Downloader(self), + + "application/javascript": Downloader(self), + + "application/xhtml+xml": Downloader(self), + + "application/x-bzip": Downloader(self), + + "application/msword": Downloader(self), + + "application/vnd.openxmlformats-officedocument.wordprocessingml.document": Downloader(self), + + "application/gzip": Downloader(self), + + "application/x-httpd-php": Downloader(self), + + "application/vnd.ms-powerpoint": Downloader(self), + + "application/vnd.rar": Downloader(self), + + "application/x-sh": Downloader(self), + + "application/x-tar": Downloader(self), + + "application/vnd.ms-excel": Downloader(self), + + "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": Downloader(self), + + "application/x-7z-compressed": Downloader(self), + + "audio/mpeg": Downloader(self), + + "audio/x-ms-wma": Downloader(self), + + "audio/vnd.rn-realaudio": Downloader(self), + + "audio/x-wav": Downloader(self), + + "audio/3gpp": Downloader(self), + + "audio/3gpp2": Downloader(self), + + "video/mpeg": Downloader(self), + + "video/mp4": Downloader(self), + + "video/webm": Downloader(self), + + "video/3gpp": Downloader(self), + + "video/3gpp2": Downloader(self), + + "font/ttf": Downloader(self), + + "text/csv": Downloader(self), + + "application/octet-stream": Downloader(self), + } + + return switcher.get(encode_type, None) + + def set_api_url(self, connector): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + api_path = '' + + if Constants.HTTP in self.__api_path: + if Constants.CONTENT_API_URL in self.__api_path: + api_path = Initializer.get_initializer().environment.file_upload_url + + try: + url_parse = urllib3.util.parse_url(self.__api_path) + path = url_parse.path + except Exception as ex: + raise SDKException(code=Constants.INVALID_URL_ERROR, cause=ex) + + api_path = api_path + path + else: + if str(self.__api_path)[:1].__eq__('/'): + self.__api_path = self.__api_path[1:] + + api_path = api_path + self.__api_path + else: + api_path = Initializer.get_initializer().environment.url + api_path = api_path + self.__api_path + + connector.url = api_path + + def get_mandatory_checker(self): + """ + The method to get the Mandatory Checker + + Returns: + bool: A boolean representing the Mandatory Checker. + """ + return self.__mandatory_checker + + def set_mandatory_checker(self, mandatory_checker): + """ + The method to set the Mandatory Checker + + Parameters: + mandatory_checker(bool): A boolean containing the Mandatory Checker. + """ + + self.__mandatory_checker = mandatory_checker + + def get_http_method(self): + """ + The method to get the HTTP Method + + Returns: + string: A string representing the HTTP Method + """ + + return self.__http_method + + def get_category_method(self): + """ + The method to get the Category Method + + Returns: + string: A string representing the Category method. + """ + + return self.__category_method + + def set_category_method(self, category_method): + """ + The method to set the Category Method + + Parameters: + category_method(str): A string containing the Category method. + """ + + self.__category_method = category_method + + def get_api_path(self): + """ + The method to get the API Path + + Returns: + string: A string representing the API Path + """ + return self.__api_path diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/constants.py b/zohocrmsdk/src/com/zoho/crm/api/util/constants.py new file mode 100644 index 0000000..790f8d0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/constants.py @@ -0,0 +1,777 @@ +from datetime import time, datetime, date + + +class Constants(object): + """ + This class uses the SDK constants name reference. + """ + + DATA_TYPE_ERROR = "DATA TYPE ERROR" + + ERROR = "error" + + REQUEST_METHOD_GET = "GET" + + REQUEST_METHOD_POST = "POST" + + REQUEST_METHOD_PUT = "PUT" + + REQUEST_METHOD_DELETE = "DELETE" + + GIVEN_VALUE = "given-value" + + REQUEST_METHOD_PATCH = 'PATCH' + + OAUTH_HEADER_PREFIX = "Zoho-oauthtoken " + + AUTHORIZATION = "Authorization" + + API_NAME = "api_name" + + PHOTO = "photo" + + API_VERSION = "v7" + + CRM = "crm" + + INPUT_ERROR = "INPUT_ERROR" + + LOGGER_LEVELS = { + "CRITICAL": "CRITICAL", + "ERROR": "ERROR", + "WARNING": "WARNING", + "INFO": "INFO", + "DEBUG": "DEBUG", + "NOTSET": "NOTSET" + } + INVENTORY_MODULES_ITEMS = ["invoiced_items", "quoted_items", "purchase_items", "ordered_items"] + + DEFAULT_MODULE_NAME_VS_API_NAME = { + + "leads": "Leads", + + "contacts": "Contacts", + + "accounts": "Accounts", + + "deals": "Deals", + + "tasks": "Tasks", + + "events": "Events", + + "activities": "Activities", + + "calls": "Calls", + + "products": "Products", + + "quotes": "Quotes", + + "sales_orders": "Sales_Orders", + + "purchase_orders": "Purchase_Orders", + + "invoices": "Invoices", + + "campaigns": "Campaigns", + + "vendors": "Vendors", + + "price_books": "Price_Books", + + "cases": "Cases", + + "solutions": "Solutions", + + "visits": "Visits", + + "approvals": "Approvals", + + "notes": "Notes", + + "attachments": "Attachments", + + "actions_performed": "Actions_Performed", + + } + + PROXY_SETTINGS = "Proxy settings - " + + PROXY_HOST = "Host: " + + PROXY_PORT = "Port: " + + PROXY_USER = "User: " + + PROXY_DOMAIN = "Domain: " + + MERGE_OBJECT = "MERGE_OBJECT" + + GET_TOKEN_BY_USER_NAME_ERROR = "Exception in getToken() - OAuthToken : Given user_name token details not found, Please give required item" + + OAUTH_TOKEN_FIELDS = ["client_id", "client_secret", "redirect_url", "grant_token", "refresh_token", "access_token", + "expires_in", "user_signature", "id"] + + TOKEN_BY_ID_FILE_ERROR = "Exception in FileStore : Given Id not found" + + GET_TOKEN_BY_ID_FILE_ERROR = "Exception in getTokenById - FileStore : Given ID is invalid" + + MYSQL_TABLE_NAME = "oauthtoken" + + SWITCH_USER_ERROR = "SWITCH USER ERROR" + + LOGGER_INITIALIZATION_ERROR = "Exception in Logger Initialization : " + + INVALID_ID_MSG = "The given id seems to be invalid." + + RESOURCE_PATH_INVALID_ERROR_MESSAGE = "Resource Path MUST be a valid directory." + + API_MAX_RECORDS_MSG = "Cannot process more than 100 records at a time." + + INVALID_DATA = "INVALID_DATA" + + CODE_SUCCESS = "SUCCESS" + + STATUS_SUCCESS = "success" + + STATUS_ERROR = "error" + + GRANT_TYPE = "grant_type" + + GRANT_TYPE_AUTH_CODE = "authorization_code" + + ACCESS_TOKEN = "access_token" + + EXPIRES_IN = "expires_in" + + EXPIRES_IN_SEC = "expires_in_sec" + + REFRESH_TOKEN = "refresh_token" + + CLIENT_ID = "client_id" + + CLIENT_SECRET = "client_secret" + + REDIRECT_URI = "redirect_uri" + + REDIRECT_URL = "redirect_url" + + OBJECT = "Object" + + DATA_TYPE = { + "String": str, + "List": list, + "Integer": int, + "HashMap": dict, + "Map": dict, + "Long": int, + "Double": float, + "Float": float, + "DateTime": datetime, + "Date": date, + "Boolean": bool, + "LocalTime": time + } + + OBJECT_KEY = "object" + + PHOTO_SUPPORTED_MODULES = ["leads", "contacts", "accounts", "products", "vendors"] + + GIVEN_LENGTH = "given-length" + + ZOHO_SDK = "X-ZOHO-SDK" + + SDK_VERSION = "1.0.0" + + CONTENT_DISPOSITION = "Content-Disposition" + + TOKEN_ERROR = "TOKEN ERROR" + + SAVE_TOKEN_ERROR = "Exception in saving tokens" + + INVALID_CLIENT_ERROR = "INVALID CLIENT ERROR" + + ERROR_KEY = 'error' + + GET_TOKEN_ERROR = "Exception in getting access token" + + MYSQL_HOST = "localhost" + + MYSQL_DATABASE_NAME = "zohooauth" + + MYSQL_USER_NAME = "root" + + MYSQL_PORT_NUMBER = "3306" + + GET_TOKEN_DB_ERROR = "Exception in getToken - DBStore" + + TOKEN_STORE = "TOKEN_STORE" + + DELETE_TOKEN_DB_ERROR = "Exception in delete_token - DBStore" + + SAVE_TOKEN_DB_ERROR = "Exception in save_token - DBStore" + + USER_NAME = "user_name" + + GRANT_TOKEN = "grant_token" + + EXPIRY_TIME = "expiry_time" + + GET_TOKEN_FILE_ERROR = "Exception in get_token - FileStore" + + SAVE_TOKEN_FILE_ERROR = "Exception in save_token - FileStore" + + DELETE_TOKEN_FILE_ERROR = "Exception in delete_token - FileStore" + + TYPE = "type" + + STREAM_WRAPPER_CLASS_PATH = 'zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper' + + FIELD = "field" + + NAME = "name" + + INDEX = "index" + + CLASS = "class" + + ACCEPTED_TYPE = "accepted_type" + + GIVEN_TYPE = "given_type" + + TYPE_ERROR = "TYPE ERROR" + + VALUES = "values" + + ACCEPTED_VALUES = "accepted_values" + + UNACCEPTED_VALUES_ERROR = "UNACCEPTED VALUES ERROR" + + MIN_LENGTH = "min-length" + + MINIMUM_LENGTH = "minimum-length" + + MINIMUM_LENGTH_ERROR = "MINIMUM LENGTH ERROR" + + UNIQUE = "unique" + + FIRST_INDEX = "first-index" + + NEXT_INDEX = "next-index" + + UNIQUE_KEY_ERROR = "UNIQUE KEY ERROR" + + MAX_LENGTH = "max-length" + + MAXIMUM_LENGTH = "maximum-length" + + MAXIMUM_LENGTH_ERROR = "MAXIMUM LENGTH ERROR" + + REGEX = "regex" + + INSTANCE_NUMBER = "instance-number" + + REGEX_MISMATCH_ERROR = "REGEX MISMATCH ERROR" + + READ_ONLY = "read-only" + + IS_KEY_MODIFIED = 'is_key_modified' + + REQUIRED = "required" + + REQUIRED_IN_UPDATE = "required-in-update" + + PRIMARY = "primary" + + MANDATORY_VALUE_ERROR = "MANDATORY VALUE ERROR" + + MANDATORY_VALUE_NULL_ERROR = "MANDATORY VALUE NULL ERROR" + + MANDATORY_KEY_ERROR = "Value missing or None for mandatory key(s): " + + MANDATORY_KEY_NULL_ERROR = "Null Value for mandatory key : " + + SET_KEY_MODIFIED = "set_key_modified" + + LIST_NAMESPACE = "List" + + MAP_NAMESPACE = "Map" + + HASH_MAP = "HashMap" + + STRUCTURE_NAME = "structure_name" + + KEYS = "keys" + + INTERFACE = "interface" + + RECORD_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Record" + + RECORD_TYPE = "zohocrmsdk.src.com.zoho.crm.api.record.record.Record" + + INVENTORY_LINE_ITEMS = "zohocrmsdk.src.com.zoho.crm.api.record.InventoryLineItems" + + PRICING_DETAILS_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.PricingDetails" + + COMMENT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Comment" + + FIELD_FILE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.FileDetails" + + REMIND_AT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.RemindAt" + + CONSENT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Consent" + + LINE_TAX_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.LineTax" + + TAX_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Tax" + + PRODUCTS = "Products" + + TAX = "TAX" + + TERRITORY = "Territory" + + REMINDER_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Reminder" + + TERRITORY_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.Territory" + + IMAGE_UPLOAD_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.ImageUpload" + + ATTACHMENTS_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment" + + RECURRING_ACTIVITY_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.RecurringActivity" + + PARTICIPANTS = "zohocrmsdk.src.com.zoho.crm.api.record.Participants" + + PACKAGE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api." + + USER_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser" + + MODULE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.modules.Modules" + + LAYOUT_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts" + + CHOICE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.util.Choice" + + KEY_VALUES = "key_values" + + RECORD_CLASS_NAME = "Record" + + KEY_MODIFIED = "key_modified" + + COMMENTS = "Comments" + + CLASSES = "classes" + + LOGFILE_NAME = "sdk_logs.log" + + USER = "user" + + EXPECTED_TYPE = "expected-type" + + USER_AGENT = "Mozilla/5.0" + + USER_AGENT_KEY = "user-agent" + + AT = '@' + + EXPECTED_TOKEN_TYPES = 'REFRESH, GRANT' + + INITIALIZATION_ERROR = "INITIALIZATION ERROR" + + ENVIRONMENT = "environment" + + STORE = "store" + + TOKEN = "token" + + SDK_CONFIG = "sdk_config" + + USER_PROXY = "proxy" + + JSON_DETAILS_FILE_PATH = 'json_details.json' + + EMAIL = "email" + + USER_SIGNATURE_ERROR = "USERSIGNATURE ERROR" + + USER_INITIALIZATION_ERROR = "Error during User Initialization" + + EMAIL_REGEX = '^[_a-z0-9-]+(.[_a-z0-9-]+)*@[a-z0-9-]+(.[a-z0-9-]+)*(.[a-z]{2,4})$' + + STRING = "String" + + TOKEN_TYPE = "token_type" + + GRANT = "GRANT" + + REFRESH = "REFRESH" + + CONTENT_TYPE = 'Content-Type' + + STRING_NAMESPACE = 'String' + + BOOLEAN_NAMESPACE = 'Boolean' + + INTEGER_NAMESPACE = 'Integer' + + LONG_NAMESPACE = 'Long' + + DOUBLE_NAMESPACE = 'Float' + + DATE_NAMESPACE = 'Date' + + DATETIME_NAMESPACE = 'DateTime' + + DISCOUNT = "DISCOUNT" + + LINEITEM_PRODUCT = "zohocrmsdk.src.com.zoho.crm.api.record.LineItemProduct" + + FILE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper" + + KEYS_TO_SKIP = ['Created_Time', 'Modified_Time', 'Created_By', 'Modified_By', 'Tag'] + + PRODUCT_DETAILS = "Product_Details" + + PRICING_DETAILS = "Pricing_Details" + + PARTICIPANT_API_NAME = "Participants" + + INVENTORY_MODULES = ['invoices', 'sales_orders', 'purchase_orders', 'quotes'] + + PRICE_BOOKS = "price_books" + + EVENTS = "events" + + CALLS = "calls" + + CALL_DURATION = "call_duration" + + SOLUTIONS = "solutions" + + CASES = "cases" + + ACTIVITIES = "activities" + + LAYOUT = "Layout" + + SUBFORM = "subform" + + LOOKUP = "lookup" + + SE_MODULE = "se_module" + + MODULEDETAILS = 'moduleDetails' + + MODULEPACKAGENAME = "modulePackageName" + + UNDERSCORE = "_" + + RELATED_LISTS = "Related_Lists" + + FIELD_DETAILS_DIRECTORY = "resources" + + NO_CONTENT_STATUS_CODE = 204 + + NOT_MODIFIED_STATUS_CODE = 304 + + HREF = "href" + + API_EXCEPTION = "API_EXCEPTION" + + FIELDS_LAST_MODIFIED_TIME = "FIELDS-LAST-MODIFIED-TIME" + + LINE_TAX = "$line_tax" + + CANT_DISCLOSE = " ## can't disclose ## " + + URL = "URL" + + HEADERS = "HEADERS" + + PARAMS = "PARAMS" + + INITIALIZATION_SUCCESSFUL = "Initialization successful " + + INITIALIZATION_SWITCHED = "Initialization switched " + + IN_ENVIRONMENT = " in Environment : " + + FOR_EMAIL_ID = "for Email Id : " + + REFRESH_TOKEN_MESSAGE = "Access Token has expired. Hence refreshing." + + RESOURCE_PATH_ERROR = "EMPTY_RESOURCE_PATH" + + RESOURCE_PATH_ERROR_MESSAGE = "Resource Path MUST NOT be None/empty." + + SET_CONTENT_TYPE_HEADER = ["/crm/bulk/v7/read", "/crm/bulk/v7/write", "/crm/v7/__zia_org_enrichment", "crm/v7/__zia_people_enrichment"] + + CONTENT_TYPE_HEADER = "Content-Type" + + LIST_KEY = "List" + + ATTACHMENT_ID = "attachment_id" + + FILE_ID = "file_id" + + PHOTO_UPLOAD_ERROR_MESSAGE = "The given module is not supported in API." + + INVALID_MODULE = "INVALID_MODULE" + + MULTI_SELECT_LOOKUP = "multiselectlookup" + + MULTI_USER_LOOKUP = "multiuserlookup" + + TERRITORIES = "territories" + + GENERATED_TYPE = "generated_type" + + GENERATED_TYPE_CUSTOM = "custom" + + UPLOAD_PHOTO_UNSUPPORTED_MESSAGE = "Photo Upload Operation is not supported by the module: " + + SDK_MODULE_METADATA = "SDK-MODULE-METADATA" + + INVALID_MODULE_API_NAME_ERROR = "INVALID MODULE API NAME ERROR" + + PROVIDE_VALID_MODULE_API_NAME = "PROVIDE VALID MODULE API NAME: " + + UPLOAD_PHOTO_UNSUPPORTED_ERROR = "UPLOAD PHOTO UNSUPPORTED MODULE" + + DELETE_FIELD_FILE_ERROR = "Exception in deleting Current User Fields file : " + + DELETE_FIELD_FILES_ERROR = "Exception in deleting all Fields files : " + + DELETE_MODULE_FROM_FIELDFILE_ERROR = "Exception in deleting module from Fields file : " + + FILE_BODY_WRAPPER = 'FileBodyWrapper' + + EXCEPTION_IS_KEY_MODIFIED = "Exception in calling is_key_modified : " + + EXCEPTION_SET_KEY_MODIFIED = "Exception in calling set_key_modified : " + + SET_API_URL_EXCEPTION = "Exception in setting API URL : " + + AUTHENTICATION_EXCEPTION = "Exception in authenticating current request : " + + FORM_REQUEST_EXCEPTION = "Exception in forming request body : " + + API_CALL_EXCEPTION = "Exception in current API call execution : " + + HTTP = "http" + + HTTPS = "https" + + CONTENT_API_URL = "content.zohoapis.com" + + EXCEPTION = "Exception" + + MODULE = "module" + + REQUEST_CATEGORY_READ = "READ" + + REQUEST_CATEGORY_CREATE = "CREATE" + + REQUEST_CATEGORY_UPDATE = "UPDATE" + + ID = "id" + + CODE = "code" + + STATUS = "status" + + MESSAGE = "message" + + INVALID_URL_ERROR = "Invalid URL Error" + + REQUEST_CATEGORY_ACTION = "ACTION" + + SKIP_MANDATORY = "skip-mandatory" + + FORMULA = "formula" + ROLLUP_SUMMARY = "rollup_summary" + + PICKLIST = "picklist" + + ACCOUNTS = "accounts" + + PRIMARY_KEY_ERROR = "Value missing or None for required key(s) : " + + REFRESH_SINGLE_MODULE_FIELDS_ERROR = "Exception in refreshing fields of module : " + + REFRESH_ALL_MODULE_FIELDS_ERROR = "Exception in refreshing fields of all modules : " + + GET_TOKENS_DB_ERROR = "Exception in get_tokens - DBStore" + + GET_TOKEN_DB_ERROR1 = "Exception in DBStore : Given user authentication details not found." + + DELETE_TOKENS_DB_ERROR = "Exception in delete_tokens - DBStore" + + GET_TOKENS_FILE_ERROR = "Exception in get_tokens - FileStore" + + GENERATE_TOKEN_ID_ERROR = "Exception in generateId() - DBStore" + + GET_TOKEN_BY_ID_DB_ERROR = "Exception in findTokenById() - DBStore : Given Id is invalid" + + DELETE_TOKENS_FILE_ERROR = "Exception in delete_tokens - FileStore" + + SDK_UNINITIALIZATION_ERROR = "SDK UNINITIALIZED ERROR" + + SDK_UNINITIALIZATION_MESSAGE = "SDK is UnInitialized" + + INITIALIZATION_EXCEPTION = "Exception in initialization" + + SWITCH_USER_EXCEPTION = "Exception in switching user" + + AUTO_REFRESH_FIELDS_ERROR_MESSAGE = "auto_refresh_fields MUST NOT be None." + + HEADER_NONE_ERROR = "NONE HEADER ERROR" + + PRODUCT_NAME = "Product_Name" + + HEADER_INSTANCE_NONE_ERROR = "Header Instance MUST NOT be None" + + PARAM_INSTANCE_NONE_ERROR = "Param Instance MUST NOT be None" + + HEADER_NAME_NONE_ERROR = "NONE HEADER NAME ERROR" + + HEADER_NAME_NULL_ERROR_MESSAGE = "Header Name MUST NOT be null" + + NONE_VALUE_ERROR_MESSAGE = " MUST NOT be None" + + PARAMETER_NONE_ERROR = "NONE PARAMETER ERROR" + + PARAM_NAME_NONE_ERROR = "NONE PARAM NAME ERROR" + + PARAM_NAME_NONE_ERROR_MESSAGE = "Param Name MUST NOT be None" + + USER_PROXY_ERROR = "USERPROXY ERROR" + + HOST_ERROR_MESSAGE = "Host MUST NOT be None" + + PORT_ERROR_MESSAGE = "Port MUST NOT be None" + + USER_ERROR_MESSAGE = "User MUST NOT be None/empty" + + UNSUPPORTED_IN_API = "API UNSUPPORTED OPERATION" + + UNSUPPORTED_IN_API_MESSAGE = " Operation is not supported by API" + + NULL_VALUE = "null" + + NOTES = "notes" + + ATTACHMENTS = "$attachments" + + JSON_FILE_EXTENSION = ".json" + + FILE_ERROR = "file_error" + + FILE_DOES_NOT_EXISTS = "file does not exists" + + CONSENT_LOOKUP = "consent_lookup" + + JSON_DETAILS_ERROR = "ERROR IN READING JSONDETAILS FILE" + + INVALID_TOKEN_ERROR = "INVALID TOKEN ERROR" + + NO_ACCESS_TOKEN_ERROR = "ACCESS TOKEN IS NOT PRESENT IN RESPONSE" + + CLIENT_ID_NULL_ERROR_MESSAGE = "ClientID MUST NOT be null" + + CLIENT_SECRET_NULL_ERROR_MESSAGE = "ClientSecret MUST NOT be null" + + REQUEST_PROXY_ERROR_MESSAGE = "request_proxy must be instance of Request Proxy" + + USER_SIGNATURE_ERROR_MESSAGE = "user must be instance of userSignature." + + ENVIRONMENT_ERROR_MESSAGE = "environment must be instance of Environment." + + SDK_CONFIG_ERROR_MESSAGE = "sdk_config must be instance of sdkConfig." + + TOKEN_ERROR_MESSAGE = "token must be instance of Token." + + STORE_ERROR_MESSAGE = "store must be instance of Store." + + COUNT = "count" + + OWNER_LOOKUP = "ownerlookup" + + TOKEN_FILE = "sdk_tokens.txt" + + LOG_FILE_NAME = "sdk_logs.log" + + SKIP_MODULES = ["deals"] + + PYTHON = "python_" + + OAUTH_MANDATORY_KEYS = ["grant_token", "refresh_token", "id", "access_token"] + + OAUTH_MANDATORY_KEYS1 = ["client_id", "client_secret"] + + OAUTH_MANDATORY_KEYS2 = ["grant_token", "refresh_token"] + + INIT_MANDATORY_KEYS = ["token", "user"] + + ACCESS_TOKEN_USING_REFRESH_TOKEN_MESSAGE = "Access token can be generated by refresh token" + + ACCESS_TOKEN_USING_GRANT_TOKEN_MESSAGE = "Access token can be generated by grant token." + + REVOKE_URL = "/revoke" + + REFRESH_TOKEN_REMOVED = " Refresh token revoked successfully." + + TOKEN_NOT_FOUND = " No tokens exist for the given user-id." + + REVOKE_TOKEN_ERROR = "Exception while revoke the refresh token." + + GET_TOKEN_FILE_ERROR1 = "Exception in FileStore : Given user authentication details not found." + + API_DOMAIN = "api_domain" + + DEVELOPER = "developer" + + SANDBOX = "sandbox" + + DATACENTER_ERROR = "DATACENTER_ERROR" + + ENVIRONMENT_ERROR = "The given DataCenter config not valid. Please check the domain URL" + + US_DATACENTER = ["https://www.zohoapis.com", "https://sandbox.zohoapis.com", "https://developer.zohoapis.com", + "https://accounts.zoho.com/oauth/v2/token", "us"] + + JP_DATACENTER = ["https://www.zohoapis.jp", "https://sandbox.zohoapis.jp", "https://developer.zohoapis.jp", + "https://accounts.zoho.jp/oauth/v2/token", "jp"] + + IN_DATACENTER = ["https://www.zohoapis.in", "https://sandbox.zohoapis.in", "https://developer.zohoapis.in", + "https://accounts.zoho.in/oauth/v2/token", "in"] + + EU_DATACENTER = ["https://www.zohoapis.eu", "https://sandbox.zohoapis.eu", "https://developer.zohoapis.eu", + "https://accounts.zoho.eu/oauth/v2/token", "eu"] + + CN_DATACENTER = ["https://www.zohoapis.com.cn", "https://sandbox.zohoapis.com.cn", + "https://developer.zohoapis.com.cn", "https://accounts.zoho.com.cn/oauth/v2/token", "cn"] + + AU_DATACENTER = ["https://www.zohoapis.com.au", "https://sandbox.zohoapis.com.au", + "https://developer.zohoapis.com.au", "https://accounts.zoho.com.au/oauth/v2/token", "au"] + CA_DATACENTER = ["https://www.zohoapis.ca", "https://sandbox.zohoapis.ca", "https://developer.zohoapis.ca", "https://accounts.zoho.ca/oauth/v2/token", "ca"] + + PRIMITIVE_TYPES = { + "str": "String", + "bool": "Boolean", + "int": "Integer", + "float": "Float", + "date": "Date", + "datetime": "DateTime" + } + + ENVIRONMENT_ERROR_1 = "ENVIRONMENT_ERROR" + + ENVIRONMENT_ERROR_RESPONSE = "Exception in set the api environment." + CURRENTUSER = "CurrentUser" + PARAM_EXCEPTION = "Exception in forming request Parameter : " + HEADER_EXCEPTION = "Exception in forming request Header : " + TIME_RANGE_NAMESPACE = "zohocrmsdk.src.com.zoho.crm.api.record.TimeRange" + SUB_TYPE = "sub_type" diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/converter.py b/zohocrmsdk/src/com/zoho/crm/api/util/converter.py new file mode 100755 index 0000000..6ad71f1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/converter.py @@ -0,0 +1,312 @@ +try: + from abc import ABC, abstractmethod + import logging + import sys + import zlib + import base64 + import re + import os + import importlib + from zohocrmsdk.src.com.zoho.crm.api.util import Utility, Choice + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + +except Exception: + from abc import ABC, abstractmethod + import logging + import sys + import zlib + import base64 + import re + import os + import importlib + from .utility import Utility + from .choice import Choice + from ..initializer import Initializer + +class Converter(ABC): + """ + This abstract class is to construct API request and response. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + """ + Creates a Converter class instance with the CommonAPIHandler class instance. + :param common_api_handler: A CommonAPIHandler class instance. + """ + + self.common_api_handler = common_api_handler + + @abstractmethod + def get_response(self, response, pack): + + """ + This abstract method to process the API response. + :param response: A object containing the API response contents or response. + :param pack: A str containing the expected method return type. + :return: A object representing the POJO class instance. + """ + + pass + + @abstractmethod + def form_request(self, request_instance, pack, instance_number, class_member_detail): + + """ + This abstract method to construct the API request. + :param request_instance: A Object containing the POJO class instance. + :param pack: A str containing the expected method return type. + :param instance_number: An int containing the POJO class instance list number. + :param class_member_detail : A dict representing the member details + :return: A object representing the API request body object. + """ + + pass + + @abstractmethod + def append_to_request(self, request_base, request_object): + + """ + This abstract method to construct the API request body. + :param request_base: A HttpEntityEnclosingRequestBase class instance. + :param request_object: A object containing the API request body object. + """ + + pass + + @abstractmethod + def get_wrapped_response(self, response, pack): + + """ + This abstract method to process the API response. + :param response: A object containing the HttpResponse class instance. + :param pack: A str containing the expected method return type. + :return: A object representing the POJO class instance. + """ + pass + + def value_checker(self, class_name, member_name, key_details, value, unique_values_map, instance_number): + + """ + This method is to validate if the input values satisfy the constraints for the respective fields. + :param class_name: A str containing the class name. + :param member_name: A str containing the member name. + :param key_details: A JSON object containing the key JSON details. + :param value: A object containing the key value. + :param unique_values_map: A list containing the construct objects. + :param instance_number: An int containing the POJO class instance list number. + :return: A bool representing the key value is expected pattern, unique, length, and values. + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + + except Exception: + from ..exception import SDKException + from .constants import Constants + from ..initializer import Initializer + + details_jo = {} + name = key_details[Constants.NAME] + data_type = key_details[Constants.TYPE] + check = True + given_type = None + + if value is not None: + if Constants.INTERFACE in key_details and key_details[Constants.INTERFACE]: + interface_details = Initializer.get_initializer().json_details[key_details[Constants.STRUCTURE_NAME]] + classes = interface_details[Constants.CLASSES] + check = False + for each_class in classes: + path_split = str(value.__class__.__module__).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + + if pack == each_class: + check = True + break + else: + given_type = value.__class__ + + if data_type in Constants.DATA_TYPE: + if value is not None and isinstance(value, list) and Constants.STRUCTURE_NAME in key_details: + structure_name = key_details[Constants.STRUCTURE_NAME] + index = 0 + path_split = str(structure_name).rpartition('.') + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, path_split[-1]) + + for each_instance in value: + if not isinstance(each_instance, class_holder): + check = False + instance_number = index + data_type = Constants.LIST_KEY + '[' + structure_name + ']' + given_type = each_instance.__module__ + break + + index = index + 1 + elif value is not None and isinstance(value, list) and Constants.SUB_TYPE in key_details: + index = 0 + sub_type1 = key_details[Constants.SUB_TYPE] + sub_type = sub_type1[Constants.TYPE] + if sub_type.lower() == Constants.OBJECT_KEY: + check = True + else: + for each_instance in value: + if not Utility.check_data_type(each_instance, sub_type): + check = False + instance_number = index + if sub_type in Constants.DATA_TYPE: + sub_type = Constants.DATA_TYPE.get(sub_type).__name__ + data_type = Constants.LIST_KEY + '[' + sub_type + ']' + given_type = Constants.LIST_KEY + '[' + each_instance.__class__.__name__ + ']' + break + index = index + 1 + else: + check = Utility.check_data_type(value=value, data_type=data_type) + + elif value is not None and data_type.lower() != Constants.OBJECT_KEY: + if data_type == "TimeZone": + check = True + else: + path_split = str(data_type).rpartition('.') + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, path_split[-1]) + + if not isinstance(value, class_holder): + check = False + if not check and value is not None: + details_jo[Constants.FIELD] = name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.ACCEPTED_TYPE] = data_type + details_jo[Constants.GIVEN_TYPE] = given_type + if instance_number is not None: + details_jo[Constants.INDEX] = instance_number + + raise SDKException(code=Constants.TYPE_ERROR, details=details_jo) + + if Constants.VALUES in key_details and \ + (Constants.PICKLIST not in key_details + or (key_details[Constants.PICKLIST] + and Initializer.get_initializer().sdk_config.get_pick_list_validation())): + values_ja = key_details[Constants.VALUES] + + if isinstance(value, list): + value_1 = value + for value_2 in value_1: + if isinstance(value_2, Choice): + choice = value_2 + value_2 = choice.get_value() + if str(value_2) not in values_ja: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_VALUE] = value + details_jo[Constants.ACCEPTED_VALUES] = values_ja + if instance_number is not None: + details_jo[Constants.INDEX] = instance_number + + raise SDKException(code=Constants.UNACCEPTED_VALUES_ERROR, details=details_jo) + else: + if isinstance(value, Choice): + value = value.get_value() + + if value not in values_ja: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_VALUE] = value + details_jo[Constants.ACCEPTED_VALUES] = values_ja + if instance_number is not None: + details_jo[Constants.INDEX] = instance_number + + raise SDKException(code=Constants.UNACCEPTED_VALUES_ERROR, details=details_jo) + + if Constants.UNIQUE in key_details: + if name not in unique_values_map: + unique_values_map[name] = [] + + values_array = unique_values_map[name] + + if value in values_array: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.FIRST_INDEX] = values_array.index(value) + 1 + details_jo[Constants.NEXT_INDEX] = instance_number + + raise SDKException(code=Constants.UNIQUE_KEY_ERROR, details=details_jo) + + else: + unique_values_map[name].append(value) + + if Constants.MIN_LENGTH in key_details or Constants.MAX_LENGTH in key_details: + count = len(str(value)) + + if isinstance(value, list): + count = len(value) + + if Constants.MAX_LENGTH in key_details and count > key_details[Constants.MAX_LENGTH]: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_LENGTH] = count + details_jo[Constants.MAXIMUM_LENGTH] = key_details[Constants.MAX_LENGTH] + + raise SDKException(code=Constants.MAXIMUM_LENGTH_ERROR, details=details_jo) + + if Constants.MIN_LENGTH in key_details and count < key_details[Constants.MIN_LENGTH]: + details_jo[Constants.FIELD] = member_name + details_jo[Constants.CLASS] = class_name + details_jo[Constants.GIVEN_LENGTH] = count + details_jo[Constants.MINIMUM_LENGTH] = key_details[Constants.MIN_LENGTH] + + raise SDKException(code=Constants.MINIMUM_LENGTH_ERROR, details=details_jo) + + return True + + def module_to_class(self, module_name): + class_name = module_name + + if "_" in module_name: + class_name = '' + module_split = str(module_name).split('_') + for each_name in module_split: + each_name = each_name.capitalize() + class_name += each_name + else: + class_name = module_name[0].upper() + module_name[1:] + + return class_name + + @classmethod + def get_encoded_file_name(self): + + try: + from zohocrmsdk.src.com.zoho.api.authenticator import OAuthToken + except: + from ....api.authenticator.oauth_token import OAuthToken + initializer = Initializer.get_initializer() + token = initializer.token + token_key = "" + if isinstance(token, OAuthToken): + oauth_token = token + if oauth_token.get_user_signature() is not None: + token_key = oauth_token.get_user_signature().get_name() + else: + refresh_token = oauth_token.get_refresh_token() + if refresh_token is not None and len(refresh_token) > 0: + token_key = refresh_token[0:len(refresh_token) - 32] + else: + access_token = oauth_token.get_access_token() + if access_token is not None and len(access_token) > 0: + token_key = access_token[0:len(access_token) - 32] + + file_name = initializer.environment.url + if token_key is not None and len(token_key) > 0: + file_name = file_name + token_key + + input_bytes = file_name.encode("UTF-8") + encoded_string = base64.b64encode(input_bytes) + encoded_string = str(encoded_string.decode("UTF-8")) + return encoded_string + '.json' diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/datatype_converter.py b/zohocrmsdk/src/com/zoho/crm/api/util/datatype_converter.py new file mode 100755 index 0000000..1585b77 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/datatype_converter.py @@ -0,0 +1,125 @@ +try: + from dateutil.tz import tz + import dateutil.parser + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from datetime import date, datetime,time +except Exception: + from dateutil.tz import tz + import dateutil.parser + from .constants import Constants + from datetime import date, datetime,time + + +class DataTypeConverter(object): + + """ + This class converts JSON value to the expected object type and vice versa. + """ + + pre_converter_map = {} + + post_converter_map = {} + + @staticmethod + def init(): + + """ + The method to initialize the PreConverter and PostConverter lambda functions. + """ + + if len(DataTypeConverter.pre_converter_map) != 0 and len(DataTypeConverter.post_converter_map) != 0: + return + + DataTypeConverter.add_to_map("String", lambda obj: str(obj), lambda obj: str(obj)) + DataTypeConverter.add_to_map("Integer", lambda obj: int(obj), lambda obj: int(obj)) + DataTypeConverter.add_to_map("Long", lambda obj: int(obj) if str(obj) != Constants.NULL_VALUE else None, lambda obj: int(obj)) + DataTypeConverter.add_to_map("Boolean", lambda obj: bool(obj), lambda obj: bool(obj)) + DataTypeConverter.add_to_map("Float", lambda obj: float(obj), lambda obj: float(obj)) + DataTypeConverter.add_to_map("Double", lambda obj: float(obj), lambda obj: float(obj)) + DataTypeConverter.add_to_map("Date", lambda obj: dateutil.parser.isoparse(obj).date(), lambda obj: obj.isoformat()) + DataTypeConverter.add_to_map("DateTime", lambda obj: dateutil.parser.isoparse(obj).astimezone(tz.tzlocal()), lambda obj: obj.replace(microsecond=0).astimezone(tz.tzlocal()).isoformat()) + DataTypeConverter.add_to_map("Object", lambda obj: DataTypeConverter.pre_convert_object_data(obj), lambda obj: DataTypeConverter.post_convert_object_data(obj)) + DataTypeConverter.add_to_map("TimeZone", lambda obj: str(obj), lambda obj: str(obj)) + DataTypeConverter.add_to_map("LocalTime", lambda obj: DataTypeConverter.string_to_local_time(obj), lambda obj: DataTypeConverter.local_time_to_sting(obj)) + + @ staticmethod + def local_time_to_sting(obj): + return str(obj.hour) + ':' + str(obj.minute) + + @staticmethod + def string_to_local_time(obj): + value = str(obj).split(':') + return time(int(value[0]), int(value[1])) + + @staticmethod + def pre_convert_object_data(obj): + return obj + + @staticmethod + def post_convert_object_data(obj): + + if obj is None: + return None + if isinstance(obj, list): + list_value = [] + for data in obj: + list_value.append(DataTypeConverter.post_convert_object_data(data)) + + return list_value + + elif isinstance(obj, dict): + dict_value = {} + for key, value in obj.items(): + dict_value[key] = DataTypeConverter.post_convert_object_data(value) + + return dict_value + + elif isinstance(obj, date): + return DataTypeConverter.post_convert(obj, Constants.DATE_NAMESPACE) + + elif isinstance(obj, datetime): + return DataTypeConverter.post_convert(obj, Constants.DATETIME_NAMESPACE) + + else: + return obj + + @staticmethod + def add_to_map(name, pre_converter, post_converter): + + """ + This method to add PreConverter and PostConverter instance. + :param name: A str containing the data type class name. + :param pre_converter: A pre_converter instance. + :param post_converter: A post_converter instance. + """ + + DataTypeConverter.pre_converter_map[name] = pre_converter + DataTypeConverter.post_converter_map[name] = post_converter + + @staticmethod + def pre_convert(obj, data_type): + + """ + The method to convert JSON value to expected data value. + :param obj: An object containing the JSON value. + :param data_type: A str containing the expected method return type. + :return: An object containing the expected data value. + """ + + DataTypeConverter.init() + if data_type in DataTypeConverter.pre_converter_map: + return DataTypeConverter.pre_converter_map[data_type](obj) + + @staticmethod + def post_convert(obj, data_type): + + """ + The method to convert python data to JSON data value. + :param obj: A object containing the python data value. + :param data_type: A str containing the expected method return type. + :return: An object containing the expected data value. + """ + + DataTypeConverter.init() + if data_type in DataTypeConverter.post_converter_map: + return DataTypeConverter.post_converter_map[data_type](obj) diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/downloader.py b/zohocrmsdk/src/com/zoho/crm/api/util/downloader.py new file mode 100755 index 0000000..39927a8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/downloader.py @@ -0,0 +1,97 @@ +try: + import importlib + import logging + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util import Converter, Constants, JSONConverter +except Exception: + import importlib + import logging + import re + from .converter import Converter + from .constants import Constants + from .json_converter import JSONConverter + + +class Downloader(Converter): + + """ + This class to process the download file and stream response. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + self.unique_dict = {} + self.common_api_handler = common_api_handler + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + + return None + + def append_to_request(self, request_base, request_object): + + return + + def get_wrapped_response(self, response, pack): + + return self.get_response(response, pack) + + def get_response(self, response, pack): + + try: + from zohocrmsdk.src.com.zoho.crm.api import Initializer + + except Exception: + from ..initializer import Initializer + + path_split = str(pack).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + class_detail = dict(Initializer.json_details[str(pack)]) + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + classes = class_detail[Constants.CLASSES] + + for each_class in classes: + if Constants.FILE_BODY_WRAPPER in each_class: + return self.get_response(response, each_class) + else: + instance = self.get_class(class_name, path_split[0])() + + for member_name, member_detail in class_detail.items(): + data_type = member_detail[Constants.TYPE] + instance_value = None + + if data_type == Constants.STREAM_WRAPPER_CLASS_PATH: + file_name = '' + content_disposition = response.headers[Constants.CONTENT_DISPOSITION] + + if "'" in content_disposition: + start_index = content_disposition.rindex("'") + file_name = content_disposition[start_index + 1:] + + elif '"' in content_disposition: + start_index = content_disposition.rindex('=') + file_name = content_disposition[start_index + 1:].replace('"', '') + + stream_path_split = str(data_type).rpartition(".") + stream_class_name = self.module_to_class(stream_path_split[-1]) + instance_value = self.get_class(stream_class_name, stream_path_split[0])(file_name, response) + + setattr(instance, + self.construct_private_member(class_name=class_name, member_name=member_name), instance_value) + + return instance + + @staticmethod + def construct_private_member(class_name, member_name): + return '_' + class_name + '__' + member_name + + @staticmethod + def get_class(class_name, class_path): + imported_module = importlib.import_module(class_path) + class_holder = getattr(imported_module, class_name) + return class_holder diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/form_data_converter.py b/zohocrmsdk/src/com/zoho/crm/api/util/form_data_converter.py new file mode 100755 index 0000000..29f59c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/form_data_converter.py @@ -0,0 +1,198 @@ +try: + import importlib + import logging + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util import Utility,Converter, Constants, StreamWrapper + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException + +except Exception: + import importlib + import logging + import re + from .converter import Converter + from .constants import Constants + from .utility import Utility + from .stream_wrapper import StreamWrapper + from ..exception import SDKException + + +class FormDataConverter(Converter): + """ + This class to process the upload file and stream. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + self.unique_dict = {} + self.common_api_handler = common_api_handler + + def append_to_request(self, request_base, request_object): + form_data_request_body = [] + self.add_file_body(request_object, form_data_request_body) + request_base.file = True + return form_data_request_body + + def add_file_body(self, request_object, request_body): + for key_name, key_value in request_object.items(): + if isinstance(key_value, list): + for each_object in key_value: + if isinstance(each_object, StreamWrapper): + request_body.append((key_name, each_object.get_stream())) + else: + request_body.append((key_name, key_value)) + elif isinstance(key_value, StreamWrapper): + entry = (key_name, key_value.get_stream()) + request_body.append(entry) + else: + entry = (key_name, key_value) + request_body.append(entry) + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + path_split = str(pack).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + class_detail = dict(Initializer.json_details[str(pack)]) + request = dict() + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + request_object_class_name = request_instance.__class__.__module__ + request_object_class_name = str(request_object_class_name) + path_split = str(request_object_class_name).rpartition(".") + request_class_name = self.module_to_class(path_split[-1]) + request_object_class_name = path_split[0] + "." + request_class_name + classes = class_detail[Constants.CLASSES] + + for class_name in classes: + class_name_interface_lower = str(class_name).lower() + request_class_path_lower = request_object_class_name.lower() + if class_name_interface_lower == request_class_path_lower: + class_detail = dict(Initializer.json_details[str(class_name)]) + class_name = str(class_name).rpartition(".") + class_name = self.module_to_class(class_name[-1]) + break + + for member_name, member_detail in class_detail.items(): + modification = None + + if (Constants.READ_ONLY in member_detail and bool( + member_detail[Constants.READ_ONLY])) or Constants.NAME not in member_detail: + continue + + try: + modification = getattr(request_instance, Constants.IS_KEY_MODIFIED)(member_name) + except Exception as e: + raise SDKException(code=Constants.EXCEPTION_IS_KEY_MODIFIED, cause=e) + + if (modification is None or modification == 0) and Constants.REQUIRED in member_detail and bool( + member_detail[Constants.REQUIRED]): + raise SDKException(Constants.MANDATORY_VALUE_ERROR, + Constants.MANDATORY_KEY_ERROR + member_name) + + field_value = getattr(request_instance, self.construct_private_member(class_name=class_name, member_name=member_name)) + + if modification is not None and modification != 0 and field_value is not None and self.value_checker( + class_name=class_name, + member_name=member_name, + key_details=member_detail, + value=field_value, + unique_values_map=self.unique_dict, + instance_number=instance_number) is True: + key_name = member_detail.get(Constants.NAME) + data_type = member_detail.get(Constants.TYPE) + + if data_type == Constants.LIST_NAMESPACE: + request[key_name] = self.set_json_array(field_value, member_detail) + + elif data_type == Constants.MAP_NAMESPACE: + request[key_name] = self.set_json_object(field_value, member_detail) + + elif Constants.STRUCTURE_NAME in member_detail: + request[key_name] = \ + self.form_request(field_value, member_detail.get(Constants.STRUCTURE_NAME), 0, member_detail) + + else: + request[key_name] = field_value + + return request + + def set_json_object(self, field_value, member_detail): + json_object = {} + request_object = dict(field_value) + + if member_detail is None: + for key, value in request_object.items(): + json_object[key] = self.redirector_for_object_to_json(value) + + else: + keys_detail = member_detail[Constants.KEYS] + + for key_detail in keys_detail: + key_name = key_detail[Constants.NAME] + key_value = None + + if key_name in request_object and request_object[key_name] is not None: + if Constants.STRUCTURE_NAME in key_detail: + key_value = self.form_request(field_value[key_name], + key_detail[Constants.STRUCTURE_NAME], 0, member_detail) + + else: + key_value = self.redirector_for_object_to_json(field_value[key_name]) + + json_object[key_name] = key_value + + return json_object + + def set_json_array(self, field_value, member_detail): + json_array = [] + request_objects = list(field_value) + + if member_detail is None: + for request in request_objects: + json_array.append(self.redirector_for_object_to_json(request)) + + else: + if Constants.STRUCTURE_NAME in member_detail: + instance_count = 0 + pack = member_detail[Constants.STRUCTURE_NAME] + + for request in request_objects: + json_array.append(self.form_request(request, pack, instance_count, member_detail)) + instance_count += 1 + + else: + for request in field_value: + json_array.append(self.redirector_for_object_to_json(request)) + + return json_array + + def redirector_for_object_to_json(self, request): + if isinstance(request, list): + return self.set_json_array(request, None) + + if isinstance(request, dict): + return self.set_json_object(request, None) + + else: + return request + + def get_wrapped_response(self, response, pack): + return None + + def get_response(self, response, pack): + return None + + @staticmethod + def construct_private_member(class_name, member_name): + return '_' + class_name + '__' + member_name + + diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/header_param_validator.py b/zohocrmsdk/src/com/zoho/crm/api/util/header_param_validator.py new file mode 100755 index 0000000..a9865cf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/header_param_validator.py @@ -0,0 +1,114 @@ +try: + import os + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + +except Exception: + import os + import re + import json + from .datatype_converter import DataTypeConverter + from ..exception import SDKException + from .constants import Constants + + +class HeaderParamValidator(object): + """ + This class validates the Header and Parameter values with the type accepted by the CRM APIs. + """ + + def validate(self, name, class_name, value): + json_details = self.get_json_details() + json_class_name = self.get_file_name(class_name) + type_detail = None + + if json_class_name in json_details: + type_detail = self.get_key_json_details(name, json_details[json_class_name]) + + if type_detail is not None: + try: + from zohocrmsdk.src.com.zoho.crm.api.util.utility import Utility + except Exception: + from .utility import Utility + if not Utility.check_data_type(value, type_detail[Constants.TYPE]): + param_or_header = 'PARAMETER' if json_class_name is not None and json_class_name.endswith( + 'Param') else 'HEADER' + error_details = { + param_or_header: name, + Constants.CLASS: json_class_name, + Constants.ACCEPTED_TYPE: Constants.DATA_TYPE.get(type_detail[Constants.TYPE]).__name__ if + type_detail[Constants.TYPE] in Constants.DATA_TYPE else type_detail[Constants.TYPE] + } + raise SDKException(code=Constants.TYPE_ERROR, details=error_details) + if Constants.STRUCTURE_NAME in type_detail: + try: + from zohocrmsdk.src.com.zoho.crm.api.util.json_converter import JSONConverter + from zohocrmsdk.src.com.zoho.crm.api.util.common_api_handler import CommonAPIHandler + except Exception: + from .json_converter import JSONConverter + from .common_api_handler import CommonAPIHandler + return json.dumps(JSONConverter(CommonAPIHandler()).form_request(value, type_detail[Constants.TYPE], None, None)) + return self.parse_data(value, type_detail[Constants.TYPE]) + return value + + def parse_data(self, value, type): + if type == Constants.MAP_NAMESPACE: + json_object = {} + request_object = dict(value) + if len(request_object) > 0: + for key, field_value in request_object.items(): + json_object[key] = self.parse_data(field_value, type) + return json_object + elif type == Constants.LIST_NAMESPACE: + json_array = [] + request_objects = list(value) + if len(request_objects) > 0: + for request_object in request_objects: + json_array.append(self.parse_data(request_object, type)) + return json_array + elif type == Constants.CHOICE_NAMESPACE: + return value.get_value() + else: + return DataTypeConverter.post_convert(value, type) + + def get_key_json_details(self, name, json_details): + for key_name in json_details.keys(): + detail = json_details[key_name] + + if Constants.NAME in detail: + if detail[Constants.NAME].lower() == name.lower(): + return detail + + def get_file_name(self, name): + if "." in name: + sdk_name = 'zohocrmsdk.src.' + name_split = str(name).split('.') + class_name = name_split.pop() + package_name = name_split.pop() + pack_split = re.findall('[A-Z][^A-Z]*', package_name) + sdk_package_name = pack_split[0].lower() + if len(pack_split) > 1: + for i in range(1, len(pack_split)): + sdk_package_name += '_' + pack_split[i].lower() + name_split = list(map(lambda x: x.lower(), name_split)) + sdk_name = sdk_name + '.'.join(name_split) + '.' + sdk_package_name + '.' + class_name + return sdk_name + return name + + def get_json_details(self): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + if Initializer.json_details is None: + dir_name = os.path.dirname(__file__) + filename = os.path.join(dir_name, '..', '..', '..', '..', '..', Constants.JSON_DETAILS_FILE_PATH) + + with open(filename, mode='r') as JSON: + Initializer.json_details = json.load(JSON) + + return Initializer.json_details diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/json_converter.py b/zohocrmsdk/src/com/zoho/crm/api/util/json_converter.py new file mode 100755 index 0000000..146e80f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/json_converter.py @@ -0,0 +1,779 @@ +try: + import importlib + import re + import json + from zohocrmsdk.src.com.zoho.crm.api.util.converter import Converter + from zohocrmsdk.src.com.zoho.crm.api.util.constants import Constants + from zohocrmsdk.src.com.zoho.crm.api.util.datatype_converter import DataTypeConverter + from zohocrmsdk.src.com.zoho.crm.api.util.utility import Utility + from zohocrmsdk.src.com.zoho.crm.api.util.choice import Choice + from zohocrmsdk.src.com.zoho.crm.api.exception.sdk_exception import SDKException +except Exception: + import importlib + import re + from ..exception import SDKException + from .converter import Converter + from .constants import Constants + from .datatype_converter import DataTypeConverter + from .utility import Utility + from .choice import Choice + + +class JSONConverter(Converter): + """ + This class processes the API response to the object and an object to a JSON object, containing the request body. + """ + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + self.unique_dict = {} + self.common_api_handler = common_api_handler + + def append_to_request(self, request_base, request_object): + return json.dumps(request_object).encode('utf-8') + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + path_split = str(pack).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + pack = path_split[0] + "." + class_name + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + class_detail = dict(Initializer.json_details[str(pack)]) + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + request_object_class_name = request_instance.__class__.__module__ + request_object_class_name = str(request_object_class_name) + path_split = str(request_object_class_name).rpartition(".") + request_class_name = self.module_to_class(path_split[-1]) + request_object_class_name = path_split[0] + "." + request_class_name + classes = class_detail[Constants.CLASSES] + + for class_name in classes: + class_name_interface_lower = str(class_name).lower() + request_class_path_lower = request_object_class_name.lower() + if class_name_interface_lower == request_class_path_lower: + class_detail = dict(Initializer.json_details[str(class_name)]) + class_name = str(class_name).rpartition(".") + class_name = self.module_to_class(class_name[-1]) + break + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if isinstance(request_instance, Record): + module_api_name = self.common_api_handler.get_module_api_name() + return_json = self.is_record_request(request_instance, class_detail, instance_number, class_member_detail) + self.common_api_handler.set_module_api_name(module_api_name) + return return_json + + else: + return self.is_not_record_request(request_instance, class_name, class_detail, + instance_number, class_member_detail) + + def is_not_record_request(self, request_instance, class_name, class_detail, instance_number, class_member_detail): + try: + from zohocrmsdk.src.com.zoho.crm.api.record import FileDetails + except Exception: + from ..record import FileDetails + + lookup = False + skip_mandatory = False + class_member_name = None + if class_member_detail is not None: + lookup = class_member_detail[Constants.LOOKUP] if Constants.LOOKUP in class_member_detail else False + skip_mandatory = class_member_detail[Constants.SKIP_MANDATORY] \ + if Constants.SKIP_MANDATORY in class_member_detail else False + class_member_name = class_member_detail[Constants.NAME] + + request_json = {} + required_keys, primary_keys, required_in_update_keys = {}, {}, {} + + for member_name, member_detail in class_detail.items(): + if Constants.READ_ONLY in member_name or (Constants.NAME not in member_detail): + continue + + key_name = member_detail[Constants.NAME] + try: + modification = getattr(request_instance, Constants.IS_KEY_MODIFIED)(key_name) + except Exception as e: + raise SDKException(code=Constants.EXCEPTION_IS_KEY_MODIFIED, cause=e) + + if Constants.REQUIRED in member_detail and member_detail[Constants.REQUIRED]: + required_keys[key_name] = True + + if Constants.PRIMARY in member_detail and member_detail[Constants.PRIMARY] and \ + (Constants.REQUIRED_IN_UPDATE not in member_detail or member_detail[Constants.REQUIRED_IN_UPDATE]): + primary_keys[key_name] = True + + if Constants.REQUIRED_IN_UPDATE in member_detail and member_detail[Constants.REQUIRED_IN_UPDATE]: + required_in_update_keys[key_name] = True + + field_value = None + if modification is not None and modification != 0: + field_value = getattr(request_instance, + self.construct_private_member(class_name=class_name, member_name=member_name)) + if field_value is not None: + + if self.value_checker(class_name=class_name, member_name=member_name, key_details=member_detail, + value=field_value, unique_values_map=self.unique_dict, + instance_number=instance_number) is True: + required_keys.pop(key_name, None) + primary_keys.pop(key_name, None) + required_in_update_keys.pop(key_name, None) + + if isinstance(request_instance, FileDetails): + if field_value is None or (isinstance(field_value, str) and field_value == "null"): + request_json[key_name.lower()] = None if field_value is None else field_value + else: + request_json[key_name.lower()] = field_value + + else: + request_json[key_name] = self.set_data(member_detail, field_value) + + if skip_mandatory or self.check_exception(class_member_name, request_instance, instance_number, + lookup, required_keys, primary_keys, required_in_update_keys) is True: + return request_json + + def check_exception(self, member_name, request_instance, instance_number, + lookup, required_keys, primary_keys, required_in_update_keys): + if bool(required_in_update_keys) and self.common_api_handler.get_category_method() is not None and \ + self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_UPDATE: + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(required_in_update_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.MANDATORY_KEY_ERROR, error) + + if self.common_api_handler.get_mandatory_checker() is not None and \ + self.common_api_handler.get_mandatory_checker(): + if self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_CREATE: + if lookup: + if bool(primary_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(primary_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.MANDATORY_KEY_ERROR, error) + + elif bool(required_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(required_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.MANDATORY_KEY_ERROR, error) + + if self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_UPDATE and \ + bool(primary_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(primary_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.PRIMARY_KEY_ERROR, error) + + elif lookup and self.common_api_handler.get_category_method().upper() == Constants.REQUEST_CATEGORY_UPDATE: + if bool(primary_keys): + error = { + Constants.FIELD: member_name, + Constants.TYPE: request_instance.__module__, + Constants.KEYS: str(list(primary_keys.keys())) + } + if instance_number is not None: + error[Constants.INSTANCE_NUMBER] = instance_number + + raise SDKException(Constants.MANDATORY_VALUE_ERROR, Constants.PRIMARY_KEY_ERROR, error) + + return True + + def is_record_request(self, record_instance, class_detail, instance_number, member_detail): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + lookup = False + skip_mandatory = False + class_member_name = None + if member_detail is not None: + lookup = member_detail[Constants.LOOKUP] if Constants.LOOKUP in member_detail else False + skip_mandatory = member_detail[ + Constants.SKIP_MANDATORY] if Constants.SKIP_MANDATORY in member_detail else False + class_member_name = member_detail[Constants.NAME] + + request_json, module_detail = {}, {} + module_api_name = self.common_api_handler.get_module_api_name() + class_name = record_instance.__class__.__name__ + + if module_api_name is not None: + self.common_api_handler.set_module_api_name(None) + module_detail = self.__get_module_detail_from_user_spec_json(module_api_name) + else: + module_detail = class_detail + class_detail = Initializer.json_details[Constants.RECORD_NAMESPACE] + + class_list = record_instance.__class__.mro() + + for each_class in class_list: + if Constants.RECORD_TYPE in str(each_class): + class_name = Constants.RECORD_CLASS_NAME + break + + key_values = getattr(record_instance, self.construct_private_member(class_name, Constants.KEY_VALUES)) + key_modified = getattr(record_instance, self.construct_private_member(class_name, Constants.KEY_MODIFIED)) + + required_keys, primary_keys = {}, {} + + if not skip_mandatory: + for key_name, key_detail in module_detail.items(): + if Constants.NAME in key_detail: + name = key_detail[Constants.NAME] + if key_detail is not None and Constants.REQUIRED in key_detail and key_detail[Constants.REQUIRED]: + required_keys[name] = True + + if key_detail is not None and Constants.PRIMARY in key_detail and key_detail[Constants.PRIMARY]: + primary_keys[name] = True + + for key_name, key_detail in class_detail.items(): + name = key_detail[Constants.NAME] + if Constants.REQUIRED in key_detail and key_detail[Constants.REQUIRED]: + required_keys[name] = True + + if Constants.PRIMARY in key_detail and key_detail[Constants.PRIMARY]: + primary_keys[name] = True + + for key_name in key_modified.keys(): + if key_modified.get(key_name) != 1: + continue + + key_detail = {} + key_value = key_values.get(key_name) if key_name in key_values else None + json_value = None + member_name = self.build_name(key_name) + + custom_handling = False + + if len(module_detail) > 0 and (member_name in module_detail or key_name in module_detail): + key_detail = module_detail[key_name] if key_name in module_detail else module_detail[member_name] + + elif member_name in class_detail: + key_detail = class_detail[member_name] + + else: + custom_handling = True + + if key_value is not None: + if key_detail is not None and len(key_detail) > 0: + if (Constants.READ_ONLY in key_detail and bool(key_detail[Constants.READ_ONLY])) or \ + (Constants.NAME not in key_detail): + continue + + if self.value_checker(class_name, key_name, key_detail, key_value, self.unique_dict, instance_number): + json_value = self.set_data(key_detail, key_value) + else: + if key_detail is None or len(key_detail) == 0: + custom_handling = True + if custom_handling and not isinstance(key_value, list) and not isinstance(key_value, dict) and not isinstance(key_value, Choice): + if key_value.__class__.__name__ in Constants.PRIMITIVE_TYPES: + key_detail[Constants.TYPE] = Constants.PRIMITIVE_TYPES.get(key_value.__class__.__name__) + json_value = self.set_data(key_detail, key_value) + elif self.get_class_name(key_value.__module__) in Initializer.json_details: + key_detail[Constants.STRUCTURE_NAME] = self.get_class_name(key_value.__module__) + key_detail[Constants.NAME] = key_name + key_detail[Constants.TYPE] = self.get_class_name(key_value.__module__) + json_value = self.set_data(key_detail, key_value) + else: + if custom_handling and isinstance(key_value, list): + class_of_keyvalue = self.get_class_name(key_value[0].__module__) + if class_of_keyvalue in Initializer.json_details: + key_detail[Constants.STRUCTURE_NAME] = class_of_keyvalue + key_detail[Constants.NAME] = key_name + key_detail[Constants.TYPE] = class_of_keyvalue + json_value = self.set_json_array(key_value, key_detail) + else: + json_value = self.redirector_for_object_to_json(key_value) + else: + json_value = self.redirector_for_object_to_json(key_value) + + else: + json_value = None + + if key_value is not None: + required_keys.pop(key_name, None) + primary_keys.pop(key_name, None) + + request_json[key_name] = json_value + + if skip_mandatory or self.check_exception(class_member_name, record_instance, instance_number, + lookup, required_keys, primary_keys, {}) is True: + return request_json + + @staticmethod + def get_class_name(class_name): + class_name_array = class_name.split(".") + class_array = class_name_array[-1].split("_") + for i in range(len(class_array)): + class_array[i] = class_array[i].capitalize() + class_name = "".join(class_array) + class_name_array[-1] = class_name + return ".".join(class_name_array) + + def set_data(self, member_detail, field_value): + if field_value is not None: + data_type = member_detail[Constants.TYPE] + return self.set_data_value(data_type, member_detail, field_value) + return field_value + + def set_data_value(self, data_type, member_detail, field_value): + if data_type == Constants.LIST_NAMESPACE: + return self.set_json_array(field_value, member_detail) + elif data_type == Constants.MAP_NAMESPACE: + return self.set_json_object(field_value, member_detail) + elif data_type == Constants.CHOICE_NAMESPACE or \ + (Constants.STRUCTURE_NAME in member_detail and + member_detail[Constants.STRUCTURE_NAME] == Constants.CHOICE_NAMESPACE): + return field_value.get_value() + elif Constants.STRUCTURE_NAME in member_detail and Constants.MODULE in member_detail: + return self.is_record_request( + field_value, self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), None, member_detail) + elif Constants.STRUCTURE_NAME in member_detail: + return self.form_request(field_value, member_detail[Constants.STRUCTURE_NAME], None, member_detail) + else: + return DataTypeConverter.post_convert(field_value, data_type) + + def set_json_object(self, field_value, member_detail): + json_object = {} + request_object = dict(field_value) + + if len(request_object) > 0: + if member_detail is None or (member_detail is not None and Constants.KEYS not in member_detail): + for key, value in request_object.items(): + json_object[key] = self.redirector_for_object_to_json(value) + + else: + if Constants.KEYS in member_detail: + keys_detail = member_detail[Constants.KEYS] + + for key_detail in keys_detail: + key_name = key_detail[Constants.NAME] + + if key_name in request_object and request_object[key_name] is not None: + key_value = self.set_data(key_detail, request_object[key_name]) + json_object[key_name] = key_value + + return json_object + + def set_json_array(self, field_value, member_detail): + json_array = [] + request_objects = list(field_value) + + if len(request_objects) > 0: + if member_detail is None or (member_detail is not None and Constants.STRUCTURE_NAME not in member_detail): + if member_detail is not None and Constants.SUB_TYPE in member_detail: + sub_type = member_detail[Constants.SUB_TYPE] + data_type = sub_type[Constants.TYPE] + if data_type == Constants.CHOICE_NAMESPACE: + for request in request_objects: + json_array.append(request.get_value()) + else: + for request in request_objects: + json_array.append(self.set_data_value(data_type, member_detail, request)) + else: + for request in request_objects: + json_array.append(self.redirector_for_object_to_json(request)) + else: + pack = member_detail[Constants.STRUCTURE_NAME] + + if pack == Constants.CHOICE_NAMESPACE: + for request in request_objects: + json_array.append(request.get_value()) + + elif Constants.MODULE in member_detail and member_detail[Constants.MODULE] is not None: + instance_count = 0 + for request in request_objects: + json_array.append( + self.is_record_request(request, + self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), instance_count, member_detail)) + instance_count += 1 + + else: + instance_count = 0 + for request in request_objects: + json_array.append(self.form_request(request, pack, instance_count, member_detail)) + instance_count += 1 + + return json_array + + def redirector_for_object_to_json(self, request): + if isinstance(request, list): + return self.set_json_array(request, None) + + elif isinstance(request, dict): + return self.set_json_object(request, None) + + elif isinstance(request, Choice): + return request.get_value() + + else: + return request + + def get_wrapped_response(self, response, pack): + try: + return self.get_response(response.json(), pack) + + except ValueError: + return None + + def get_response(self, response, package_name): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + if response is None or response == '' or response == "None" or response == "null": + return None + if isinstance(response, str) or isinstance(response, int) or isinstance(response, float) or isinstance(response, bool): + response_json = response + else: + response_json = dict(response) + + path_split = str(package_name).rpartition(".") + class_name = self.module_to_class(path_split[-1]) + package_name = path_split[0] + "." + class_name + class_detail = dict(Initializer.json_details[str(package_name)]) + instance = None + + if Constants.INTERFACE in class_detail and class_detail[Constants.INTERFACE] is not None: + classes = class_detail[Constants.CLASSES] + instance = self.find_match(classes, response_json) + else: + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, class_name) + instance = class_holder() + + try: + from zohocrmsdk.src.com.zoho.crm.api.record import Record + except Exception: + from ..record import Record + + if isinstance(instance, Record): + module_api_name = self.common_api_handler.get_module_api_name() + instance = self.is_record_response(response_json, class_detail, package_name) + self.common_api_handler.set_module_api_name(module_api_name) + + else: + instance = self.not_record_response(instance=instance, class_name=class_name, + response_json=response_json, class_detail=class_detail) + + return instance + + def not_record_response(self, instance, class_name, response_json, class_detail): + for member_name, key_detail in class_detail.items(): + key_name = key_detail[Constants.NAME] if Constants.NAME in key_detail else None + + if key_name is not None and key_name in response_json and response_json.get(key_name) is not None: + key_data = response_json[key_name] + member_value = self.get_data(key_data, key_detail) + setattr(instance, self.construct_private_member(class_name=class_name, member_name=member_name), + member_value) + + return instance + + def is_record_response(self, response_json, class_detail, pack): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + response_json = dict(response_json) + record_instance = JSONConverter.__get_instance_from_name(pack) + module_api_name = self.common_api_handler.get_module_api_name() + + module_detail = {} + class_name = Constants.RECORD_NAMESPACE.rpartition('.')[-1] + + if module_api_name is not None: + self.common_api_handler.set_module_api_name(None) + module_detail = self.__get_module_detail_from_user_spec_json(module_api_name) + + for key, value in class_detail.items(): + if module_detail is None: + module_detail = {} + module_detail[key] = value + + record_detail = Initializer.json_details[Constants.RECORD_NAMESPACE] + + class_list = record_instance.__class__.mro() + + for each_class in class_list: + if Constants.RECORD_TYPE in str(each_class): + class_name = Constants.RECORD_CLASS_NAME + break + + key_values = {} + + for key_name in response_json.keys(): + member_name = self.build_name(key_name) + key_detail = {} + + if len(module_detail) > 0 and (key_name in module_detail or member_name in module_detail): + key_detail = module_detail[key_name] if key_name in module_detail.keys() else module_detail[member_name] + + elif member_name in record_detail: + key_detail = record_detail[member_name] + + key_data = response_json[key_name] + key_value = None + + if key_detail is not None and len(key_detail) > 0: + key_name = key_detail[Constants.NAME] + key_value = self.get_data(key_data, key_detail) + + else: + key_value = self.redirector_for_json_to_object(key_data) + + key_values[key_name] = key_value + + setattr(record_instance, self.construct_private_member(class_name, Constants.KEY_VALUES), key_values) + + return record_instance + + def get_data(self, key_data, member_detail): + member_value = None + if key_data is not None: + data_type = member_detail.get(Constants.TYPE) + return self.get_data_value(data_type, key_data, member_detail) + return member_value + + def get_data_value(self, data_type, key_data, member_detail): + member_value = None + if data_type == Constants.LIST_NAMESPACE: + member_value = self.get_collections_data(key_data, member_detail) + elif data_type == Constants.MAP_NAMESPACE: + member_value = self.get_map_data(key_data, member_detail) + elif data_type == Constants.CHOICE_NAMESPACE or ( + Constants.STRUCTURE_NAME in member_detail and member_detail[ + Constants.STRUCTURE_NAME] == Constants.CHOICE_NAMESPACE): + member_value = self.__get_choice_instance(key_data) + elif Constants.STRUCTURE_NAME in member_detail and Constants.MODULE in member_detail: + member_value = self.is_record_response(key_data, self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), member_detail[Constants.STRUCTURE_NAME]) + elif Constants.STRUCTURE_NAME in member_detail: + member_value = self.get_response(key_data, member_detail[Constants.STRUCTURE_NAME]) + else: + member_value = DataTypeConverter.pre_convert(key_data, data_type) + return member_value + + def get_map_data(self, response, member_detail): + map_instance = {} + + if len(response) > 0: + if member_detail is None or (member_detail is not None and Constants.KEYS not in member_detail): + for key, value in response.items(): + map_instance[key] = self.redirector_for_json_to_object(value) + + else: + if Constants.KEYS in member_detail: + keys_detail = member_detail[Constants.KEYS] + + for key_detail in keys_detail: + key_name = key_detail[Constants.NAME] + if key_name in response and response[key_name] is not None: + key_value = self.get_data(response[key_name], key_detail) + map_instance[key_name] = key_value + + return map_instance + + def get_collections_data(self, responses, member_detail): + values = [] + if len(responses) > 0: + if member_detail is None or (member_detail is not None and Constants.STRUCTURE_NAME not in member_detail): + if member_detail is not None and Constants.SUB_TYPE not in member_detail: + sub_type = member_detail[Constants.SUB_TYPE] + type = sub_type[Constants.TYPE] + if type == Constants.CHOICE_NAMESPACE: + for response in responses: + values.append(self.__get_choice_instance(response)) + else: + for response in responses: + values.append(self.get_data_value(type, response, member_detail)) + else: + for response in responses: + values.append(self.redirector_for_json_to_object(response)) + else: + pack = member_detail[Constants.STRUCTURE_NAME] + if pack == Constants.CHOICE_NAMESPACE: + for response in responses: + values.append(self.__get_choice_instance(response)) + + elif Constants.MODULE in member_detail and member_detail[Constants.MODULE] is not None: + for response in responses: + values.append(self.is_record_response(response, self.__get_module_detail_from_user_spec_json( + member_detail[Constants.MODULE]), pack)) + + else: + for response in responses: + values.append(self.get_response(response, pack)) + + return values + + def __get_module_detail_from_user_spec_json(self, module): + try: + import os + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + import os + from ..initializer import Initializer + + record_field_details_path = os.path.join(Initializer.get_initializer().resource_path, + Constants.FIELD_DETAILS_DIRECTORY, Converter.get_encoded_file_name()) + + record_field_details = Initializer.get_json(record_field_details_path) + module_detail = Utility.get_json_object(record_field_details, module) + if module_detail is not None and len(module_detail) == 0: + with open(record_field_details_path, mode="w") as file: + del record_field_details[module.lower()] + json.dump(record_field_details, file) + file.flush() + file.close() + + return module_detail + + def redirector_for_json_to_object(self, key_data): + if isinstance(key_data, dict): + return self.get_map_data(key_data, None) + + elif isinstance(key_data, list): + return self.get_collections_data(key_data, None) + + elif key_data is None: + return None + + else: + return key_data + + def find_match(self, classes, response_json): + pack = "" + ratio = 0 + + for class_name in classes: + match_ratio = self.find_ratio(class_name, response_json) + + if match_ratio == 1.0: + pack = class_name + ratio = 1 + break + + elif match_ratio > ratio: + ratio = match_ratio + pack = class_name + + return self.get_response(response_json, pack) + + def find_ratio(self, class_name, response_json): + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + class_detail = dict(Initializer.json_details[str(class_name)]) + total_points = len(class_detail.keys()) + matches = 0 + + if total_points == 0: + return + + else: + for member_name in class_detail: + member_detail = class_detail[member_name] + key_name = member_detail[Constants.NAME] if Constants.NAME in member_detail else None + if key_name is not None and key_name in response_json and response_json.get(key_name) is not None: + key_data = response_json[key_name] + data_type = type(key_data).__name__ + structure_name = member_detail[ + Constants.STRUCTURE_NAME] if Constants.STRUCTURE_NAME in member_detail else None + + if isinstance(key_data, dict): + data_type = Constants.MAP_NAMESPACE + + if isinstance(key_data, list): + data_type = Constants.LIST_NAMESPACE + + if data_type == member_detail[Constants.TYPE] or ( + member_detail[Constants.TYPE] in Constants.DATA_TYPE and + isinstance(key_data, Constants.DATA_TYPE.get(member_detail[Constants.TYPE]))): + + matches += 1 + elif key_name.lower() == Constants.COUNT.lower() and \ + member_detail[Constants.TYPE].lower() == Constants.LONG_NAMESPACE.lower(): + matches += 1 + elif member_detail[Constants.TYPE] == Constants.CHOICE_NAMESPACE: + values = list(member_detail[Constants.VALUES]) + for value in values: + if value == key_data: + matches += 1 + break + + if structure_name is not None and structure_name == member_detail[Constants.TYPE]: + if Constants.VALUES in member_detail: + for value in member_detail[Constants.VALUES]: + if value == key_data: + matches += 1 + break + else: + matches += 1 + + return matches / total_points + + def build_name(self, key_name): + name_split = str(key_name).split('_') + sdk_name = name_split[0].lower() + + if len(name_split) > 1: + for i in range(1, len(name_split)): + if len(name_split[i]) > 0: + sdk_name += '_' + name_split[i].lower() + + return sdk_name + + @staticmethod + def __get_instance_from_name(class_path): + path_split = str(class_path).rpartition('.') + imported_module = importlib.import_module(path_split[0]) + class_holder = getattr(imported_module, path_split[-1]) + + return class_holder() + + def construct_private_member(self, class_name, member_name): + return '_' + class_name + '__' + member_name + + def __get_choice_instance(self, data): + choice_split = Constants.CHOICE_NAMESPACE.rpartition('.') + imported_module = importlib.import_module(choice_split[0]) + class_holder = getattr(imported_module, choice_split[-1]) + choice_instance = class_holder(data) + + return choice_instance diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py b/zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py new file mode 100644 index 0000000..c99ed96 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/module_fields_handler.py @@ -0,0 +1,156 @@ +try: + import threading + import os + import json + import logging + import shutil + from zohocrmsdk.src.com.zoho.crm.api.util import Constants, Converter, Utility + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + +except Exception: + import threading + import os + import json + import logging + import shutil + from .constants import Constants + from .converter import Converter + from .utility import Utility + from ..initializer import Initializer + from ..exception import SDKException + + +class ModuleFieldsHandler(object): + logger = logging.getLogger('SDKLogger') + lock = threading.Lock() + + @staticmethod + def __get_directory(): + + """ + The method to obtain resources directory path. + + Returns: + str: A String representing the directory's absolute path. + """ + return os.path.join(Initializer.get_initializer().resource_path, Constants.FIELD_DETAILS_DIRECTORY) + + @staticmethod + def delete_fields_file(): + """ + The method to delete fields JSON File of the current user. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + record_field_details_path = os.path.join(ModuleFieldsHandler.__get_directory(), Converter.get_encoded_file_name()) + if os.path.exists(record_field_details_path): + os.remove(record_field_details_path) + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.DELETE_FIELD_FILE_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def delete_all_field_files(): + """ + The method to delete all the field JSON files under resources directory. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + record_field_details_directory = ModuleFieldsHandler.__get_directory() + if os.path.exists(record_field_details_directory): + files_list = [os.path.join(record_field_details_directory, file) for file in os.listdir(record_field_details_directory) if os.path.isfile(os.path.join(record_field_details_directory, file))] + for each_file in files_list: + if Constants.JSON_FILE_EXTENSION in each_file: + os.remove(each_file) + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.DELETE_FIELD_FILES_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def delete_fields(module): + """ + The method to delete fields of the given module from the current user's fields JSON file. + + Parameters: + module(str): A string representing the module. + + Raises: + SDKException + """ + + try: + if module is None: + raise Exception("module should not be None") + + record_field_details_path = os.path.join(ModuleFieldsHandler.__get_directory(), Converter.get_encoded_file_name()) + if os.path.exists(record_field_details_path): + record_field_details_json = Initializer.get_json(record_field_details_path) + if module.lower() in record_field_details_json: + Utility.delete_fields(record_field_details_json, module) + with open(record_field_details_path, mode="w") as file: + json.dump(record_field_details_json, file) + file.flush() + file.close() + + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.DELETE_MODULE_FROM_FIELDFILE_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def refresh_fields(module): + """ + The method to force-refresh fields of a module. + + Parameters: + module(str): A string representing the module. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + if module is None: + raise Exception("module should not be None") + + ModuleFieldsHandler.delete_fields(module) + Utility.get_fields_info(module) + except SDKException as ex: + ModuleFieldsHandler.logger.info(Constants.REFRESH_SINGLE_MODULE_FIELDS_ERROR + module + ex.__str__()) + raise ex + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.REFRESH_SINGLE_MODULE_FIELDS_ERROR + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def refresh_all_modules(): + """ + The method to force-refresh fields of all the available modules. + + Raises: + SDKException + """ + + with ModuleFieldsHandler.lock: + try: + Utility.refresh_modules() + except SDKException as ex: + ModuleFieldsHandler.logger.info(Constants.REFRESH_ALL_MODULE_FIELDS_ERROR + ex.__str__()) + raise ex + except Exception as e: + sdk_exception = SDKException(cause=e) + ModuleFieldsHandler.logger.info(Constants.REFRESH_ALL_MODULE_FIELDS_ERROR + sdk_exception.__str__()) + raise sdk_exception diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/stream_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/util/stream_wrapper.py new file mode 100755 index 0000000..455a109 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/stream_wrapper.py @@ -0,0 +1,59 @@ +try: + import os + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + import os + from ..exception import SDKException + from .constants import Constants + + +class StreamWrapper(object): + + """ + This class handles the file stream and name. + """ + + def __init__(self, name=None, stream=None, file_path=None): + + """ + Creates a StreamWrapper class instance with the specified parameters. + + Parameters: + name (str) : A string containing the file name. + stream (stream) : A stream containing the file stream. + file_path (str) : A string containing the absolute file path. + """ + + if file_path is not None: + if not os.path.exists(file_path): + raise SDKException(Constants.FILE_ERROR, Constants.FILE_DOES_NOT_EXISTS) + + self.__name = os.path.basename(file_path) + self.__stream = open(file_path, 'rb') + + else: + self.__name = name + self.__stream = stream + + def get_name(self): + + """ + This is a getter method to get the file name. + + Returns: + string : A string representing the file name. + """ + + return self.__name + + def get_stream(self): + + """ + This is a getter method to get the file input stream. + + Returns: + stream : A stream representing the file stream. + """ + + return self.__stream diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/utility.py b/zohocrmsdk/src/com/zoho/crm/api/util/utility.py new file mode 100644 index 0000000..6185dc1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/utility.py @@ -0,0 +1,1011 @@ +try: + import logging + import threading + import datetime + import time + import os + import json + import zlib + import base64 + import re + from zohocrmsdk.src.com.zoho.crm.api.util import Constants, Choice + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.header_map import HeaderMap + from zohocrmsdk.src.com.zoho.crm.api.parameter_map import ParameterMap + from zohocrmsdk.src.com.zoho.crm.api.header import Header + +except Exception: + import logging + import threading + import os + import json + import time + import datetime + import zlib + import base64 + import re + from .constants import Constants + from ..initializer import Initializer + from ..exception import SDKException + from ..header_map import HeaderMap + from ..parameter_map import ParameterMap + from ..header import Header + + +class Utility(object): + """ + This class handles module field details. + """ + + apitype_vs_datatype = {} + apitype_vs_structurename = {} + new_file = False + get_modified_modules = False + force_refresh = False + module_api_name = None + api_supported_modules = {} + lock = threading.RLock() + logger = logging.getLogger('SDKLogger') + + @staticmethod + def file_exists_flow(module_api_name, record_field_details_path, last_modified_time): + with Utility.lock: + record_field_details_json = Initializer.get_json(record_field_details_path) + + initializer = Initializer.get_initializer() + + if initializer.sdk_config.get_auto_refresh_fields() and not Utility.new_file and not Utility.get_modified_modules and ( + Constants.FIELDS_LAST_MODIFIED_TIME not in record_field_details_json or Utility.force_refresh or ( + time.time() * 1000 - record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME]) > 3600000): + Utility.get_modified_modules = True + last_modified_time = record_field_details_json[ + Constants.FIELDS_LAST_MODIFIED_TIME] if not Utility.force_refresh and Constants.FIELDS_LAST_MODIFIED_TIME in record_field_details_json else None + Utility.modify_fields(record_field_details_path, last_modified_time) + Utility.get_modified_modules = False + + elif not Initializer.get_initializer().sdk_config.get_auto_refresh_fields() and Utility.force_refresh and not Utility.get_modified_modules: + Utility.get_modified_modules = True + Utility.modify_fields(record_field_details_path, last_modified_time) + Utility.get_modified_modules = False + + record_field_details_json = Initializer.get_json(record_field_details_path) + + if module_api_name is None or ( + module_api_name.lower() in record_field_details_json and record_field_details_json[ + module_api_name.lower()] is not None): + return + + else: + Utility.fill_data_type() + record_field_details_json[module_api_name.lower()] = {} + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + field_details = Utility.get_fields_details(module_api_name) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[module_api_name.lower()] = field_details + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + @staticmethod + def verify_module_api_name(module_api_name): + if module_api_name is not None and module_api_name.lower() in Constants.DEFAULT_MODULE_NAME_VS_API_NAME and Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get( + module_api_name.lower()) is not None: + return Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get(module_api_name.lower()) + + record_field_details_path = Utility.get_file_name() + if os.path.exists(record_field_details_path) and module_api_name is not None: + fields_json = Initializer.get_json(record_field_details_path) + if Constants.SDK_MODULE_METADATA in fields_json and module_api_name.lower() in fields_json[ + Constants.SDK_MODULE_METADATA]: + return fields_json[Constants.SDK_MODULE_METADATA][module_api_name.lower()][Constants.API_NAME] + + return module_api_name + + @staticmethod + def set_handler_api_path(module_api_name, handler_instance): + if handler_instance is None: + return + + api_path = handler_instance.get_api_path() + + if module_api_name.lower() in api_path.lower(): + api_path_split = api_path.split("/") + + for i in range(len(api_path_split)): + split_lower = api_path_split[i].lower() + if split_lower == module_api_name.lower(): + api_path_split[i] = module_api_name + elif split_lower in Constants.DEFAULT_MODULE_NAME_VS_API_NAME and \ + Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get(split_lower) is not None: + api_path_split[i] = Constants.DEFAULT_MODULE_NAME_VS_API_NAME.get(split_lower) + + api_path = "/".join(api_path_split) + handler_instance.set_api_path(api_path) + + @staticmethod + def get_fields(module_api_name, handler_instance=None): + with Utility.lock: + if "," in module_api_name: + name_split = str(module_api_name).split(',') + if len(name_split) > 1: + for name in name_split: + Utility.module_api_name = name + Utility.get_fields_info(name, handler_instance) + else: + Utility.module_api_name = module_api_name + Utility.get_fields_info(module_api_name, handler_instance) + + @staticmethod + def get_fields_info(module_api_name, handler_instance=None): + + """ + This method to fetch field details of the current module for the current user and store the result in a JSON file. + + Parameters: + module_api_name (str) : A string containing the CRM module API name. + handler_instance (CommonAPIHandler) : A CommonAPIHandler instance. + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.initializer import Initializer + except Exception: + from ..initializer import Initializer + + last_modified_time = None + + record_field_details_path = None + + try: + with Utility.lock: + initializer = Initializer.get_initializer() + + resources_path = os.path.join(initializer.resource_path, + Constants.FIELD_DETAILS_DIRECTORY) + + if not os.path.exists(resources_path): + os.makedirs(resources_path) + if module_api_name is not None: + module_api_name = Utility.verify_module_api_name(module_api_name) + + Utility.set_handler_api_path(module_api_name, handler_instance) + + if handler_instance is not None and handler_instance.get_module_api_name() is None and module_api_name.lower() not in Constants.SKIP_MODULES: + return + + record_field_details_path = Utility.get_file_name() + + if os.path.exists(record_field_details_path): + Utility.file_exists_flow(module_api_name, record_field_details_path, last_modified_time) + elif initializer.sdk_config.get_auto_refresh_fields(): + Utility.new_file = True + Utility.fill_data_type() + if len(Utility.api_supported_modules) == 0: + Utility.api_supported_modules = Utility.get_modules(None) + record_field_details_json = Initializer.get_json(record_field_details_path) if os.path.exists( + record_field_details_path) else {} + + record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] = time.time() * 1000 + + if len(Utility.api_supported_modules) > 0: + for module in Utility.api_supported_modules: + if module.lower() not in record_field_details_json: + module_data = Utility.api_supported_modules[module] + record_field_details_json[module.lower()] = {} + Utility.write_to_file(file_path=record_field_details_path, + file_contents=record_field_details_json) + field_details = Utility.get_fields_details(module_data[Constants.API_NAME]) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[module.lower()] = field_details + Utility.write_to_file(file_path=record_field_details_path, + file_contents=record_field_details_json) + + Utility.new_file = False + + elif Utility.force_refresh and not Utility.get_modified_modules: + Utility.get_modified_modules = True + record_field_details_json = {} + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + Utility.modify_fields(record_field_details_path, last_modified_time) + Utility.get_modified_modules = False + + else: + Utility.fill_data_type() + record_field_details_json = {module_api_name.lower(): {}} + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + field_details = Utility.get_fields_details(module_api_name) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[module_api_name.lower()] = field_details + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + except Exception as e: + if record_field_details_path is not None and os.path.exists(record_field_details_path): + try: + record_field_details_json = Initializer.get_json(record_field_details_path) + if module_api_name is not None and module_api_name.lower() in record_field_details_json: + del record_field_details_json[module_api_name.lower()] + + if Utility.new_file: + if Constants.FIELDS_LAST_MODIFIED_TIME in record_field_details_json: + del record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] + Utility.new_file = False + + if Utility.get_modified_modules or Utility.force_refresh: + Utility.get_modified_modules = False + Utility.force_refresh = False + + if last_modified_time is not None: + record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] = last_modified_time + + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + except Exception as ex: + sdk_exception = SDKException(cause=ex) + Utility.logger.error(Constants.EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + if not isinstance(e, SDKException): + e = SDKException(cause=e) + Utility.logger.info(Constants.EXCEPTION + e.__str__()) + + raise e + + @staticmethod + def modify_fields(record_field_details_path, modified_time): + modified_modules = Utility.get_modules(modified_time) + record_field_details_json = Initializer.get_json(record_field_details_path) + record_field_details_json[Constants.FIELDS_LAST_MODIFIED_TIME] = time.time() * 1000 + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + if len(modified_modules) > 0: + for module in modified_modules.keys(): + if module.lower() in record_field_details_json: + Utility.delete_fields(record_field_details_json, module) + + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + for module in modified_modules.keys(): + module_data = modified_modules[module] + Utility.get_fields_info(module_data[Constants.API_NAME]) + + @staticmethod + def delete_fields(record_field_details_json, module): + subform_modules = [] + fields_json = record_field_details_json[module.lower()] + for key, value in fields_json.items(): + if Constants.SUBFORM in value and value[Constants.SUBFORM] and ( + value[Constants.MODULE]).lower() in record_field_details_json: + subform_modules.append(value[Constants.MODULE]) + + del record_field_details_json[module.lower()] + + if len(subform_modules) > 0: + for subform_module in subform_modules: + Utility.delete_fields(record_field_details_json, subform_module) + + @staticmethod + def get_file_name(): + from zohocrmsdk.src.com.zoho.crm.api.util.converter import Converter + + return os.path.join(Initializer.get_initializer().resource_path, Constants.FIELD_DETAILS_DIRECTORY, + Converter.get_encoded_file_name()) + + @staticmethod + def get_related_lists(related_module_name, module_api_name, common_api_handler): + with Utility.lock: + try: + is_new_data = False + key = (module_api_name + Constants.UNDERSCORE + Constants.RELATED_LISTS).lower() + resources_path = os.path.join(Initializer.get_initializer().resource_path, + Constants.FIELD_DETAILS_DIRECTORY) + + if not os.path.exists(resources_path): + os.makedirs(resources_path) + record_field_details_path = Utility.get_file_name() + + if not os.path.exists(record_field_details_path) or ( + os.path.exists(record_field_details_path) and ( + key not in Initializer.get_json(record_field_details_path) or ( + Initializer.get_json(record_field_details_path)[key] is None or len( + Initializer.get_json(record_field_details_path)[key]) <= 0))): + is_new_data = True + module_api_name = Utility.verify_module_api_name(module_api_name) + related_list_values = Utility.get_related_list_details(module_api_name) + record_field_details_json = Initializer.get_json(record_field_details_path) if os.path.exists( + record_field_details_path) else {} + record_field_details_json[key] = related_list_values + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + record_field_details_json = Initializer.get_json(record_field_details_path) + module_related_list = record_field_details_json[key] if key in record_field_details_json else {} + + if not Utility.check_related_list_exists(related_module_name, module_related_list, + common_api_handler) and not is_new_data: + del record_field_details_json[key] + Utility.write_to_file(file_path=record_field_details_path, file_contents=record_field_details_json) + + Utility.get_related_lists(related_module_name, module_api_name, common_api_handler) + + except SDKException as e: + Utility.logger.error(Constants.EXCEPTION + e.__str__()) + raise e + + except Exception as e: + sdk_exception = SDKException(cause=e) + Utility.logger.error(Constants.EXCEPTION + sdk_exception.__str__()) + raise sdk_exception + + @staticmethod + def check_related_list_exists(related_module_name, module_related_list_array, common_api_handler): + for related_list_jo in module_related_list_array: + if related_list_jo[Constants.API_NAME] is not None and related_list_jo[ + Constants.API_NAME].lower() == related_module_name.lower(): + if related_list_jo[Constants.HREF] == Constants.NULL_VALUE: + raise SDKException(code=Constants.UNSUPPORTED_IN_API, + message=common_api_handler.get_http_method() + ' ' + common_api_handler.get_api_path() + Constants.UNSUPPORTED_IN_API_MESSAGE) + + if related_list_jo[Constants.MODULE] != Constants.NULL_VALUE: + common_api_handler.set_module_api_name(related_list_jo[Constants.MODULE]) + Utility.get_fields_info(related_list_jo[Constants.MODULE], common_api_handler) + return True + + return False + + @staticmethod + def get_related_list_details(module_api_name): + + param_instance = ParameterMap() + + try: + from zohocrmsdk.src.com.zoho.crm.api.related_lists import GetRelatedListsParam + except: + from ..related_lists import GetRelatedListsParam + param_instance.add(GetRelatedListsParam.module, module_api_name) + + import zohocrmsdk.src.com.zoho.crm.api.related_lists as RelatedLists + + related_list_array = [] + + response = RelatedLists.RelatedListsOperations(None).get_related_lists(param_instance) + + if response is not None: + if response.get_status_code() == Constants.NO_CONTENT_STATUS_CODE: + return related_list_array + + data_object = response.get_object() + + if data_object is not None: + if isinstance(data_object, RelatedLists.ResponseWrapper): + related_lists = data_object.get_related_lists() + + for related_list in related_lists: + related_list_detail = { + Constants.API_NAME: related_list.get_api_name(), + Constants.MODULE: related_list.get_module().get_api_name() if related_list.get_module() is not None else Constants.NULL_VALUE, + Constants.NAME: related_list.get_name(), + Constants.HREF: related_list.get_href() if related_list.get_href() is not None else Constants.NULL_VALUE + } + related_list_array.append(related_list_detail) + + elif isinstance(data_object, RelatedLists.APIException): + error_response = { + Constants.CODE: data_object.get_code().get_value(), + Constants.STATUS: data_object.get_status().get_value(), + Constants.MESSAGE: data_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + else: + error_response = { + Constants.CODE: response.get_status_code() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + else: + error_response = { + Constants.CODE: response.get_status_code() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + return related_list_array + + @staticmethod + def get_fields_details(module_api_name): + + """ + This method to get module field data from Zoho CRM. + :param module_api_name: A str containing the CRM module API name. + :return: A object representing the Zoho CRM module field details. + """ + import zohocrmsdk.src.com.zoho.crm.api.fields as Field + + fields_details = {} + + param_instance = ParameterMap() + + param_instance.add(Field.GetFieldsParam.module, module_api_name) + + response = Field.FieldsOperations().get_fields(param_instance) + + if response is not None: + if response.get_status_code() == Constants.NO_CONTENT_STATUS_CODE: + return fields_details + + response_object = response.get_object() + + if isinstance(response_object, Field.ResponseWrapper): + fields = response_object.get_fields() + + for field in fields: + if field.get_api_name() in Constants.KEYS_TO_SKIP: + continue + + field_detail = {} + + Utility.set_data_type(field_detail, field, module_api_name) + + fields_details[field.get_api_name()] = field_detail + + if module_api_name.lower() in Constants.INVENTORY_MODULES: + field_detail = { + Constants.NAME: Constants.LINE_TAX, + Constants.TYPE: Constants.LIST_NAMESPACE, + Constants.STRUCTURE_NAME: Constants.LINE_TAX_NAMESPACE + } + fields_details[Constants.LINE_TAX] = field_detail + + if module_api_name.lower() == Constants.NOTES: + field_detail = { + Constants.NAME: Constants.ATTACHMENTS, + Constants.TYPE: Constants.LIST_NAMESPACE, + Constants.STRUCTURE_NAME: Constants.ATTACHMENTS_NAMESPACE + } + fields_details[Constants.ATTACHMENTS] = field_detail + + elif isinstance(response_object, Field.APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + + exception = SDKException(code=Constants.API_EXCEPTION, details=error_response) + + if Utility.module_api_name is not None and Utility.module_api_name.lower() == module_api_name.lower(): + raise + Utility.logger.info(Constants.API_EXCEPTION + exception.__str__()) + + else: + error_response = { + Constants.CODE: response.get_status_code() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + return fields_details + + @staticmethod + def verify_photo_support(module_api_name): + with Utility.lock: + try: + module_api_name = Utility.verify_module_api_name(module_api_name) + if module_api_name.lower() in Constants.PHOTO_SUPPORTED_MODULES: + return True + + modules = Utility.get_module_names() + if module_api_name.lower() in modules and modules[module_api_name.lower()] is not None: + module_meta_data = modules[module_api_name.lower()] + + if Constants.GENERATED_TYPE in module_meta_data and module_meta_data[ + Constants.GENERATED_TYPE] != Constants.GENERATED_TYPE_CUSTOM: + raise SDKException(code=Constants.UPLOAD_PHOTO_UNSUPPORTED_ERROR, + message=Constants.UPLOAD_PHOTO_UNSUPPORTED_MESSAGE + module_api_name) + except SDKException as e: + raise e + + except Exception as e: + sdk_exception = SDKException(message=Constants.EXCEPTION, cause=e) + raise sdk_exception + + return True + + @staticmethod + def get_module_names(): + module_data = {} + resources_path = os.path.join(Initializer.get_initializer().resource_path, + Constants.FIELD_DETAILS_DIRECTORY) + if not os.path.exists(resources_path): + os.makedirs(resources_path) + + record_field_details_path = Utility.get_file_name() + + is_null = False + if os.path.exists(record_field_details_path): + json = Initializer.get_json(record_field_details_path) + if Constants.SDK_MODULE_METADATA not in json: + is_null = True + elif json[Constants.SDK_MODULE_METADATA] is None or len(json[Constants.SDK_MODULE_METADATA]) == 0: + is_null = True + + if not os.path.exists(record_field_details_path) or is_null: + module_data = Utility.get_modules(None) + Utility.write_module_meta_data(record_field_details_path, module_data) + return module_data + + record_field_details_json = Initializer.get_json(record_field_details_path) + module_data = record_field_details_json[Constants.SDK_MODULE_METADATA] + return module_data + + @staticmethod + def write_module_meta_data(record_field_details_path, module_data): + field_details_json = Initializer.get_json(record_field_details_path) if os.path.exists( + record_field_details_path) else {} + field_details_json[Constants.SDK_MODULE_METADATA] = module_data + Utility.write_to_file(record_field_details_path, field_details_json) + + @staticmethod + def get_modules(header): + import zohocrmsdk.src.com.zoho.crm.api.modules as Modules + + api_names = {} + header_map = HeaderMap() + if header is not None: + header_value = datetime.datetime.fromtimestamp(header / 1000.0) + header_map.add(Modules.GetModulesHeader.if_modified_since, header_value) + + response = Modules.ModulesOperations().get_modules(header_map) + + if response is not None: + if response.get_status_code() in [Constants.NO_CONTENT_STATUS_CODE, Constants.NOT_MODIFIED_STATUS_CODE]: + return api_names + + response_object = response.get_object() + + if isinstance(response_object, Modules.ResponseWrapper): + modules = response_object.get_modules() + for module in modules: + if module.get_api_supported(): + module_details = dict() + module_details[Constants.API_NAME] = module.get_api_name() + module_details[Constants.GENERATED_TYPE] = module.get_generated_type().get_value() + api_names[module.get_api_name().lower()] = module_details + + elif isinstance(response_object, Modules.APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + + if header is None: + try: + Utility.write_module_meta_data(Utility.get_file_name(), api_names) + except Exception as e: + + raise SDKException(message=Constants.EXCEPTION, cause=e) + + return api_names + + @staticmethod + def refresh_modules(): + Utility.force_refresh = True + Utility.get_fields_info(None) + Utility.force_refresh = False + + @staticmethod + def get_json_object(json, key): + for key_in_json in json.keys(): + if key_in_json.lower() == key.lower(): + return json[key_in_json] + + return None + + @staticmethod + def set_data_type(field_detail, field, module_api_name): + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules.minified_module import MinifiedModule + except: + from ..modules.minified_module import MinifiedModule + + api_type = field.get_data_type() + module = MinifiedModule() + key_name = field.get_api_name() + + if field.get_system_mandatory() is not None and field.get_system_mandatory() and not ( + module_api_name.lower() == Constants.CALLS and key_name.lower() == Constants.CALL_DURATION): + field_detail[Constants.REQUIRED] = True + + if key_name.lower() == Constants.PRICING_DETAILS.lower() and module_api_name.lower() == Constants.PRICE_BOOKS: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.PRICING_DETAILS_NAMESPACE + field_detail[Constants.SKIP_MANDATORY] = True + + return + + elif key_name.lower() == Constants.PARTICIPANT_API_NAME.lower() and ( + module_api_name.lower() == Constants.EVENTS or module_api_name.lower() == Constants.ACTIVITIES): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.PARTICIPANTS + field_detail[Constants.SKIP_MANDATORY] = True + + return + + elif key_name.lower() == Constants.COMMENTS.lower() and \ + (module_api_name.lower() == Constants.SOLUTIONS or module_api_name.lower() == Constants.CASES): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.COMMENT_NAMESPACE + field_detail[Constants.LOOKUP] = True + + return + + elif key_name.lower() == Constants.LAYOUT.lower(): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LAYOUT_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.LAYOUT_NAMESPACE + field_detail[Constants.LOOKUP] = True + + return + + + elif ( + key_name.lower() == Constants.TERRITORIES.lower() or key_name.lower() == Constants.TERRITORY.lower()) and field.get_custom_field() is not None and field.get_custom_field() == False: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.TERRITORY_NAMESPACE + field_detail[Constants.LOOKUP] = True + + return + + elif key_name.lower() == Constants.PRODUCT_NAME.lower() and module_api_name.lower() in Constants.INVENTORY_MODULES_ITEMS: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LINEITEM_PRODUCT + field_detail[Constants.STRUCTURE_NAME] = Constants.LINEITEM_PRODUCT + field_detail[Constants.SKIP_MANDATORY] = True + + return + elif key_name.lower() == Constants.DISCOUNT.lower() and module_api_name.lower() in Constants.INVENTORY_MODULES_ITEMS: + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.STRING_NAMESPACE + + return + elif key_name.lower() == Constants.TAX.lower() and module_api_name.lower() == Constants.PRODUCTS.lower(): + field_detail[Constants.NAME] = key_name + field_detail[Constants.TYPE] = Constants.LIST_NAMESPACE + field_detail[Constants.STRUCTURE_NAME] = Constants.TAX_NAMESPACE + + return + elif api_type in Utility.apitype_vs_datatype: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(api_type) + + elif api_type == Constants.FORMULA.lower(): + if field.get_formula() is not None: + return_type = field.get_formula().get_return_type() + if return_type is not None and return_type in Utility.apitype_vs_datatype and Utility.apitype_vs_datatype.get( + return_type) is not None: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(return_type) + + field_detail[Constants.READ_ONLY] = True + elif api_type == Constants.ROLLUP_SUMMARY.lower(): + if field.get_rollup_summary() is not None: + return_type = field.get_rollup_summary().get_return_type() + if return_type is not None and return_type in Utility.apitype_vs_datatype and Utility.apitype_vs_datatype.get( + return_type) is not None: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(return_type) + elif field.get_json_type() is not None and field.get_json_type() in Utility.apitype_vs_datatype and Utility.apitype_vs_datatype.get( + field.get_json_type()) is not None: + field_detail[Constants.TYPE] = Utility.apitype_vs_datatype.get(field.get_json_type()) + else: + return + + if Constants.LOOKUP in api_type.lower(): + field_detail[Constants.LOOKUP] = True + + if Constants.CONSENT_LOOKUP in api_type.lower() or Constants.OWNER_LOOKUP in api_type.lower(): + field_detail[Constants.SKIP_MANDATORY] = True + + if Constants.MULTI_SELECT_LOOKUP in api_type.lower(): + field_detail[Constants.SKIP_MANDATORY] = True + if field.get_multiselectlookup() is not None and field.get_multiselectlookup().get_linking_module() is not None: + linking_module = field.get_multiselectlookup().get_linking_module() + field_detail[Constants.MODULE] = linking_module.get_api_name() + module = linking_module + + field_detail[Constants.SUBFORM] = True + + if Constants.MULTI_USER_LOOKUP in api_type.lower(): + field_detail[Constants.SKIP_MANDATORY] = True + if field.get_multiuserlookup() is not None and field.get_multiuserlookup().get_linking_module() is not None: + linking_module = field.get_multiuserlookup().get_linking_module() + field_detail[Constants.MODULE] = linking_module.get_api_name() + module = linking_module + + field_detail[Constants.SUBFORM] = True + + if api_type in Utility.apitype_vs_structurename: + field_detail[Constants.STRUCTURE_NAME] = Utility.apitype_vs_structurename.get(api_type) + + if api_type.lower() == Constants.PICKLIST and field.get_pick_list_values() is not None and len( + field.get_pick_list_values()) > 0: + field_detail[Constants.PICKLIST] = True + values = list(map(lambda x: x.get_display_value(), field.get_pick_list_values())) + field_detail[Constants.VALUES] = values + + if api_type.lower() == Constants.SUBFORM and field.get_associated_module() is not None: + module.set_api_name(field.get_associated_module().get_module()) + field_detail[Constants.MODULE] = module.get_api_name() + field_detail[Constants.SKIP_MANDATORY] = True + field_detail[Constants.SUBFORM] = True + + if api_type == Constants.LOOKUP and field.get_lookup() is not None: + module1 = field.get_lookup().get_module() + + if module1 is not None and not module1.get_api_name() == Constants.SE_MODULE: + module.set_api_name(module1.get_api_name()) + module.set_id(module1.get_id()) + field_detail[Constants.MODULE] = module.get_api_name() + if module1.get_api_name().lower() == Constants.ACCOUNTS and not ( + field.get_custom_field() and not field.get_custom_field()): + field_detail[Constants.SKIP_MANDATORY] = True + + else: + module = MinifiedModule() + + field_detail[Constants.LOOKUP] = True + + if module is not None and module.get_api_name() is not None and len(module.get_api_name()) > 0: + Utility.get_fields_info(module.get_api_name(), None) + + field_detail[Constants.NAME] = key_name + + @staticmethod + def fill_data_type(): + if len(Utility.apitype_vs_datatype) > 0: + return + + field_api_names_string = ["textarea", "text", "website", "email", "phone", "mediumtext", + "profileimage", "autonumber"] + + field_api_names_integer = ['integer'] + + field_api_names_boolean = ['boolean'] + + field_api_names_long = ['long', 'bigint'] + + field_api_names_double = ['double', 'percent', 'lookup', 'currency'] + + field_api_names_field_file = ['fileupload'] + + field_api_names_datetime = ['datetime', 'event_reminder'] + + field_api_names_date = ['date'] + + field_api_names_lookup = ['lookup'] + + field_api_names_picklist = ['picklist'] + + field_api_names_multiselect_picklist = ['multiselectpicklist'] + + field_api_names_subform = ['subform'] + + field_api_names_owner_lookup = ['ownerlookup', 'userlookup'] + + field_api_names_multiuser_lookup = ['multiuserlookup'] + + field_api_name_task_remind_at = ['ALARM'] + + field_api_name_recurring_activity = ['RRULE'] + + field_api_name_reminder = ['multireminder'] + + field_api_name_consent_lookup = ['consent_lookup'] + + field_api_name_image_upload = ["imageupload"] + + field_api_name_multiselect_lookup = ["multiselectlookup"] + + field_api_name_line_tax = ["linetax"] + field_api_name_module = ["module"] + field_api_name_layout = ["layout"] + field_api_name_multi_module_look_up = ["multi_module_lookup"] + field_api_name_time_range = ["time_range"] + + for field_api_name in field_api_names_string: + Utility.apitype_vs_datatype[field_api_name] = Constants.STRING_NAMESPACE + + for field_api_name in field_api_names_integer: + Utility.apitype_vs_datatype[field_api_name] = Constants.INTEGER_NAMESPACE + + for field_api_name in field_api_names_boolean: + Utility.apitype_vs_datatype[field_api_name] = Constants.BOOLEAN_NAMESPACE + + for field_api_name in field_api_names_double: + Utility.apitype_vs_datatype[field_api_name] = Constants.DOUBLE_NAMESPACE + + for field_api_name in field_api_names_long: + Utility.apitype_vs_datatype[field_api_name] = Constants.INTEGER_NAMESPACE + + for field_api_name in field_api_names_datetime: + Utility.apitype_vs_datatype[field_api_name] = Constants.DATETIME_NAMESPACE + + for field_api_name in field_api_names_date: + Utility.apitype_vs_datatype[field_api_name] = Constants.DATE_NAMESPACE + + for field_api_name in field_api_names_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.RECORD_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_names_owner_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.USER_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.USER_NAMESPACE + + for field_api_name in field_api_names_multiuser_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_names_picklist: + Utility.apitype_vs_datatype[field_api_name] = Constants.CHOICE_NAMESPACE + + for field_api_name in field_api_names_multiselect_picklist: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.CHOICE_NAMESPACE + + for field_api_name in field_api_names_subform: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_names_field_file: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.FIELD_FILE_NAMESPACE + + for field_api_name in field_api_name_task_remind_at: + Utility.apitype_vs_datatype[field_api_name] = Constants.REMIND_AT_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.REMIND_AT_NAMESPACE + + for field_api_name in field_api_name_recurring_activity: + Utility.apitype_vs_datatype[field_api_name] = Constants.RECURRING_ACTIVITY_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECURRING_ACTIVITY_NAMESPACE + + for field_api_name in field_api_name_reminder: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.REMINDER_NAMESPACE + + for field_api_name in field_api_name_consent_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.CONSENT_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.CONSENT_NAMESPACE + + for field_api_name in field_api_name_image_upload: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.IMAGE_UPLOAD_NAMESPACE + + for field_api_name in field_api_name_multiselect_lookup: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + + for field_api_name in field_api_name_line_tax: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.LINE_TAX_NAMESPACE + for field_api_name in field_api_name_multi_module_look_up: + Utility.apitype_vs_datatype[field_api_name] = Constants.RECORD_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.RECORD_NAMESPACE + for field_api_name in field_api_name_module: + Utility.apitype_vs_datatype[field_api_name] = Constants.MODULE_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.MODULE_NAMESPACE + for field_api_name in field_api_name_layout: + Utility.apitype_vs_datatype[field_api_name] = Constants.LAYOUT_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.LAYOUT_NAMESPACE + for field_api_name in field_api_name_time_range: + Utility.apitype_vs_datatype[field_api_name] = Constants.LIST_NAMESPACE + Utility.apitype_vs_structurename[field_api_name] = Constants.TIME_RANGE_NAMESPACE + + @staticmethod + def check_data_type(value, data_type): + if value is None: + return False + if data_type.lower() == Constants.OBJECT.lower(): + return True + if data_type in Constants.DATA_TYPE: + data_type = Constants.DATA_TYPE.get(data_type) + class_name1 = value.__class__ + if class_name1 == data_type: + return True + else: + class_name = value.__class__.__module__ + if class_name.lower() == data_type.lower(): + return True + return False + + @staticmethod + def write_to_file(file_path, file_contents): + with open(file_path, mode="w") as file: + json.dump(file_contents, file) + file.flush() + file.close() + + @staticmethod + def get_user_name(token): + try: + from zohocrmsdk.src.com.zoho.crm.api.users.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.users.response_wrapper import ResponseWrapper + from zohocrmsdk.src.com.zoho.crm.api.users.users_operations import GetUsersParam + from zohocrmsdk.src.com.zoho.crm.api.users.api_exception import APIException + from zohocrmsdk.src.com.zoho.crm.api.util import CommonAPIHandler + from zohocrmsdk.src.com.zoho.crm.api.util.choice import Choice + except Exception: + from ..users.response_handler import ResponseHandler + from ..users.response_wrapper import ResponseWrapper + from ..users.users_operations import GetUsersParam + from ..users.api_exception import APIException + from ..util.common_api_handler import CommonAPIHandler + from ..util.choice import Choice + user_name = None + param_instance = ParameterMap() + param_instance.add(GetUsersParam.type, Choice(Constants.CURRENTUSER)) + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/users' + 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.set_param(param_instance) + header_instance = HeaderMap() + header_instance.add(Header(Constants.AUTHORIZATION, Constants.STRING_NAMESPACE), + Constants.OAUTH_HEADER_PREFIX + token) + handler_instance.set_header(header_instance) + response = handler_instance.api_call(ResponseHandler.__module__, 'application/json') + if response is not None: + if response.get_status_code() in [204, 304]: + return None + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + user_list = response_object.get_users() + for user in user_list: + user_name = user.get_email() + break + elif isinstance(response_object, APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + return user_name + ":" + Utility.get_user_org_id(token) + + @staticmethod + def get_user_org_id(token): + try: + from zohocrmsdk.src.com.zoho.crm.api.org.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.org.response_wrapper import ResponseWrapper + from zohocrmsdk.src.com.zoho.crm.api.org.api_exception import APIException + from zohocrmsdk.src.com.zoho.crm.api.util import CommonAPIHandler + except Exception: + from ..org.response_handler import ResponseHandler + from ..org.response_wrapper import ResponseWrapper + from ..org.api_exception import APIException + from ..util import CommonAPIHandler + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/org' + 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) + header_instance = HeaderMap() + header_instance.add(Header(Constants.AUTHORIZATION, Constants.STRING_NAMESPACE), + Constants.OAUTH_HEADER_PREFIX + token) + handler_instance.set_header(header_instance) + response = handler_instance.api_call(ResponseHandler.__module__, 'application/json') + if response is not None: + response_object = response.get_object() + if response_object is not None: + if isinstance(response_object, ResponseWrapper): + org_list = response_object.get_org() + for org in org_list: + return org.get_zgid() + elif isinstance(response_object, APIException): + error_response = { + Constants.CODE: response_object.get_code().get_value(), + Constants.STATUS: response_object.get_status().get_value(), + Constants.MESSAGE: response_object.get_message() + } + raise SDKException(code=Constants.API_EXCEPTION, details=error_response) + return None diff --git a/zohocrmsdk/src/com/zoho/crm/api/util/xml_converter.py b/zohocrmsdk/src/com/zoho/crm/api/util/xml_converter.py new file mode 100755 index 0000000..51d1db0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/util/xml_converter.py @@ -0,0 +1,48 @@ +try: + from .converter import Converter + import importlib + import logging + import re + import json + +except Exception: + import importlib + from .converter import Converter + import logging + import re + import json + + +class XMLConverter(Converter): + + """ + This class processes the API response object to the POJO object and POJO object to an XML object. + """ + + logger = logging.getLogger('SDKLogger') + + def __init__(self, common_api_handler): + + super().__init__(common_api_handler) + + self.unique_dict = {} + + self.count = 0 + + self.common_api_handler = common_api_handler + + def form_request(self, request_instance, pack, instance_number, class_member_detail): + + return None + + def append_to_request(self, request_base, request_object): + + return None + + def get_wrapped_response(self, response, pack): + + return None + + def get_response(self, response, pack): + + return None diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/__init__.py new file mode 100644 index 0000000..fac839c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .response_handler import ResponseHandler +from .minified_variable_group import MinifiedVariableGroup +from .response_wrapper import ResponseWrapper +from .variable_group import VariableGroup +from .variable_groups_operations import VariableGroupsOperations diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/api_exception.py new file mode 100644 index 0000000..ad1ca2b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__status = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/minified_variable_group.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/minified_variable_group.py new file mode 100644 index 0000000..cc56855 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/minified_variable_group.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class MinifiedVariableGroup(object): + def __init__(self): + """Creates an instance of MinifiedVariableGroup""" + + self.__id = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_wrapper.py new file mode 100644 index 0000000..a73fea4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__variable_groups = None + self.__key_modified = dict() + + def get_variable_groups(self): + """ + The method to get the variable_groups + + Returns: + list: An instance of list + """ + + return self.__variable_groups + + def set_variable_groups(self, variable_groups): + """ + The method to set the value to variable_groups + + Parameters: + variable_groups (list) : An instance of list + """ + + if variable_groups is not None and not isinstance(variable_groups, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variable_groups EXPECTED TYPE: list', None, None) + + self.__variable_groups = variable_groups + self.__key_modified['variable_groups'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_group.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_group.py new file mode 100644 index 0000000..7a4057b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_group.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class VariableGroup(object): + def __init__(self): + """Creates an instance of VariableGroup""" + + self.__display_label = None + self.__api_name = None + self.__name = None + self.__description = None + self.__id = None + self.__source = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_groups_operations.py b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_groups_operations.py new file mode 100644 index 0000000..1f58352 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variable_groups/variable_groups_operations.py @@ -0,0 +1,95 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + + +class VariableGroupsOperations(object): + def __init__(self): + """Creates an instance of VariableGroupsOperations""" + pass + + def get_variable_groups(self): + """ + The method to get variable groups + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/variable_groups' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_variable_group_by_id(self, id): + """ + The method to get variable group by id + + Parameters: + id (string) : A string representing the id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/variable_groups/' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_variable_group_by_api_name(self, api_name): + """ + The method to get variable group by api name + + Parameters: + api_name (string) : A string representing the api_name + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/variable_groups/' + api_path = api_path + str(api_name) + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variable_groups.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/variables/__init__.py new file mode 100644 index 0000000..fd94fe3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/__init__.py @@ -0,0 +1,11 @@ +from .action_wrapper import ActionWrapper +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .variables_operations import VariablesOperations, GetVariablesParam, DeleteVariablesParam, GetVariableByIDParam, UpdateVariableByIDParam, UpdateVariableByAPINameParam, GetVariableByAPINameParam +from .variable import Variable +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .body_wrapper import BodyWrapper +from .variable_group import VariableGroup diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/variables/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/variables/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/variables/action_wrapper.py new file mode 100644 index 0000000..bcd5e52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__variables = None + self.__key_modified = dict() + + def get_variables(self): + """ + The method to get the variables + + Returns: + list: An instance of list + """ + + return self.__variables + + def set_variables(self, variables): + """ + The method to set the value to variables + + Parameters: + variables (list) : An instance of list + """ + + if variables is not None and not isinstance(variables, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variables EXPECTED TYPE: list', None, None) + + self.__variables = variables + self.__key_modified['variables'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/variables/api_exception.py new file mode 100644 index 0000000..e4cca69 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/variables/body_wrapper.py new file mode 100644 index 0000000..7c2a13f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__variables = None + self.__key_modified = dict() + + def get_variables(self): + """ + The method to get the variables + + Returns: + list: An instance of list + """ + + return self.__variables + + def set_variables(self, variables): + """ + The method to set the value to variables + + Parameters: + variables (list) : An instance of list + """ + + if variables is not None and not isinstance(variables, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variables EXPECTED TYPE: list', None, None) + + self.__variables = variables + self.__key_modified['variables'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/variables/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/variables/response_wrapper.py new file mode 100644 index 0000000..81e9e83 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__variables = None + self.__key_modified = dict() + + def get_variables(self): + """ + The method to get the variables + + Returns: + list: An instance of list + """ + + return self.__variables + + def set_variables(self, variables): + """ + The method to set the value to variables + + Parameters: + variables (list) : An instance of list + """ + + if variables is not None and not isinstance(variables, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variables EXPECTED TYPE: list', None, None) + + self.__variables = variables + self.__key_modified['variables'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/variables/success_response.py new file mode 100644 index 0000000..33718fc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.variables.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__message = None + self.__status = None + self.__details = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/variable.py b/zohocrmsdk/src/com/zoho/crm/api/variables/variable.py new file mode 100644 index 0000000..f06605f --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/variable.py @@ -0,0 +1,276 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class Variable(object): + def __init__(self): + """Creates an instance of Variable""" + + self.__api_name = None + self.__name = None + self.__description = None + self.__source = None + self.__id = None + self.__type = None + self.__variable_group = None + self.__read_only = None + self.__value = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 get_source(self): + """ + The method to get the source + + Returns: + string: A string representing the source + """ + + return self.__source + + def set_source(self, source): + """ + The method to set the value to source + + Parameters: + source (string) : A string representing the source + """ + + if source is not None and not isinstance(source, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source EXPECTED TYPE: str', None, None) + + self.__source = source + self.__key_modified['source'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_variable_group(self): + """ + The method to get the variable_group + + Returns: + VariableGroup: An instance of VariableGroup + """ + + return self.__variable_group + + def set_variable_group(self, variable_group): + """ + The method to set the value to variable_group + + Parameters: + variable_group (VariableGroup) : An instance of VariableGroup + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.variable_group import VariableGroup + except Exception: + from .variable_group import VariableGroup + + if variable_group is not None and not isinstance(variable_group, VariableGroup): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: variable_group EXPECTED TYPE: VariableGroup', None, None) + + self.__variable_group = variable_group + self.__key_modified['variable_group'] = 1 + + def get_read_only(self): + """ + The method to get the read_only + + Returns: + bool: A bool representing the read_only + """ + + return self.__read_only + + def set_read_only(self, read_only): + """ + The method to set the value to read_only + + Parameters: + read_only (bool) : A bool representing the read_only + """ + + if read_only is not None and not isinstance(read_only, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: read_only EXPECTED TYPE: bool', None, None) + + self.__read_only = read_only + self.__key_modified['read_only'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/variable_group.py b/zohocrmsdk/src/com/zoho/crm/api/variables/variable_group.py new file mode 100644 index 0000000..e915aee --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/variable_group.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class VariableGroup(object): + def __init__(self): + """Creates an instance of VariableGroup""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/variables/variables_operations.py b/zohocrmsdk/src/com/zoho/crm/api/variables/variables_operations.py new file mode 100644 index 0000000..ede6160 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/variables/variables_operations.py @@ -0,0 +1,394 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class VariablesOperations(object): + def __init__(self): + """Creates an instance of VariablesOperations""" + pass + + def get_variables(self, param_instance=None): + """ + The method to get variables + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/variables' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_variables(self, request): + """ + The method to create variables + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/variables' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_variables(self, request): + """ + The method to update variables + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/variables' + 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.set_mandatory_checker(True) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_variables(self, param_instance=None): + """ + The method to delete variables + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/settings/variables' + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_variable_by_id(self, id, param_instance=None): + """ + The method to get variable by id + + Parameters: + id (int) : An int representing the id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + 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/v7/settings/variables/' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_variable_by_id(self, id, request, param_instance=None): + """ + The method to update variable by id + + Parameters: + id (int) : An int representing the id + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: 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) + + 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/v7/settings/variables/' + api_path = api_path + str(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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_variable(self, id): + """ + The method to delete variable + + 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/v7/settings/variables/' + api_path = api_path + str(id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_variable_by_apiname(self, api_name, request, param_instance=None): + """ + The method to update variable by apiname + + Parameters: + api_name (string) : A string representing the api_name + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', 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) + + 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/v7/settings/variables/' + api_path = api_path + str(api_name) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_PUT) + handler_instance.set_category_method(Constants.REQUEST_CATEGORY_ACTION) + handler_instance.set_content_type('application/json') + handler_instance.set_request(request) + handler_instance.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_variable_by_apiname(self, api_name, param_instance=None): + """ + The method to get variable by apiname + + Parameters: + api_name (string) : A string representing the api_name + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + 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/v7/settings/variables/' + api_path = api_path + str(api_name) + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.variables.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetVariablesParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.GetVariablesParam') + + +class DeleteVariablesParam(object): + ids = Param('ids', 'com.zoho.crm.api.Variables.DeleteVariablesParam') + + +class GetVariableByIDParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.GetVariableByIDParam') + + +class UpdateVariableByIDParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.UpdateVariableByIDParam') + + +class UpdateVariableByAPINameParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.UpdateVariableByAPINameParam') + + +class GetVariableByAPINameParam(object): + group = Param('group', 'com.zoho.crm.api.Variables.GetVariableByAPINameParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/__init__.py new file mode 100644 index 0000000..93530f6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/__init__.py @@ -0,0 +1,28 @@ +from .acknowledge_visitor import AcknowledgeVisitor +from .button_attributes import ButtonAttributes +from .auto_response_rule import AutoResponseRule +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .webforms_operations import WebformsOperations, GetWebFormsParam, CreateWebFormsParam, UpdateWebFormsParam, GetWebFormParam, UpdateWebFormParam, DeleteWebFormsParam, GetWebformsPreviewParam +from .success_response import SuccessResponse +from .abtesting import Abtesting +from .action_handler import ActionHandler +from .from_address import FromAddress +from .owner import Owner +from .action_wrapper import ActionWrapper +from .acknowledge_visitors import AcknowledgeVisitors +from .analytics_data import AnalyticsData +from .suggestion import Suggestion +from .module import Module +from .font_attributes import FontAttributes +from .web_form import WebForm +from .body_wrapper import BodyWrapper +from .form_attributes import FormAttributes +from .tags import Tags +from .layout import Layout +from .assignment_rule import AssignmentRule +from .response_wrapper import ResponseWrapper +from .fields import Fields +from .user import User +from .spam_controll import SpamControll diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/abtesting.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/abtesting.py new file mode 100644 index 0000000..de235ae --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/abtesting.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Abtesting(object): + def __init__(self): + """Creates an instance of Abtesting""" + + self.__module = None + self.__name = None + self.__id = None + self.__status = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitor.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitor.py new file mode 100644 index 0000000..285a60b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitor.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AcknowledgeVisitor(object): + def __init__(self): + """Creates an instance of AcknowledgeVisitor""" + + self.__auto_response_rule = None + self.__template_id = None + self.__key_modified = dict() + + def get_auto_response_rule(self): + """ + The method to get the auto_response_rule + + Returns: + AutoResponseRule: An instance of AutoResponseRule + """ + + return self.__auto_response_rule + + def set_auto_response_rule(self, auto_response_rule): + """ + The method to set the value to auto_response_rule + + Parameters: + auto_response_rule (AutoResponseRule) : An instance of AutoResponseRule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.auto_response_rule import AutoResponseRule + except Exception: + from .auto_response_rule import AutoResponseRule + + if auto_response_rule is not None and not isinstance(auto_response_rule, AutoResponseRule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: auto_response_rule EXPECTED TYPE: AutoResponseRule', None, None) + + self.__auto_response_rule = auto_response_rule + self.__key_modified['auto_response_rule'] = 1 + + def get_template_id(self): + """ + The method to get the template_id + + Returns: + int: An int representing the template_id + """ + + return self.__template_id + + def set_template_id(self, template_id): + """ + The method to set the value to template_id + + Parameters: + template_id (int) : An int representing the template_id + """ + + if template_id is not None and not isinstance(template_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template_id EXPECTED TYPE: int', None, None) + + self.__template_id = template_id + self.__key_modified['template_id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitors.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitors.py new file mode 100644 index 0000000..b52a3fa --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/acknowledge_visitors.py @@ -0,0 +1,129 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AcknowledgeVisitors(object): + def __init__(self): + """Creates an instance of AcknowledgeVisitors""" + + self.__template_name = None + self.__template_id = None + self.__from_address = None + self.__key_modified = dict() + + def get_template_name(self): + """ + The method to get the template_name + + Returns: + string: A string representing the template_name + """ + + return self.__template_name + + def set_template_name(self, template_name): + """ + The method to set the value to template_name + + Parameters: + template_name (string) : A string representing the template_name + """ + + if template_name is not None and not isinstance(template_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template_name EXPECTED TYPE: str', None, None) + + self.__template_name = template_name + self.__key_modified['template_name'] = 1 + + def get_template_id(self): + """ + The method to get the template_id + + Returns: + int: An int representing the template_id + """ + + return self.__template_id + + def set_template_id(self, template_id): + """ + The method to set the value to template_id + + Parameters: + template_id (int) : An int representing the template_id + """ + + if template_id is not None and not isinstance(template_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: template_id EXPECTED TYPE: int', None, None) + + self.__template_id = template_id + self.__key_modified['template_id'] = 1 + + def get_from_address(self): + """ + The method to get the from_address + + Returns: + FromAddress: An instance of FromAddress + """ + + return self.__from_address + + def set_from_address(self, from_address): + """ + The method to set the value to from_address + + Parameters: + from_address (FromAddress) : An instance of FromAddress + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.from_address import FromAddress + except Exception: + from .from_address import FromAddress + + if from_address is not None and not isinstance(from_address, FromAddress): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: from_address EXPECTED TYPE: FromAddress', None, None) + + self.__from_address = from_address + self.__key_modified['from_address'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/action_wrapper.py new file mode 100644 index 0000000..9966dfc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__webforms = None + self.__key_modified = dict() + + def get_webforms(self): + """ + The method to get the webforms + + Returns: + list: An instance of list + """ + + return self.__webforms + + def set_webforms(self, webforms): + """ + The method to set the value to webforms + + Parameters: + webforms (list) : An instance of list + """ + + if webforms is not None and not isinstance(webforms, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webforms EXPECTED TYPE: list', None, None) + + self.__webforms = webforms + self.__key_modified['webforms'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/analytics_data.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/analytics_data.py new file mode 100644 index 0000000..c534d14 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/analytics_data.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AnalyticsData(object): + def __init__(self): + """Creates an instance of AnalyticsData""" + + self.__iframe_url_tracking_code = None + self.__url_analytics_enabled = None + self.__analytics_enabled = None + self.__analytics_enabled_time = None + self.__tracking_code = None + self.__key_modified = dict() + + def get_iframe_url_tracking_code(self): + """ + The method to get the iframe_url_tracking_code + + Returns: + string: A string representing the iframe_url_tracking_code + """ + + return self.__iframe_url_tracking_code + + def set_iframe_url_tracking_code(self, iframe_url_tracking_code): + """ + The method to set the value to iframe_url_tracking_code + + Parameters: + iframe_url_tracking_code (string) : A string representing the iframe_url_tracking_code + """ + + if iframe_url_tracking_code is not None and not isinstance(iframe_url_tracking_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iframe_url_tracking_code EXPECTED TYPE: str', None, None) + + self.__iframe_url_tracking_code = iframe_url_tracking_code + self.__key_modified['iframe_url_tracking_code'] = 1 + + def get_url_analytics_enabled(self): + """ + The method to get the url_analytics_enabled + + Returns: + bool: A bool representing the url_analytics_enabled + """ + + return self.__url_analytics_enabled + + def set_url_analytics_enabled(self, url_analytics_enabled): + """ + The method to set the value to url_analytics_enabled + + Parameters: + url_analytics_enabled (bool) : A bool representing the url_analytics_enabled + """ + + if url_analytics_enabled is not None and not isinstance(url_analytics_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: url_analytics_enabled EXPECTED TYPE: bool', None, None) + + self.__url_analytics_enabled = url_analytics_enabled + self.__key_modified['url_analytics_enabled'] = 1 + + def get_analytics_enabled(self): + """ + The method to get the analytics_enabled + + Returns: + bool: A bool representing the analytics_enabled + """ + + return self.__analytics_enabled + + def set_analytics_enabled(self, analytics_enabled): + """ + The method to set the value to analytics_enabled + + Parameters: + analytics_enabled (bool) : A bool representing the analytics_enabled + """ + + if analytics_enabled is not None and not isinstance(analytics_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics_enabled EXPECTED TYPE: bool', None, None) + + self.__analytics_enabled = analytics_enabled + self.__key_modified['analytics_enabled'] = 1 + + def get_analytics_enabled_time(self): + """ + The method to get the analytics_enabled_time + + Returns: + datetime: An instance of datetime + """ + + return self.__analytics_enabled_time + + def set_analytics_enabled_time(self, analytics_enabled_time): + """ + The method to set the value to analytics_enabled_time + + Parameters: + analytics_enabled_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if analytics_enabled_time is not None and not isinstance(analytics_enabled_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics_enabled_time EXPECTED TYPE: datetime', None, None) + + self.__analytics_enabled_time = analytics_enabled_time + self.__key_modified['analytics_enabled_time'] = 1 + + def get_tracking_code(self): + """ + The method to get the tracking_code + + Returns: + string: A string representing the tracking_code + """ + + return self.__tracking_code + + def set_tracking_code(self, tracking_code): + """ + The method to set the value to tracking_code + + Parameters: + tracking_code (string) : A string representing the tracking_code + """ + + if tracking_code is not None and not isinstance(tracking_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tracking_code EXPECTED TYPE: str', None, None) + + self.__tracking_code = tracking_code + self.__key_modified['tracking_code'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/api_exception.py new file mode 100644 index 0000000..ec59637 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ActionResponse, ResponseHandler, ActionHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/assignment_rule.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/assignment_rule.py new file mode 100644 index 0000000..bbf3f23 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/assignment_rule.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AssignmentRule(object): + def __init__(self): + """Creates an instance of AssignmentRule""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/auto_response_rule.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/auto_response_rule.py new file mode 100644 index 0000000..9ce896a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/auto_response_rule.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AutoResponseRule(object): + def __init__(self): + """Creates an instance of AutoResponseRule""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/body_wrapper.py new file mode 100644 index 0000000..8440791 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__webforms = None + self.__key_modified = dict() + + def get_webforms(self): + """ + The method to get the webforms + + Returns: + list: An instance of list + """ + + return self.__webforms + + def set_webforms(self, webforms): + """ + The method to set the value to webforms + + Parameters: + webforms (list) : An instance of list + """ + + if webforms is not None and not isinstance(webforms, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webforms EXPECTED TYPE: list', None, None) + + self.__webforms = webforms + self.__key_modified['webforms'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/button_attributes.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/button_attributes.py new file mode 100644 index 0000000..c1a32cb --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/button_attributes.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ButtonAttributes(object): + def __init__(self): + """Creates an instance of ButtonAttributes""" + + self.__color = None + self.__name = None + self.__key_modified = dict() + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/fields.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/fields.py new file mode 100644 index 0000000..2afcc23 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/fields.py @@ -0,0 +1,464 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Fields(object): + def __init__(self): + """Creates an instance of Fields""" + + self.__layout = None + self.__help = None + self.__field = None + self.__module = None + self.__secret_key = None + self.__recaptcha_label = None + self.__hidden = None + self.__site_key = None + self.__advanced = None + self.__api_name = None + self.__field_label = None + self.__theme = None + self.__id = None + self.__required = None + self.__field_name = None + self.__date_format = None + self.__key_modified = dict() + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_help(self): + """ + The method to get the help + + Returns: + string: A string representing the help + """ + + return self.__help + + def set_help(self, help): + """ + The method to set the value to help + + Parameters: + help (string) : A string representing the help + """ + + if help is not None and not isinstance(help, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: help EXPECTED TYPE: str', None, None) + + self.__help = help + self.__key_modified['help'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Fields: An instance of Fields + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Fields) : An instance of Fields + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.fields import Fields + except Exception: + from .fields import Fields + + if field is not None and not isinstance(field, Fields): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Fields', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_secret_key(self): + """ + The method to get the secret_key + + Returns: + string: A string representing the secret_key + """ + + return self.__secret_key + + def set_secret_key(self, secret_key): + """ + The method to set the value to secret_key + + Parameters: + secret_key (string) : A string representing the secret_key + """ + + if secret_key is not None and not isinstance(secret_key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secret_key EXPECTED TYPE: str', None, None) + + self.__secret_key = secret_key + self.__key_modified['secret_key'] = 1 + + def get_recaptcha_label(self): + """ + The method to get the recaptcha_label + + Returns: + string: A string representing the recaptcha_label + """ + + return self.__recaptcha_label + + def set_recaptcha_label(self, recaptcha_label): + """ + The method to set the value to recaptcha_label + + Parameters: + recaptcha_label (string) : A string representing the recaptcha_label + """ + + if recaptcha_label is not None and not isinstance(recaptcha_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: recaptcha_label EXPECTED TYPE: str', None, None) + + self.__recaptcha_label = recaptcha_label + self.__key_modified['recaptcha_label'] = 1 + + def get_hidden(self): + """ + The method to get the hidden + + Returns: + bool: A bool representing the hidden + """ + + return self.__hidden + + def set_hidden(self, hidden): + """ + The method to set the value to hidden + + Parameters: + hidden (bool) : A bool representing the hidden + """ + + if hidden is not None and not isinstance(hidden, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: hidden EXPECTED TYPE: bool', None, None) + + self.__hidden = hidden + self.__key_modified['hidden'] = 1 + + def get_site_key(self): + """ + The method to get the site_key + + Returns: + string: A string representing the site_key + """ + + return self.__site_key + + def set_site_key(self, site_key): + """ + The method to set the value to site_key + + Parameters: + site_key (string) : A string representing the site_key + """ + + if site_key is not None and not isinstance(site_key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: site_key EXPECTED TYPE: str', None, None) + + self.__site_key = site_key + self.__key_modified['site_key'] = 1 + + def get_advanced(self): + """ + The method to get the advanced + + Returns: + bool: A bool representing the advanced + """ + + return self.__advanced + + def set_advanced(self, advanced): + """ + The method to set the value to advanced + + Parameters: + advanced (bool) : A bool representing the advanced + """ + + if advanced is not None and not isinstance(advanced, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: advanced EXPECTED TYPE: bool', None, None) + + self.__advanced = advanced + self.__key_modified['advanced'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_field_label(self): + """ + The method to get the field_label + + Returns: + string: A string representing the field_label + """ + + return self.__field_label + + def set_field_label(self, field_label): + """ + The method to set the value to field_label + + Parameters: + field_label (string) : A string representing the field_label + """ + + if field_label is not None and not isinstance(field_label, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_label EXPECTED TYPE: str', None, None) + + self.__field_label = field_label + self.__key_modified['field_label'] = 1 + + def get_theme(self): + """ + The method to get the theme + + Returns: + string: A string representing the theme + """ + + return self.__theme + + def set_theme(self, theme): + """ + The method to set the value to theme + + Parameters: + theme (string) : A string representing the theme + """ + + if theme is not None and not isinstance(theme, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: theme EXPECTED TYPE: str', None, None) + + self.__theme = theme + self.__key_modified['theme'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_required(self): + """ + The method to get the required + + Returns: + bool: A bool representing the required + """ + + return self.__required + + def set_required(self, required): + """ + The method to set the value to required + + Parameters: + required (bool) : A bool representing the required + """ + + if required is not None and not isinstance(required, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: required EXPECTED TYPE: bool', None, None) + + self.__required = required + self.__key_modified['required'] = 1 + + def get_field_name(self): + """ + The method to get the field_name + + Returns: + string: A string representing the field_name + """ + + return self.__field_name + + def set_field_name(self, field_name): + """ + The method to set the value to field_name + + Parameters: + field_name (string) : A string representing the field_name + """ + + if field_name is not None and not isinstance(field_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field_name EXPECTED TYPE: str', None, None) + + self.__field_name = field_name + self.__key_modified['field_name'] = 1 + + def get_date_format(self): + """ + The method to get the date_format + + Returns: + string: A string representing the date_format + """ + + return self.__date_format + + def set_date_format(self, date_format): + """ + The method to set the value to date_format + + Parameters: + date_format (string) : A string representing the date_format + """ + + if date_format is not None and not isinstance(date_format, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: date_format EXPECTED TYPE: str', None, None) + + self.__date_format = date_format + self.__key_modified['date_format'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/font_attributes.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/font_attributes.py new file mode 100644 index 0000000..67b5d92 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/font_attributes.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FontAttributes(object): + def __init__(self): + """Creates an instance of FontAttributes""" + + self.__size = None + self.__color = None + self.__family = None + self.__key_modified = dict() + + def get_size(self): + """ + The method to get the size + + Returns: + int: An int representing the size + """ + + return self.__size + + def set_size(self, size): + """ + The method to set the value to size + + Parameters: + size (int) : An int representing the size + """ + + if size is not None and not isinstance(size, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: size EXPECTED TYPE: int', None, None) + + self.__size = size + self.__key_modified['size'] = 1 + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_family(self): + """ + The method to get the family + + Returns: + string: A string representing the family + """ + + return self.__family + + def set_family(self, family): + """ + The method to set the value to family + + Parameters: + family (string) : A string representing the family + """ + + if family is not None and not isinstance(family, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: family EXPECTED TYPE: str', None, None) + + self.__family = family + self.__key_modified['family'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/form_attributes.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/form_attributes.py new file mode 100644 index 0000000..cb13a64 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/form_attributes.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FormAttributes(object): + def __init__(self): + """Creates an instance of FormAttributes""" + + self.__color = None + self.__width = None + self.__font_attributes = None + self.__align = None + self.__display_form_name = None + self.__key_modified = dict() + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_width(self): + """ + The method to get the width + + Returns: + int: An int representing the width + """ + + return self.__width + + def set_width(self, width): + """ + The method to set the value to width + + Parameters: + width (int) : An int representing the width + """ + + if width is not None and not isinstance(width, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: width EXPECTED TYPE: int', None, None) + + self.__width = width + self.__key_modified['width'] = 1 + + def get_font_attributes(self): + """ + The method to get the font_attributes + + Returns: + FontAttributes: An instance of FontAttributes + """ + + return self.__font_attributes + + def set_font_attributes(self, font_attributes): + """ + The method to set the value to font_attributes + + Parameters: + font_attributes (FontAttributes) : An instance of FontAttributes + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.font_attributes import FontAttributes + except Exception: + from .font_attributes import FontAttributes + + if font_attributes is not None and not isinstance(font_attributes, FontAttributes): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: font_attributes EXPECTED TYPE: FontAttributes', None, None) + + self.__font_attributes = font_attributes + self.__key_modified['font_attributes'] = 1 + + def get_align(self): + """ + The method to get the align + + Returns: + string: A string representing the align + """ + + return self.__align + + def set_align(self, align): + """ + The method to set the value to align + + Parameters: + align (string) : A string representing the align + """ + + if align is not None and not isinstance(align, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: align EXPECTED TYPE: str', None, None) + + self.__align = align + self.__key_modified['align'] = 1 + + def get_display_form_name(self): + """ + The method to get the display_form_name + + Returns: + string: A string representing the display_form_name + """ + + return self.__display_form_name + + def set_display_form_name(self, display_form_name): + """ + The method to set the value to display_form_name + + Parameters: + display_form_name (string) : A string representing the display_form_name + """ + + if display_form_name is not None and not isinstance(display_form_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: display_form_name EXPECTED TYPE: str', None, None) + + self.__display_form_name = display_form_name + self.__key_modified['display_form_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/from_address.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/from_address.py new file mode 100644 index 0000000..5780ece --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/from_address.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class FromAddress(object): + def __init__(self): + """Creates an instance of FromAddress""" + + self.__id = None + self.__type = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/layout.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/layout.py new file mode 100644 index 0000000..50dd4c2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/layout.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Layout(object): + def __init__(self): + """Creates an instance of Layout""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/module.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/module.py new file mode 100644 index 0000000..1288ec5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/module.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__id = None + self.__module_name = None + self.__api_name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_module_name(self): + """ + The method to get the module_name + + Returns: + string: A string representing the module_name + """ + + return self.__module_name + + def set_module_name(self, module_name): + """ + The method to set the value to module_name + + Parameters: + module_name (string) : A string representing the module_name + """ + + if module_name is not None and not isinstance(module_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module_name EXPECTED TYPE: str', None, None) + + self.__module_name = module_name + self.__key_modified['module_name'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/owner.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/owner.py new file mode 100644 index 0000000..1fa57c3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/owner.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Owner(object): + def __init__(self): + """Creates an instance of Owner""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/response_wrapper.py new file mode 100644 index 0000000..9a4a2a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__webforms = None + self.__key_modified = dict() + + def get_webforms(self): + """ + The method to get the webforms + + Returns: + list: An instance of list + """ + + return self.__webforms + + def set_webforms(self, webforms): + """ + The method to set the value to webforms + + Parameters: + webforms (list) : An instance of list + """ + + if webforms is not None and not isinstance(webforms, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: webforms EXPECTED TYPE: list', None, None) + + self.__webforms = webforms + self.__key_modified['webforms'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/spam_controll.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/spam_controll.py new file mode 100644 index 0000000..26f6f80 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/spam_controll.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SpamControll(object): + def __init__(self): + """Creates an instance of SpamControll""" + + self.__status = None + self.__exclude_score = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_exclude_score(self): + """ + The method to get the exclude_score + + Returns: + string: A string representing the exclude_score + """ + + return self.__exclude_score + + def set_exclude_score(self, exclude_score): + """ + The method to set the value to exclude_score + + Parameters: + exclude_score (string) : A string representing the exclude_score + """ + + if exclude_score is not None and not isinstance(exclude_score, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exclude_score EXPECTED TYPE: str', None, None) + + self.__exclude_score = exclude_score + self.__key_modified['exclude_score'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/success_response.py new file mode 100644 index 0000000..ee7624b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/suggestion.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/suggestion.py new file mode 100644 index 0000000..3839d27 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/suggestion.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Suggestion(object): + def __init__(self): + """Creates an instance of Suggestion""" + + self.__available = None + self.__type = None + self.__key_modified = dict() + + def get_available(self): + """ + The method to get the available + + Returns: + bool: A bool representing the available + """ + + return self.__available + + def set_available(self, available): + """ + The method to set the value to available + + Parameters: + available (bool) : A bool representing the available + """ + + if available is not None and not isinstance(available, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: available EXPECTED TYPE: bool', None, None) + + self.__available = available + self.__key_modified['available'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/tags.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/tags.py new file mode 100644 index 0000000..b96e1e2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/tags.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Tags(object): + def __init__(self): + """Creates an instance of Tags""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/user.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/web_form.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/web_form.py new file mode 100644 index 0000000..e38c611 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/web_form.py @@ -0,0 +1,1113 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class WebForm(object): + def __init__(self): + """Creates an instance of WebForm""" + + self.__google_site = None + self.__encrypted_form_id = None + self.__owner = None + self.__user_type = None + self.__acknowledge_visitor = None + self.__button_attributes = None + self.__encrypted_zgid = None + self.__created_time = None + self.__analytics_data = None + self.__module = None + self.__encrypted_module = None + self.__active = None + self.__adword_enabled = None + self.__notify_owner = None + self.__created_by = None + self.__form_attributes = None + self.__location_url = None + self.__landing_url = None + self.__double_optin_enabled = None + self.__layout = None + self.__tags = None + self.__approval_request = None + self.__type = None + self.__create_contact = None + self.__assignment_rule = None + self.__name = None + self.__id = None + self.__spam_control = None + self.__fields = None + self.__form_fields = None + self.__abtesting = None + self.__visitor_tracking = None + self.__last_submitted_time = None + self.__action_on_submit = None + self.__action_value = None + self.__suggestion = None + self.__embed_code = None + self.__code_formats = None + self.__source_code = None + self.__iframe_code = None + self.__key_modified = dict() + + def get_google_site(self): + """ + The method to get the google_site + + Returns: + string: A string representing the google_site + """ + + return self.__google_site + + def set_google_site(self, google_site): + """ + The method to set the value to google_site + + Parameters: + google_site (string) : A string representing the google_site + """ + + if google_site is not None and not isinstance(google_site, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: google_site EXPECTED TYPE: str', None, None) + + self.__google_site = google_site + self.__key_modified['google_site'] = 1 + + def get_encrypted_form_id(self): + """ + The method to get the encrypted_form_id + + Returns: + string: A string representing the encrypted_form_id + """ + + return self.__encrypted_form_id + + def set_encrypted_form_id(self, encrypted_form_id): + """ + The method to set the value to encrypted_form_id + + Parameters: + encrypted_form_id (string) : A string representing the encrypted_form_id + """ + + if encrypted_form_id is not None and not isinstance(encrypted_form_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encrypted_form_id EXPECTED TYPE: str', None, None) + + self.__encrypted_form_id = encrypted_form_id + self.__key_modified['encrypted_form_id'] = 1 + + def get_owner(self): + """ + The method to get the owner + + Returns: + Owner: An instance of Owner + """ + + return self.__owner + + def set_owner(self, owner): + """ + The method to set the value to owner + + Parameters: + owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.owner import Owner + except Exception: + from .owner import Owner + + if owner is not None and not isinstance(owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: owner EXPECTED TYPE: Owner', None, None) + + self.__owner = owner + self.__key_modified['owner'] = 1 + + def get_user_type(self): + """ + The method to get the user_type + + Returns: + User: An instance of User + """ + + return self.__user_type + + def set_user_type(self, user_type): + """ + The method to set the value to user_type + + Parameters: + user_type (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.user import User + except Exception: + from .user import User + + if user_type is not None and not isinstance(user_type, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: user_type EXPECTED TYPE: User', None, None) + + self.__user_type = user_type + self.__key_modified['user_type'] = 1 + + def get_acknowledge_visitor(self): + """ + The method to get the acknowledge_visitor + + Returns: + AcknowledgeVisitors: An instance of AcknowledgeVisitors + """ + + return self.__acknowledge_visitor + + def set_acknowledge_visitor(self, acknowledge_visitor): + """ + The method to set the value to acknowledge_visitor + + Parameters: + acknowledge_visitor (AcknowledgeVisitors) : An instance of AcknowledgeVisitors + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.acknowledge_visitors import AcknowledgeVisitors + except Exception: + from .acknowledge_visitors import AcknowledgeVisitors + + if acknowledge_visitor is not None and not isinstance(acknowledge_visitor, AcknowledgeVisitors): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: acknowledge_visitor EXPECTED TYPE: AcknowledgeVisitors', None, None) + + self.__acknowledge_visitor = acknowledge_visitor + self.__key_modified['acknowledge_visitor'] = 1 + + def get_button_attributes(self): + """ + The method to get the button_attributes + + Returns: + list: An instance of list + """ + + return self.__button_attributes + + def set_button_attributes(self, button_attributes): + """ + The method to set the value to button_attributes + + Parameters: + button_attributes (list) : An instance of list + """ + + if button_attributes is not None and not isinstance(button_attributes, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: button_attributes EXPECTED TYPE: list', None, None) + + self.__button_attributes = button_attributes + self.__key_modified['button_attributes'] = 1 + + def get_encrypted_zgid(self): + """ + The method to get the encrypted_zgid + + Returns: + string: A string representing the encrypted_zgid + """ + + return self.__encrypted_zgid + + def set_encrypted_zgid(self, encrypted_zgid): + """ + The method to set the value to encrypted_zgid + + Parameters: + encrypted_zgid (string) : A string representing the encrypted_zgid + """ + + if encrypted_zgid is not None and not isinstance(encrypted_zgid, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encrypted_zgid EXPECTED TYPE: str', None, None) + + self.__encrypted_zgid = encrypted_zgid + self.__key_modified['encrypted_zgid'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_analytics_data(self): + """ + The method to get the analytics_data + + Returns: + AnalyticsData: An instance of AnalyticsData + """ + + return self.__analytics_data + + def set_analytics_data(self, analytics_data): + """ + The method to set the value to analytics_data + + Parameters: + analytics_data (AnalyticsData) : An instance of AnalyticsData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.analytics_data import AnalyticsData + except Exception: + from .analytics_data import AnalyticsData + + if analytics_data is not None and not isinstance(analytics_data, AnalyticsData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: analytics_data EXPECTED TYPE: AnalyticsData', None, None) + + self.__analytics_data = analytics_data + self.__key_modified['analytics_data'] = 1 + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_encrypted_module(self): + """ + The method to get the encrypted_module + + Returns: + string: A string representing the encrypted_module + """ + + return self.__encrypted_module + + def set_encrypted_module(self, encrypted_module): + """ + The method to set the value to encrypted_module + + Parameters: + encrypted_module (string) : A string representing the encrypted_module + """ + + if encrypted_module is not None and not isinstance(encrypted_module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: encrypted_module EXPECTED TYPE: str', None, None) + + self.__encrypted_module = encrypted_module + self.__key_modified['encrypted_module'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_adword_enabled(self): + """ + The method to get the adword_enabled + + Returns: + bool: A bool representing the adword_enabled + """ + + return self.__adword_enabled + + def set_adword_enabled(self, adword_enabled): + """ + The method to set the value to adword_enabled + + Parameters: + adword_enabled (bool) : A bool representing the adword_enabled + """ + + if adword_enabled is not None and not isinstance(adword_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: adword_enabled EXPECTED TYPE: bool', None, None) + + self.__adword_enabled = adword_enabled + self.__key_modified['adword_enabled'] = 1 + + def get_notify_owner(self): + """ + The method to get the notify_owner + + Returns: + Owner: An instance of Owner + """ + + return self.__notify_owner + + def set_notify_owner(self, notify_owner): + """ + The method to set the value to notify_owner + + Parameters: + notify_owner (Owner) : An instance of Owner + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.owner import Owner + except Exception: + from .owner import Owner + + if notify_owner is not None and not isinstance(notify_owner, Owner): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: notify_owner EXPECTED TYPE: Owner', None, None) + + self.__notify_owner = notify_owner + self.__key_modified['notify_owner'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_form_attributes(self): + """ + The method to get the form_attributes + + Returns: + FormAttributes: An instance of FormAttributes + """ + + return self.__form_attributes + + def set_form_attributes(self, form_attributes): + """ + The method to set the value to form_attributes + + Parameters: + form_attributes (FormAttributes) : An instance of FormAttributes + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.form_attributes import FormAttributes + except Exception: + from .form_attributes import FormAttributes + + if form_attributes is not None and not isinstance(form_attributes, FormAttributes): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_attributes EXPECTED TYPE: FormAttributes', None, None) + + self.__form_attributes = form_attributes + self.__key_modified['form_attributes'] = 1 + + def get_location_url(self): + """ + The method to get the location_url + + Returns: + list: An instance of list + """ + + return self.__location_url + + def set_location_url(self, location_url): + """ + The method to set the value to location_url + + Parameters: + location_url (list) : An instance of list + """ + + if location_url is not None and not isinstance(location_url, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: location_url EXPECTED TYPE: list', None, None) + + self.__location_url = location_url + self.__key_modified['location_url'] = 1 + + def get_landing_url(self): + """ + The method to get the landing_url + + Returns: + string: A string representing the landing_url + """ + + return self.__landing_url + + def set_landing_url(self, landing_url): + """ + The method to set the value to landing_url + + Parameters: + landing_url (string) : A string representing the landing_url + """ + + if landing_url is not None and not isinstance(landing_url, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: landing_url EXPECTED TYPE: str', None, None) + + self.__landing_url = landing_url + self.__key_modified['landing_url'] = 1 + + def get_double_optin_enabled(self): + """ + The method to get the double_optin_enabled + + Returns: + bool: A bool representing the double_optin_enabled + """ + + return self.__double_optin_enabled + + def set_double_optin_enabled(self, double_optin_enabled): + """ + The method to set the value to double_optin_enabled + + Parameters: + double_optin_enabled (bool) : A bool representing the double_optin_enabled + """ + + if double_optin_enabled is not None and not isinstance(double_optin_enabled, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: double_optin_enabled EXPECTED TYPE: bool', None, None) + + self.__double_optin_enabled = double_optin_enabled + self.__key_modified['double_optin_enabled'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layout: An instance of Layout + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layout) : An instance of Layout + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.layout import Layout + except Exception: + from .layout import Layout + + if layout is not None and not isinstance(layout, Layout): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layout', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_tags(self): + """ + The method to get the tags + + Returns: + list: An instance of list + """ + + return self.__tags + + def set_tags(self, tags): + """ + The method to set the value to tags + + Parameters: + tags (list) : An instance of list + """ + + if tags is not None and not isinstance(tags, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: tags EXPECTED TYPE: list', None, None) + + self.__tags = tags + self.__key_modified['tags'] = 1 + + def get_approval_request(self): + """ + The method to get the approval_request + + Returns: + bool: A bool representing the approval_request + """ + + return self.__approval_request + + def set_approval_request(self, approval_request): + """ + The method to set the value to approval_request + + Parameters: + approval_request (bool) : A bool representing the approval_request + """ + + if approval_request is not None and not isinstance(approval_request, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: approval_request EXPECTED TYPE: bool', None, None) + + self.__approval_request = approval_request + self.__key_modified['approval_request'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_create_contact(self): + """ + The method to get the create_contact + + Returns: + bool: A bool representing the create_contact + """ + + return self.__create_contact + + def set_create_contact(self, create_contact): + """ + The method to set the value to create_contact + + Parameters: + create_contact (bool) : A bool representing the create_contact + """ + + if create_contact is not None and not isinstance(create_contact, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: create_contact EXPECTED TYPE: bool', None, None) + + self.__create_contact = create_contact + self.__key_modified['create_contact'] = 1 + + def get_assignment_rule(self): + """ + The method to get the assignment_rule + + Returns: + AssignmentRule: An instance of AssignmentRule + """ + + return self.__assignment_rule + + def set_assignment_rule(self, assignment_rule): + """ + The method to set the value to assignment_rule + + Parameters: + assignment_rule (AssignmentRule) : An instance of AssignmentRule + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.assignment_rule import AssignmentRule + except Exception: + from .assignment_rule import AssignmentRule + + if assignment_rule is not None and not isinstance(assignment_rule, AssignmentRule): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: assignment_rule EXPECTED TYPE: AssignmentRule', None, None) + + self.__assignment_rule = assignment_rule + self.__key_modified['assignment_rule'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_spam_control(self): + """ + The method to get the spam_control + + Returns: + SpamControll: An instance of SpamControll + """ + + return self.__spam_control + + def set_spam_control(self, spam_control): + """ + The method to set the value to spam_control + + Parameters: + spam_control (SpamControll) : An instance of SpamControll + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.spam_controll import SpamControll + except Exception: + from .spam_controll import SpamControll + + if spam_control is not None and not isinstance(spam_control, SpamControll): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: spam_control EXPECTED TYPE: SpamControll', None, None) + + self.__spam_control = spam_control + self.__key_modified['spam_control'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_form_fields(self): + """ + The method to get the form_fields + + Returns: + list: An instance of list + """ + + return self.__form_fields + + def set_form_fields(self, form_fields): + """ + The method to set the value to form_fields + + Parameters: + form_fields (list) : An instance of list + """ + + if form_fields is not None and not isinstance(form_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_fields EXPECTED TYPE: list', None, None) + + self.__form_fields = form_fields + self.__key_modified['form_fields'] = 1 + + def get_abtesting(self): + """ + The method to get the abtesting + + Returns: + list: An instance of list + """ + + return self.__abtesting + + def set_abtesting(self, abtesting): + """ + The method to set the value to abtesting + + Parameters: + abtesting (list) : An instance of list + """ + + if abtesting is not None and not isinstance(abtesting, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: abtesting EXPECTED TYPE: list', None, None) + + self.__abtesting = abtesting + self.__key_modified['abtesting'] = 1 + + def get_visitor_tracking(self): + """ + The method to get the visitor_tracking + + Returns: + string: A string representing the visitor_tracking + """ + + return self.__visitor_tracking + + def set_visitor_tracking(self, visitor_tracking): + """ + The method to set the value to visitor_tracking + + Parameters: + visitor_tracking (string) : A string representing the visitor_tracking + """ + + if visitor_tracking is not None and not isinstance(visitor_tracking, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: visitor_tracking EXPECTED TYPE: str', None, None) + + self.__visitor_tracking = visitor_tracking + self.__key_modified['visitor_tracking'] = 1 + + def get_last_submitted_time(self): + """ + The method to get the last_submitted_time + + Returns: + datetime: An instance of datetime + """ + + return self.__last_submitted_time + + def set_last_submitted_time(self, last_submitted_time): + """ + The method to set the value to last_submitted_time + + Parameters: + last_submitted_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if last_submitted_time is not None and not isinstance(last_submitted_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_submitted_time EXPECTED TYPE: datetime', None, None) + + self.__last_submitted_time = last_submitted_time + self.__key_modified['last_submitted_time'] = 1 + + def get_action_on_submit(self): + """ + The method to get the action_on_submit + + Returns: + string: A string representing the action_on_submit + """ + + return self.__action_on_submit + + def set_action_on_submit(self, action_on_submit): + """ + The method to set the value to action_on_submit + + Parameters: + action_on_submit (string) : A string representing the action_on_submit + """ + + if action_on_submit is not None and not isinstance(action_on_submit, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_on_submit EXPECTED TYPE: str', None, None) + + self.__action_on_submit = action_on_submit + self.__key_modified['action_on_submit'] = 1 + + def get_action_value(self): + """ + The method to get the action_value + + Returns: + string: A string representing the action_value + """ + + return self.__action_value + + def set_action_value(self, action_value): + """ + The method to set the value to action_value + + Parameters: + action_value (string) : A string representing the action_value + """ + + if action_value is not None and not isinstance(action_value, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: action_value EXPECTED TYPE: str', None, None) + + self.__action_value = action_value + self.__key_modified['action_value'] = 1 + + def get_suggestion(self): + """ + The method to get the suggestion + + Returns: + Suggestion: An instance of Suggestion + """ + + return self.__suggestion + + def set_suggestion(self, suggestion): + """ + The method to set the value to suggestion + + Parameters: + suggestion (Suggestion) : An instance of Suggestion + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.suggestion import Suggestion + except Exception: + from .suggestion import Suggestion + + if suggestion is not None and not isinstance(suggestion, Suggestion): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: suggestion EXPECTED TYPE: Suggestion', None, None) + + self.__suggestion = suggestion + self.__key_modified['suggestion'] = 1 + + def get_embed_code(self): + """ + The method to get the embed_code + + Returns: + string: A string representing the embed_code + """ + + return self.__embed_code + + def set_embed_code(self, embed_code): + """ + The method to set the value to embed_code + + Parameters: + embed_code (string) : A string representing the embed_code + """ + + if embed_code is not None and not isinstance(embed_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: embed_code EXPECTED TYPE: str', None, None) + + self.__embed_code = embed_code + self.__key_modified['embed_code'] = 1 + + def get_code_formats(self): + """ + The method to get the code_formats + + Returns: + list: An instance of list + """ + + return self.__code_formats + + def set_code_formats(self, code_formats): + """ + The method to set the value to code_formats + + Parameters: + code_formats (list) : An instance of list + """ + + if code_formats is not None and not isinstance(code_formats, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code_formats EXPECTED TYPE: list', None, None) + + self.__code_formats = code_formats + self.__key_modified['code_formats'] = 1 + + def get_source_code(self): + """ + The method to get the source_code + + Returns: + string: A string representing the source_code + """ + + return self.__source_code + + def set_source_code(self, source_code): + """ + The method to set the value to source_code + + Parameters: + source_code (string) : A string representing the source_code + """ + + if source_code is not None and not isinstance(source_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source_code EXPECTED TYPE: str', None, None) + + self.__source_code = source_code + self.__key_modified['source_code'] = 1 + + def get_iframe_code(self): + """ + The method to get the iframe_code + + Returns: + string: A string representing the iframe_code + """ + + return self.__iframe_code + + def set_iframe_code(self, iframe_code): + """ + The method to set the value to iframe_code + + Parameters: + iframe_code (string) : A string representing the iframe_code + """ + + if iframe_code is not None and not isinstance(iframe_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: iframe_code EXPECTED TYPE: str', None, None) + + self.__iframe_code = iframe_code + self.__key_modified['iframe_code'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/webforms/webforms_operations.py b/zohocrmsdk/src/com/zoho/crm/api/webforms/webforms_operations.py new file mode 100644 index 0000000..4be840d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/webforms/webforms_operations.py @@ -0,0 +1,289 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class WebformsOperations(object): + def __init__(self, module=None): + """ + Creates an instance of WebformsOperations with the given parameters + + Parameters: + module (string) : A string representing the module + """ + + if module is not None and not isinstance(module, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: str', None, None) + + self.__module = module + + + def get_web_forms(self): + """ + The method to get web forms + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms' + 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.Webforms.GetWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_web_forms(self, request): + """ + The method to create web forms + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/webforms' + 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('module', 'com.zoho.crm.api.Webforms.CreateWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def update_web_forms(self, request): + """ + The method to update web forms + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + 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/v7/settings/webforms' + 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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.Webforms.UpdateWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_web_form(self, form_id): + """ + The method to get web form + + Parameters: + form_id (int) : An int representing the form_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms/' + api_path = api_path + str(form_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.Webforms.GetWebFormParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def update_web_form(self, form_id, request): + """ + The method to update web form + + Parameters: + form_id (int) : An int representing the form_id + request (BodyWrapper) : An instance of BodyWrapper + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_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/v7/settings/webforms/' + api_path = api_path + str(form_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.set_mandatory_checker(True) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.Webforms.UpdateWebFormParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def delete_web_forms(self, form_id): + """ + The method to delete web forms + + Parameters: + form_id (int) : An int representing the form_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms/' + api_path = api_path + str(form_id) + handler_instance.set_api_path(api_path) + handler_instance.set_http_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.set_category_method(Constants.REQUEST_METHOD_DELETE) + handler_instance.add_param(Param('module', 'com.zoho.crm.api.Webforms.DeleteWebFormsParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + def get_webforms_preview(self, form_id): + """ + The method to get webforms preview + + Parameters: + form_id (int) : An int representing the form_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(form_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: form_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/webforms/' + api_path = api_path + str(form_id) + api_path = api_path + '/actions/preview' + 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.Webforms.GetWebformsPreviewParam'), self.__module) + try: + from zohocrmsdk.src.com.zoho.crm.api.webforms.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetWebFormsParam(object): + pass + + +class CreateWebFormsParam(object): + pass + + +class UpdateWebFormsParam(object): + pass + + +class GetWebFormParam(object): + pass + + +class UpdateWebFormParam(object): + pass + + +class DeleteWebFormsParam(object): + pass + + +class GetWebformsPreviewParam(object): + pass diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/__init__.py new file mode 100644 index 0000000..1d79eb4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/__init__.py @@ -0,0 +1,23 @@ +from .container import Container +from .wizards_operations import WizardsOperations, GetWizardByIDParam +from .button_background import ButtonBackground +from .chart_data import ChartData +from .portal_user_type import PortalUserType +from .resource import Resource +from .criteria import Criteria +from .screen import Screen +from .message import Message +from .transition import Transition +from .conditional_rules import ConditionalRules +from .button import Button +from .api_exception import APIException +from .node import Node +from .response_handler import ResponseHandler +from .field import Field +from .exempted_portal_user_type import ExemptedPortalUserType +from .segment import Segment +from .response_wrapper import ResponseWrapper +from .connection import Connection +from .wizard import Wizard +from .actions import Actions +from .element import Element diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/actions.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/actions.py new file mode 100644 index 0000000..2040e1c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/actions.py @@ -0,0 +1,236 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Actions(object): + def __init__(self): + """Creates an instance of Actions""" + + self.__id = None + self.__type = None + self.__segment = None + self.__fields = None + self.__field = None + self.__value = None + self.__exempted_profiles = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_segment(self): + """ + The method to get the segment + + Returns: + Segment: An instance of Segment + """ + + return self.__segment + + def set_segment(self, segment): + """ + The method to set the value to segment + + Parameters: + segment (Segment) : An instance of Segment + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.segment import Segment + except Exception: + from .segment import Segment + + if segment is not None and not isinstance(segment, Segment): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: segment EXPECTED TYPE: Segment', None, None) + + self.__segment = segment + self.__key_modified['segment'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + Fields: An instance of Fields + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (Fields) : An instance of Fields + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields + except Exception: + from ..fields import Fields + + if fields is not None and not isinstance(fields, Fields): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: Fields', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Fields: An instance of Fields + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Fields) : An instance of Fields + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.fields import Fields + except Exception: + from ..fields import Fields + + if field is not None and not isinstance(field, Fields): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Fields', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_exempted_profiles(self): + """ + The method to get the exempted_profiles + + Returns: + list: An instance of list + """ + + return self.__exempted_profiles + + def set_exempted_profiles(self, exempted_profiles): + """ + The method to set the value to exempted_profiles + + Parameters: + exempted_profiles (list) : An instance of list + """ + + if exempted_profiles is not None and not isinstance(exempted_profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exempted_profiles EXPECTED TYPE: list', None, None) + + self.__exempted_profiles = exempted_profiles + self.__key_modified['exempted_profiles'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/api_exception.py new file mode 100644 index 0000000..542fc48 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/api_exception.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .response_handler import ResponseHandler + + +class APIException(ResponseHandler): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/button.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/button.py new file mode 100644 index 0000000..d6095b2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/button.py @@ -0,0 +1,441 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Button(object): + def __init__(self): + """Creates an instance of Button""" + + self.__id = None + self.__sequence_number = None + self.__display_label = None + self.__criteria = None + self.__target_screen = None + self.__type = None + self.__message = None + self.__color = None + self.__shape = None + self.__background_color = None + self.__visibility = None + self.__resource = None + self.__transition = None + self.__category = None + self.__reference_id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_target_screen(self): + """ + The method to get the target_screen + + Returns: + Screen: An instance of Screen + """ + + return self.__target_screen + + def set_target_screen(self, target_screen): + """ + The method to set the value to target_screen + + Parameters: + target_screen (Screen) : An instance of Screen + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.screen import Screen + except Exception: + from .screen import Screen + + if target_screen is not None and not isinstance(target_screen, Screen): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: target_screen EXPECTED TYPE: Screen', None, None) + + self.__target_screen = target_screen + self.__key_modified['target_screen'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Message: An instance of Message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (Message) : An instance of Message + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.message import Message + except Exception: + from .message import Message + + if message is not None and not isinstance(message, Message): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: Message', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_color(self): + """ + The method to get the color + + Returns: + string: A string representing the color + """ + + return self.__color + + def set_color(self, color): + """ + The method to set the value to color + + Parameters: + color (string) : A string representing the color + """ + + if color is not None and not isinstance(color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color EXPECTED TYPE: str', None, None) + + self.__color = color + self.__key_modified['color'] = 1 + + def get_shape(self): + """ + The method to get the shape + + Returns: + string: A string representing the shape + """ + + return self.__shape + + def set_shape(self, shape): + """ + The method to set the value to shape + + Parameters: + shape (string) : A string representing the shape + """ + + if shape is not None and not isinstance(shape, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: shape EXPECTED TYPE: str', None, None) + + self.__shape = shape + self.__key_modified['shape'] = 1 + + def get_background_color(self): + """ + The method to get the background_color + + Returns: + string: A string representing the background_color + """ + + return self.__background_color + + def set_background_color(self, background_color): + """ + The method to set the value to background_color + + Parameters: + background_color (string) : A string representing the background_color + """ + + if background_color is not None and not isinstance(background_color, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: background_color EXPECTED TYPE: str', None, None) + + self.__background_color = background_color + self.__key_modified['background_color'] = 1 + + def get_visibility(self): + """ + The method to get the visibility + + Returns: + string: A string representing the visibility + """ + + return self.__visibility + + 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 get_resource(self): + """ + The method to get the resource + + Returns: + Object: A Object representing the resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Object) : A Object representing the resource + """ + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def get_transition(self): + """ + The method to get the transition + + Returns: + Transition: An instance of Transition + """ + + return self.__transition + + def set_transition(self, transition): + """ + The method to set the value to transition + + Parameters: + transition (Transition) : An instance of Transition + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.transition import Transition + except Exception: + from .transition import Transition + + if transition is not None and not isinstance(transition, Transition): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: transition EXPECTED TYPE: Transition', None, None) + + self.__transition = transition + self.__key_modified['transition'] = 1 + + def get_category(self): + """ + The method to get the category + + Returns: + string: A string representing the category + """ + + return self.__category + + def set_category(self, category): + """ + The method to set the value to category + + Parameters: + category (string) : A string representing the category + """ + + if category is not None and not isinstance(category, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: category EXPECTED TYPE: str', None, None) + + self.__category = category + self.__key_modified['category'] = 1 + + def get_reference_id(self): + """ + The method to get the reference_id + + Returns: + string: A string representing the reference_id + """ + + return self.__reference_id + + def set_reference_id(self, reference_id): + """ + The method to set the value to reference_id + + Parameters: + reference_id (string) : A string representing the reference_id + """ + + if reference_id is not None and not isinstance(reference_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reference_id EXPECTED TYPE: str', None, None) + + self.__reference_id = reference_id + self.__key_modified['reference_id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/button_background.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/button_background.py new file mode 100644 index 0000000..bda31f0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/button_background.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ButtonBackground(object): + def __init__(self): + """Creates an instance of ButtonBackground""" + + self.__button_background = None + self.__key_modified = dict() + + def get_button_background(self): + """ + The method to get the button_background + + Returns: + list: An instance of list + """ + + return self.__button_background + + def set_button_background(self, button_background): + """ + The method to set the value to button_background + + Parameters: + button_background (list) : An instance of list + """ + + if button_background is not None and not isinstance(button_background, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: button_background EXPECTED TYPE: list', None, None) + + self.__button_background = button_background + self.__key_modified['button_background'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/chart_data.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/chart_data.py new file mode 100644 index 0000000..6f99c04 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/chart_data.py @@ -0,0 +1,179 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ChartData(object): + def __init__(self): + """Creates an instance of ChartData""" + + self.__nodes = None + self.__connections = None + self.__color_palette = None + self.__canvas_width = None + self.__canvas_height = None + self.__key_modified = dict() + + def get_nodes(self): + """ + The method to get the nodes + + Returns: + list: An instance of list + """ + + return self.__nodes + + def set_nodes(self, nodes): + """ + The method to set the value to nodes + + Parameters: + nodes (list) : An instance of list + """ + + if nodes is not None and not isinstance(nodes, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: nodes EXPECTED TYPE: list', None, None) + + self.__nodes = nodes + self.__key_modified['nodes'] = 1 + + def get_connections(self): + """ + The method to get the connections + + Returns: + list: An instance of list + """ + + return self.__connections + + 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 get_color_palette(self): + """ + The method to get the color_palette + + Returns: + ButtonBackground: An instance of ButtonBackground + """ + + return self.__color_palette + + def set_color_palette(self, color_palette): + """ + The method to set the value to color_palette + + Parameters: + color_palette (ButtonBackground) : An instance of ButtonBackground + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.button_background import ButtonBackground + except Exception: + from .button_background import ButtonBackground + + if color_palette is not None and not isinstance(color_palette, ButtonBackground): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: color_palette EXPECTED TYPE: ButtonBackground', None, None) + + self.__color_palette = color_palette + self.__key_modified['color_palette'] = 1 + + def get_canvas_width(self): + """ + The method to get the canvas_width + + Returns: + int: An int representing the canvas_width + """ + + return self.__canvas_width + + 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 get_canvas_height(self): + """ + The method to get the canvas_height + + Returns: + int: An int representing the canvas_height + """ + + return self.__canvas_height + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/conditional_rules.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/conditional_rules.py new file mode 100644 index 0000000..3e3d452 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/conditional_rules.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ConditionalRules(object): + def __init__(self): + """Creates an instance of ConditionalRules""" + + self.__query_id = None + self.__execute_on = None + self.__criteria = None + self.__actions = None + self.__key_modified = dict() + + def get_query_id(self): + """ + The method to get the query_id + + Returns: + int: An int representing the query_id + """ + + return self.__query_id + + def set_query_id(self, query_id): + """ + The method to set the value to query_id + + Parameters: + query_id (int) : An int representing the query_id + """ + + if query_id is not None and not isinstance(query_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: query_id EXPECTED TYPE: int', None, None) + + self.__query_id = query_id + self.__key_modified['query_id'] = 1 + + def get_execute_on(self): + """ + The method to get the execute_on + + Returns: + Choice: An instance of Choice + """ + + return self.__execute_on + + def set_execute_on(self, execute_on): + """ + The method to set the value to execute_on + + Parameters: + execute_on (Choice) : An instance of Choice + """ + + if execute_on is not None and not isinstance(execute_on, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: execute_on EXPECTED TYPE: Choice', None, None) + + self.__execute_on = execute_on + self.__key_modified['execute_on'] = 1 + + def get_criteria(self): + """ + The method to get the criteria + + Returns: + Criteria: An instance of Criteria + """ + + return self.__criteria + + def set_criteria(self, criteria): + """ + The method to set the value to criteria + + Parameters: + criteria (Criteria) : An instance of Criteria + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.criteria import Criteria + except Exception: + from .criteria import Criteria + + if criteria is not None and not isinstance(criteria, Criteria): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: criteria EXPECTED TYPE: Criteria', None, None) + + self.__criteria = criteria + self.__key_modified['criteria'] = 1 + + def get_actions(self): + """ + The method to get the actions + + Returns: + list: An instance of list + """ + + return self.__actions + + def set_actions(self, actions): + """ + The method to set the value to actions + + Parameters: + actions (list) : An instance of list + """ + + if actions is not None and not isinstance(actions, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: actions EXPECTED TYPE: list', None, None) + + self.__actions = actions + self.__key_modified['actions'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/connection.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/connection.py new file mode 100644 index 0000000..7ec6f1e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/connection.py @@ -0,0 +1,134 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Connection(object): + def __init__(self): + """Creates an instance of Connection""" + + self.__source_button = None + self.__target_screen = None + self.__id = None + self.__key_modified = dict() + + def get_source_button(self): + """ + The method to get the source_button + + Returns: + Button: An instance of Button + """ + + return self.__source_button + + def set_source_button(self, source_button): + """ + The method to set the value to source_button + + Parameters: + source_button (Button) : An instance of Button + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.button import Button + except Exception: + from .button import Button + + if source_button is not None and not isinstance(source_button, Button): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: source_button EXPECTED TYPE: Button', None, None) + + self.__source_button = source_button + self.__key_modified['source_button'] = 1 + + def get_target_screen(self): + """ + The method to get the target_screen + + Returns: + Screen: An instance of Screen + """ + + return self.__target_screen + + def set_target_screen(self, target_screen): + """ + The method to set the value to target_screen + + Parameters: + target_screen (Screen) : An instance of Screen + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.screen import Screen + except Exception: + from .screen import Screen + + if target_screen is not None and not isinstance(target_screen, Screen): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: target_screen EXPECTED TYPE: Screen', None, None) + + self.__target_screen = target_screen + self.__key_modified['target_screen'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/container.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/container.py new file mode 100644 index 0000000..9bd9c59 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/container.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Container(object): + def __init__(self): + """Creates an instance of Container""" + + self.__id = None + self.__layout = None + self.__chart_data = None + self.__screens = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layouts: An instance of Layouts + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layouts) : An instance of Layouts + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts import Layouts + except Exception: + from ..layouts import Layouts + + if layout is not None and not isinstance(layout, Layouts): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layouts', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_chart_data(self): + """ + The method to get the chart_data + + Returns: + ChartData: An instance of ChartData + """ + + return self.__chart_data + + def set_chart_data(self, chart_data): + """ + The method to set the value to chart_data + + Parameters: + chart_data (ChartData) : An instance of ChartData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.chart_data import ChartData + except Exception: + from .chart_data import ChartData + + if chart_data is not None and not isinstance(chart_data, ChartData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_data EXPECTED TYPE: ChartData', None, None) + + self.__chart_data = chart_data + self.__key_modified['chart_data'] = 1 + + def get_screens(self): + """ + The method to get the screens + + Returns: + list: An instance of list + """ + + return self.__screens + + def set_screens(self, screens): + """ + The method to set the value to screens + + Parameters: + screens (list) : An instance of list + """ + + if screens is not None and not isinstance(screens, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screens EXPECTED TYPE: list', None, None) + + self.__screens = screens + self.__key_modified['screens'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/criteria.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/criteria.py new file mode 100644 index 0000000..e3c4ef2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/criteria.py @@ -0,0 +1,176 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Criteria(object): + def __init__(self): + """Creates an instance of Criteria""" + + self.__comparator = None + self.__field = None + self.__value = None + self.__group_operator = None + self.__group = None + self.__key_modified = dict() + + def get_comparator(self): + """ + The method to get the comparator + + Returns: + string: A string representing the comparator + """ + + return self.__comparator + + def set_comparator(self, comparator): + """ + The method to set the value to comparator + + Parameters: + comparator (string) : A string representing the comparator + """ + + if comparator is not None and not isinstance(comparator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comparator EXPECTED TYPE: str', None, None) + + self.__comparator = comparator + self.__key_modified['comparator'] = 1 + + def get_field(self): + """ + The method to get the field + + Returns: + Field: An instance of Field + """ + + return self.__field + + def set_field(self, field): + """ + The method to set the value to field + + Parameters: + field (Field) : An instance of Field + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.field import Field + except Exception: + from .field import Field + + if field is not None and not isinstance(field, Field): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: field EXPECTED TYPE: Field', None, None) + + self.__field = field + self.__key_modified['field'] = 1 + + def get_value(self): + """ + The method to get the value + + Returns: + Object: A Object representing the value + """ + + return self.__value + + def set_value(self, value): + """ + The method to set the value to value + + Parameters: + value (Object) : A Object representing the value + """ + + self.__value = value + self.__key_modified['value'] = 1 + + def get_group_operator(self): + """ + The method to get the group_operator + + Returns: + string: A string representing the group_operator + """ + + return self.__group_operator + + def set_group_operator(self, group_operator): + """ + The method to set the value to group_operator + + Parameters: + group_operator (string) : A string representing the group_operator + """ + + if group_operator is not None and not isinstance(group_operator, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group_operator EXPECTED TYPE: str', None, None) + + self.__group_operator = group_operator + self.__key_modified['group_operator'] = 1 + + def get_group(self): + """ + The method to get the group + + Returns: + list: An instance of list + """ + + return self.__group + + def set_group(self, group): + """ + The method to set the value to group + + Parameters: + group (list) : An instance of list + """ + + if group is not None and not isinstance(group, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: group EXPECTED TYPE: list', None, None) + + self.__group = group + self.__key_modified['group'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/element.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/element.py new file mode 100644 index 0000000..7ae0756 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/element.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Element(object): + def __init__(self): + """Creates an instance of Element""" + + self.__type = None + self.__resource = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_resource(self): + """ + The method to get the resource + + Returns: + Resource: An instance of Resource + """ + + return self.__resource + + def set_resource(self, resource): + """ + The method to set the value to resource + + Parameters: + resource (Resource) : An instance of Resource + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.resource import Resource + except Exception: + from .resource import Resource + + if resource is not None and not isinstance(resource, Resource): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: resource EXPECTED TYPE: Resource', None, None) + + self.__resource = resource + self.__key_modified['resource'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/exempted_portal_user_type.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/exempted_portal_user_type.py new file mode 100644 index 0000000..850d60a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/exempted_portal_user_type.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ExemptedPortalUserType(object): + def __init__(self): + """Creates an instance of ExemptedPortalUserType""" + + self.__id = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/field.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/field.py new file mode 100644 index 0000000..1875bf2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Field(object): + def __init__(self): + """Creates an instance of Field""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/message.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/message.py new file mode 100644 index 0000000..66dec0c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/message.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Message(object): + def __init__(self): + """Creates an instance of Message""" + + self.__title = None + self.__content = None + self.__key_modified = dict() + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_content(self): + """ + The method to get the content + + Returns: + string: A string representing the content + """ + + return self.__content + + def set_content(self, content): + """ + The method to set the value to content + + Parameters: + content (string) : A string representing the content + """ + + if content is not None and not isinstance(content, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: content EXPECTED TYPE: str', None, None) + + self.__content = content + self.__key_modified['content'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/node.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/node.py new file mode 100644 index 0000000..5b821a8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/node.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Node(object): + def __init__(self): + """Creates an instance of Node""" + + self.__pos_y = None + self.__pos_x = None + self.__start_node = None + self.__screen = None + self.__key_modified = dict() + + def get_pos_y(self): + """ + The method to get the pos_y + + Returns: + int: An int representing the pos_y + """ + + return self.__pos_y + + def set_pos_y(self, pos_y): + """ + The method to set the value to pos_y + + Parameters: + pos_y (int) : An int representing the pos_y + """ + + if pos_y is not None and not isinstance(pos_y, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pos_y EXPECTED TYPE: int', None, None) + + self.__pos_y = pos_y + self.__key_modified['pos_y'] = 1 + + def get_pos_x(self): + """ + The method to get the pos_x + + Returns: + int: An int representing the pos_x + """ + + return self.__pos_x + + def set_pos_x(self, pos_x): + """ + The method to set the value to pos_x + + Parameters: + pos_x (int) : An int representing the pos_x + """ + + if pos_x is not None and not isinstance(pos_x, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pos_x EXPECTED TYPE: int', None, None) + + self.__pos_x = pos_x + self.__key_modified['pos_x'] = 1 + + def get_start_node(self): + """ + The method to get the start_node + + Returns: + bool: A bool representing the start_node + """ + + return self.__start_node + + def set_start_node(self, start_node): + """ + The method to set the value to start_node + + Parameters: + start_node (bool) : A bool representing the start_node + """ + + if start_node is not None and not isinstance(start_node, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_node EXPECTED TYPE: bool', None, None) + + self.__start_node = start_node + self.__key_modified['start_node'] = 1 + + def get_screen(self): + """ + The method to get the screen + + Returns: + Screen: An instance of Screen + """ + + return self.__screen + + def set_screen(self, screen): + """ + The method to set the value to screen + + Parameters: + screen (Screen) : An instance of Screen + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.screen import Screen + except Exception: + from .screen import Screen + + if screen is not None and not isinstance(screen, Screen): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screen EXPECTED TYPE: Screen', None, None) + + self.__screen = screen + self.__key_modified['screen'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/portal_user_type.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/portal_user_type.py new file mode 100644 index 0000000..217233b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/portal_user_type.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class PortalUserType(object): + def __init__(self): + """Creates an instance of PortalUserType""" + + self.__id = None + self.__layout = None + self.__chart_data = None + self.__screens = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_layout(self): + """ + The method to get the layout + + Returns: + Layouts: An instance of Layouts + """ + + return self.__layout + + def set_layout(self, layout): + """ + The method to set the value to layout + + Parameters: + layout (Layouts) : An instance of Layouts + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.layouts import Layouts + except Exception: + from ..layouts import Layouts + + if layout is not None and not isinstance(layout, Layouts): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: layout EXPECTED TYPE: Layouts', None, None) + + self.__layout = layout + self.__key_modified['layout'] = 1 + + def get_chart_data(self): + """ + The method to get the chart_data + + Returns: + ChartData: An instance of ChartData + """ + + return self.__chart_data + + def set_chart_data(self, chart_data): + """ + The method to set the value to chart_data + + Parameters: + chart_data (ChartData) : An instance of ChartData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.chart_data import ChartData + except Exception: + from .chart_data import ChartData + + if chart_data is not None and not isinstance(chart_data, ChartData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: chart_data EXPECTED TYPE: ChartData', None, None) + + self.__chart_data = chart_data + self.__key_modified['chart_data'] = 1 + + def get_screens(self): + """ + The method to get the screens + + Returns: + list: An instance of list + """ + + return self.__screens + + def set_screens(self, screens): + """ + The method to set the value to screens + + Parameters: + screens (list) : An instance of list + """ + + if screens is not None and not isinstance(screens, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: screens EXPECTED TYPE: list', None, None) + + self.__screens = screens + self.__key_modified['screens'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/resource.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/resource.py new file mode 100644 index 0000000..92687f5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/resource.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Resource(object): + def __init__(self): + """Creates an instance of Resource""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/response_wrapper.py new file mode 100644 index 0000000..2b98dc0 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/response_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__wizards = None + self.__key_modified = dict() + + def get_wizards(self): + """ + The method to get the wizards + + Returns: + list: An instance of list + """ + + return self.__wizards + + def set_wizards(self, wizards): + """ + The method to set the value to wizards + + Parameters: + wizards (list) : An instance of list + """ + + if wizards is not None and not isinstance(wizards, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wizards EXPECTED TYPE: list', None, None) + + self.__wizards = wizards + self.__key_modified['wizards'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/screen.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/screen.py new file mode 100644 index 0000000..84c6791 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/screen.py @@ -0,0 +1,199 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Screen(object): + def __init__(self): + """Creates an instance of Screen""" + + self.__display_label = None + self.__api_name = None + self.__id = None + self.__reference_id = None + self.__conditional_rules = None + self.__segments = None + self.__key_modified = dict() + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_reference_id(self): + """ + The method to get the reference_id + + Returns: + string: A string representing the reference_id + """ + + return self.__reference_id + + def set_reference_id(self, reference_id): + """ + The method to set the value to reference_id + + Parameters: + reference_id (string) : A string representing the reference_id + """ + + if reference_id is not None and not isinstance(reference_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: reference_id EXPECTED TYPE: str', None, None) + + self.__reference_id = reference_id + self.__key_modified['reference_id'] = 1 + + def get_conditional_rules(self): + """ + The method to get the conditional_rules + + Returns: + list: An instance of list + """ + + return self.__conditional_rules + + def set_conditional_rules(self, conditional_rules): + """ + The method to set the value to conditional_rules + + Parameters: + conditional_rules (list) : An instance of list + """ + + if conditional_rules is not None and not isinstance(conditional_rules, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: conditional_rules EXPECTED TYPE: list', None, None) + + self.__conditional_rules = conditional_rules + self.__key_modified['conditional_rules'] = 1 + + def get_segments(self): + """ + The method to get the segments + + Returns: + list: An instance of list + """ + + return self.__segments + + def set_segments(self, segments): + """ + The method to set the value to segments + + Parameters: + segments (list) : An instance of list + """ + + if segments is not None and not isinstance(segments, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: segments EXPECTED TYPE: list', None, None) + + self.__segments = segments + self.__key_modified['segments'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/segment.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/segment.py new file mode 100644 index 0000000..6da580e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/segment.py @@ -0,0 +1,249 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Segment(object): + def __init__(self): + """Creates an instance of Segment""" + + self.__sequence_number = None + self.__display_label = None + self.__column_count = None + self.__id = None + self.__type = None + self.__fields = None + self.__buttons = None + self.__elements = None + self.__key_modified = dict() + + def get_sequence_number(self): + """ + The method to get the sequence_number + + Returns: + int: An int representing the sequence_number + """ + + return self.__sequence_number + + 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 get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 get_column_count(self): + """ + The method to get the column_count + + Returns: + int: An int representing the column_count + """ + + return self.__column_count + + def set_column_count(self, column_count): + """ + The method to set the value to column_count + + Parameters: + column_count (int) : An int representing the column_count + """ + + if column_count is not None and not isinstance(column_count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: column_count EXPECTED TYPE: int', None, None) + + self.__column_count = column_count + self.__key_modified['column_count'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_fields(self): + """ + The method to get the fields + + Returns: + list: An instance of list + """ + + return self.__fields + + def set_fields(self, fields): + """ + The method to set the value to fields + + Parameters: + fields (list) : An instance of list + """ + + if fields is not None and not isinstance(fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fields EXPECTED TYPE: list', None, None) + + self.__fields = fields + self.__key_modified['fields'] = 1 + + def get_buttons(self): + """ + The method to get the buttons + + Returns: + list: An instance of list + """ + + return self.__buttons + + def set_buttons(self, buttons): + """ + The method to set the value to buttons + + Parameters: + buttons (list) : An instance of list + """ + + if buttons is not None and not isinstance(buttons, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: buttons EXPECTED TYPE: list', None, None) + + self.__buttons = buttons + self.__key_modified['buttons'] = 1 + + def get_elements(self): + """ + The method to get the elements + + Returns: + list: An instance of list + """ + + return self.__elements + + def set_elements(self, elements): + """ + The method to set the value to elements + + Parameters: + elements (list) : An instance of list + """ + + if elements is not None and not isinstance(elements, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: elements EXPECTED TYPE: list', None, None) + + self.__elements = elements + self.__key_modified['elements'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/transition.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/transition.py new file mode 100644 index 0000000..597c3d2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/transition.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Transition(object): + def __init__(self): + """Creates an instance of Transition""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/wizard.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/wizard.py new file mode 100644 index 0000000..e2b6eaf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/wizard.py @@ -0,0 +1,423 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Wizard(object): + def __init__(self): + """Creates an instance of Wizard""" + + self.__created_time = None + self.__modified_time = None + self.__module = None + self.__name = None + self.__modified_by = None + self.__profiles = None + self.__active = None + self.__containers = None + self.__id = None + self.__created_by = None + self.__portal_user_types = None + self.__exempted_portal_user_types = None + self.__parent_wizard = None + self.__draft = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_module(self): + """ + The method to get the module + + Returns: + Modules: An instance of Modules + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Modules) : An instance of Modules + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.modules import Modules + except Exception: + from ..modules import Modules + + if module is not None and not isinstance(module, Modules): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Modules', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_modified_by(self): + """ + The method to get the modified_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if modified_by is not None and not isinstance(modified_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def get_profiles(self): + """ + The method to get the profiles + + Returns: + list: An instance of list + """ + + return self.__profiles + + def set_profiles(self, profiles): + """ + The method to set the value to profiles + + Parameters: + profiles (list) : An instance of list + """ + + if profiles is not None and not isinstance(profiles, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: profiles EXPECTED TYPE: list', None, None) + + self.__profiles = profiles + self.__key_modified['profiles'] = 1 + + def get_active(self): + """ + The method to get the active + + Returns: + bool: A bool representing the active + """ + + return self.__active + + def set_active(self, active): + """ + The method to set the value to active + + Parameters: + active (bool) : A bool representing the active + """ + + if active is not None and not isinstance(active, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: active EXPECTED TYPE: bool', None, None) + + self.__active = active + self.__key_modified['active'] = 1 + + def get_containers(self): + """ + The method to get the containers + + Returns: + list: An instance of list + """ + + return self.__containers + + def set_containers(self, containers): + """ + The method to set the value to containers + + Parameters: + containers (list) : An instance of list + """ + + if containers is not None and not isinstance(containers, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: containers EXPECTED TYPE: list', None, None) + + self.__containers = containers + self.__key_modified['containers'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + MinifiedUser: An instance of MinifiedUser + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (MinifiedUser) : An instance of MinifiedUser + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.users import MinifiedUser + except Exception: + from ..users import MinifiedUser + + if created_by is not None and not isinstance(created_by, MinifiedUser): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: MinifiedUser', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_portal_user_types(self): + """ + The method to get the portal_user_types + + Returns: + list: An instance of list + """ + + return self.__portal_user_types + + def set_portal_user_types(self, portal_user_types): + """ + The method to set the value to portal_user_types + + Parameters: + portal_user_types (list) : An instance of list + """ + + if portal_user_types is not None and not isinstance(portal_user_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: portal_user_types EXPECTED TYPE: list', None, None) + + self.__portal_user_types = portal_user_types + self.__key_modified['portal_user_types'] = 1 + + def get_exempted_portal_user_types(self): + """ + The method to get the exempted_portal_user_types + + Returns: + list: An instance of list + """ + + return self.__exempted_portal_user_types + + def set_exempted_portal_user_types(self, exempted_portal_user_types): + """ + The method to set the value to exempted_portal_user_types + + Parameters: + exempted_portal_user_types (list) : An instance of list + """ + + if exempted_portal_user_types is not None and not isinstance(exempted_portal_user_types, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: exempted_portal_user_types EXPECTED TYPE: list', None, None) + + self.__exempted_portal_user_types = exempted_portal_user_types + self.__key_modified['exempted_portal_user_types'] = 1 + + def get_parent_wizard(self): + """ + The method to get the parent_wizard + + Returns: + Wizard: An instance of Wizard + """ + + return self.__parent_wizard + + def set_parent_wizard(self, parent_wizard): + """ + The method to set the value to parent_wizard + + Parameters: + parent_wizard (Wizard) : An instance of Wizard + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.wizard import Wizard + except Exception: + from .wizard import Wizard + + if parent_wizard is not None and not isinstance(parent_wizard, Wizard): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: parent_wizard EXPECTED TYPE: Wizard', None, None) + + self.__parent_wizard = parent_wizard + self.__key_modified['parent_wizard'] = 1 + + def get_draft(self): + """ + The method to get the draft + + Returns: + bool: A bool representing the draft + """ + + return self.__draft + + def set_draft(self, draft): + """ + The method to set the value to draft + + Parameters: + draft (bool) : A bool representing the draft + """ + + if draft is not None and not isinstance(draft, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: draft EXPECTED TYPE: bool', None, None) + + self.__draft = draft + self.__key_modified['draft'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/wizards/wizards_operations.py b/zohocrmsdk/src/com/zoho/crm/api/wizards/wizards_operations.py new file mode 100644 index 0000000..556c89c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/wizards/wizards_operations.py @@ -0,0 +1,81 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, CommonAPIHandler, Constants + from ..param import Param + + +class WizardsOperations(object): + def __init__(self): + """Creates an instance of WizardsOperations""" + pass + + def get_wizards(self): + """ + The method to get wizards + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/settings/wizards' + 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) + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_wizard_by_id(self, wizard_id, param_instance=None): + """ + The method to get wizard by id + + Parameters: + wizard_id (string) : A string representing the wizard_id + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if not isinstance(wizard_id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: wizard_id EXPECTED TYPE: str', None, None) + + 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/v7/settings/wizards/' + api_path = api_path + str(wizard_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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.wizards.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + +class GetWizardByIDParam(object): + layout_id = Param('layout_id', 'com.zoho.crm.api.Wizards.GetWizardByIDParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/__init__.py new file mode 100644 index 0000000..9025a3c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/__init__.py @@ -0,0 +1,6 @@ +from .api_exception import APIException +from .allowed_output_data import AllowedOutputData +from .allowed_field_map import AllowedFieldMap +from .crm_field import CrmField +from .enrich_field import EnrichField +from .response_wrapper import ResponseWrapper diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_field_map.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_field_map.py new file mode 100644 index 0000000..19167ba --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_field_map.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AllowedFieldMap(object): + def __init__(self): + """Creates an instance of AllowedFieldMap""" + + self.__output_data_field_mapping = None + self.__input_data_field_mapping = None + self.__key_modified = dict() + + def get_output_data_field_mapping(self): + """ + The method to get the output_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__output_data_field_mapping + + def set_output_data_field_mapping(self, output_data_field_mapping): + """ + The method to set the value to output_data_field_mapping + + Parameters: + output_data_field_mapping (list) : An instance of list + """ + + if output_data_field_mapping is not None and not isinstance(output_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: output_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__output_data_field_mapping = output_data_field_mapping + self.__key_modified['output_data_field_mapping'] = 1 + + def get_input_data_field_mapping(self): + """ + The method to get the input_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__input_data_field_mapping + + def set_input_data_field_mapping(self, input_data_field_mapping): + """ + The method to set the value to input_data_field_mapping + + Parameters: + input_data_field_mapping (list) : An instance of list + """ + + if input_data_field_mapping is not None and not isinstance(input_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: input_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__input_data_field_mapping = input_data_field_mapping + self.__key_modified['input_data_field_mapping'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_output_data.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_output_data.py new file mode 100644 index 0000000..3dcafa5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/allowed_output_data.py @@ -0,0 +1,104 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class AllowedOutputData(object): + def __init__(self): + """Creates an instance of AllowedOutputData""" + + self.__enrich_field = None + self.__crm_fields = None + self.__key_modified = dict() + + def get_enrich_field(self): + """ + The method to get the enrich_field + + Returns: + EnrichField: An instance of EnrichField + """ + + return self.__enrich_field + + def set_enrich_field(self, enrich_field): + """ + The method to set the value to enrich_field + + Parameters: + enrich_field (EnrichField) : An instance of EnrichField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.enrich_field import EnrichField + except Exception: + from .enrich_field import EnrichField + + if enrich_field is not None and not isinstance(enrich_field, EnrichField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_field EXPECTED TYPE: EnrichField', None, None) + + self.__enrich_field = enrich_field + self.__key_modified['enrich_field'] = 1 + + def get_crm_fields(self): + """ + The method to get the crm_fields + + Returns: + list: An instance of list + """ + + return self.__crm_fields + + def set_crm_fields(self, crm_fields): + """ + The method to set the value to crm_fields + + Parameters: + crm_fields (list) : An instance of list + """ + + if crm_fields is not None and not isinstance(crm_fields, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crm_fields EXPECTED TYPE: list', None, None) + + self.__crm_fields = crm_fields + self.__key_modified['crm_fields'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/api_exception.py new file mode 100644 index 0000000..5161635 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/api_exception.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class APIException(object): + def __init__(self): + """Creates an instance of APIException""" + + self.__code = None + self.__message = None + self.__details = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/crm_field.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/crm_field.py new file mode 100644 index 0000000..bfd23f2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/crm_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CrmField(object): + def __init__(self): + """Creates an instance of CrmField""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/enrich_field.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/enrich_field.py new file mode 100644 index 0000000..e4acacf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/enrich_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichField(object): + def __init__(self): + """Creates an instance of EnrichField""" + + self.__name = None + self.__display_label = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/response_wrapper.py new file mode 100644 index 0000000..9769d10 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_allowed_field_mappings/response_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__allowed_field_mappings = None + self.__key_modified = dict() + + def get_allowed_field_mappings(self): + """ + The method to get the allowed_field_mappings + + Returns: + AllowedFieldMap: An instance of AllowedFieldMap + """ + + return self.__allowed_field_mappings + + def set_allowed_field_mappings(self, allowed_field_mappings): + """ + The method to set the value to allowed_field_mappings + + Parameters: + allowed_field_mappings (AllowedFieldMap) : An instance of AllowedFieldMap + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.allowed_field_map import AllowedFieldMap + except Exception: + from .allowed_field_map import AllowedFieldMap + + if allowed_field_mappings is not None and not isinstance(allowed_field_mappings, AllowedFieldMap): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: allowed_field_mappings EXPECTED TYPE: AllowedFieldMap', None, None) + + self.__allowed_field_mappings = allowed_field_mappings + self.__key_modified['allowed_field_mappings'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/__init__.py new file mode 100644 index 0000000..949482e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/__init__.py @@ -0,0 +1,18 @@ +from .input_data import InputData +from .action_wrapper import ActionWrapper +from .scrapy_body_wrapper import ScrapyBodyWrapper +from .scrapy_feedback import ScrapyFeedback +from .scrapy_success import ScrapySuccess +from .scrapy_action_response import ScrapyActionResponse +from .data_enrichment import DataEnrichment +from .module import Module +from .enrich_field import EnrichField +from .scrapy_action_wrapper import ScrapyActionWrapper +from .body_wrapper import BodyWrapper +from .api_exception import APIException +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .crm_field import CrmField +from .response_wrapper import ResponseWrapper +from .user import User +from .output_data import OutputData diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_wrapper.py new file mode 100644 index 0000000..f2ee6c6 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/action_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ActionWrapper(object): + def __init__(self): + """Creates an instance of ActionWrapper""" + + self.__data_enrichment = None + self.__key_modified = dict() + + def get_data_enrichment(self): + """ + The method to get the data_enrichment + + Returns: + list: An instance of list + """ + + return self.__data_enrichment + + def set_data_enrichment(self, data_enrichment): + """ + The method to set the value to data_enrichment + + Parameters: + data_enrichment (list) : An instance of list + """ + + if data_enrichment is not None and not isinstance(data_enrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_enrichment EXPECTED TYPE: list', None, None) + + self.__data_enrichment = data_enrichment + self.__key_modified['data_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/api_exception.py new file mode 100644 index 0000000..8072139 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/api_exception.py @@ -0,0 +1,154 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_action_response import ScrapyActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .scrapy_action_response import ScrapyActionResponse + + +class APIException(ActionResponse, ScrapyActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/body_wrapper.py new file mode 100644 index 0000000..290c05a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__data_enrichment = None + self.__key_modified = dict() + + def get_data_enrichment(self): + """ + The method to get the data_enrichment + + Returns: + list: An instance of list + """ + + return self.__data_enrichment + + def set_data_enrichment(self, data_enrichment): + """ + The method to set the value to data_enrichment + + Parameters: + data_enrichment (list) : An instance of list + """ + + if data_enrichment is not None and not isinstance(data_enrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_enrichment EXPECTED TYPE: list', None, None) + + self.__data_enrichment = data_enrichment + self.__key_modified['data_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/crm_field.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/crm_field.py new file mode 100644 index 0000000..038f994 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/crm_field.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CrmField(object): + def __init__(self): + """Creates an instance of CrmField""" + + self.__id = None + self.__api_name = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/data_enrichment.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/data_enrichment.py new file mode 100644 index 0000000..adee73d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/data_enrichment.py @@ -0,0 +1,318 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class DataEnrichment(object): + def __init__(self): + """Creates an instance of DataEnrichment""" + + self.__module = None + self.__type = None + self.__output_data_field_mapping = None + self.__input_data_field_mapping = None + self.__id = None + self.__status = None + self.__created_time = None + self.__created_by = None + self.__modified_time = None + self.__modified_by = None + self.__key_modified = dict() + + def get_module(self): + """ + The method to get the module + + Returns: + Module: An instance of Module + """ + + return self.__module + + def set_module(self, module): + """ + The method to set the value to module + + Parameters: + module (Module) : An instance of Module + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.module import Module + except Exception: + from .module import Module + + if module is not None and not isinstance(module, Module): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: module EXPECTED TYPE: Module', None, None) + + self.__module = module + self.__key_modified['module'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_output_data_field_mapping(self): + """ + The method to get the output_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__output_data_field_mapping + + def set_output_data_field_mapping(self, output_data_field_mapping): + """ + The method to set the value to output_data_field_mapping + + Parameters: + output_data_field_mapping (list) : An instance of list + """ + + if output_data_field_mapping is not None and not isinstance(output_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: output_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__output_data_field_mapping = output_data_field_mapping + self.__key_modified['output_data_field_mapping'] = 1 + + def get_input_data_field_mapping(self): + """ + The method to get the input_data_field_mapping + + Returns: + list: An instance of list + """ + + return self.__input_data_field_mapping + + def set_input_data_field_mapping(self, input_data_field_mapping): + """ + The method to set the value to input_data_field_mapping + + Parameters: + input_data_field_mapping (list) : An instance of list + """ + + if input_data_field_mapping is not None and not isinstance(input_data_field_mapping, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: input_data_field_mapping EXPECTED TYPE: list', None, None) + + self.__input_data_field_mapping = input_data_field_mapping + self.__key_modified['input_data_field_mapping'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + bool: A bool representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (bool) : A bool representing the status + """ + + if status is not None and not isinstance(status, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: bool', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + datetime: An instance of datetime + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (datetime) : An instance of datetime + """ + + from datetime import datetime + + if created_time is not None and not isinstance(created_time, datetime): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: datetime', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_modified_time(self): + """ + The method to get the modified_time + + Returns: + datetime: An instance of datetime + """ + + return self.__modified_time + + 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 get_modified_by(self): + """ + The method to get the modified_by + + Returns: + User: An instance of User + """ + + return self.__modified_by + + def set_modified_by(self, modified_by): + """ + The method to set the value to modified_by + + Parameters: + modified_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.user import User + except Exception: + from .user import User + + if modified_by is not None and not isinstance(modified_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modified_by EXPECTED TYPE: User', None, None) + + self.__modified_by = modified_by + self.__key_modified['modified_by'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/enrich_field.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/enrich_field.py new file mode 100644 index 0000000..e4acacf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/enrich_field.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichField(object): + def __init__(self): + """Creates an instance of EnrichField""" + + self.__name = None + self.__display_label = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_display_label(self): + """ + The method to get the display_label + + Returns: + string: A string representing the display_label + """ + + return self.__display_label + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/input_data.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/input_data.py new file mode 100644 index 0000000..e465734 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/input_data.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class InputData(object): + def __init__(self): + """Creates an instance of InputData""" + + self.__enrich_field = None + self.__crm_field = None + self.__key_modified = dict() + + def get_enrich_field(self): + """ + The method to get the enrich_field + + Returns: + EnrichField: An instance of EnrichField + """ + + return self.__enrich_field + + def set_enrich_field(self, enrich_field): + """ + The method to set the value to enrich_field + + Parameters: + enrich_field (EnrichField) : An instance of EnrichField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.enrich_field import EnrichField + except Exception: + from .enrich_field import EnrichField + + if enrich_field is not None and not isinstance(enrich_field, EnrichField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_field EXPECTED TYPE: EnrichField', None, None) + + self.__enrich_field = enrich_field + self.__key_modified['enrich_field'] = 1 + + def get_crm_field(self): + """ + The method to get the crm_field + + Returns: + CrmField: An instance of CrmField + """ + + return self.__crm_field + + def set_crm_field(self, crm_field): + """ + The method to set the value to crm_field + + Parameters: + crm_field (CrmField) : An instance of CrmField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.crm_field import CrmField + except Exception: + from .crm_field import CrmField + + if crm_field is not None and not isinstance(crm_field, CrmField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crm_field EXPECTED TYPE: CrmField', None, None) + + self.__crm_field = crm_field + self.__key_modified['crm_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/module.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/module.py new file mode 100644 index 0000000..af2dcdf --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/module.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Module(object): + def __init__(self): + """Creates an instance of Module""" + + self.__api_name = None + self.__id = None + self.__key_modified = dict() + + def get_api_name(self): + """ + The method to get the api_name + + Returns: + string: A string representing the api_name + """ + + return self.__api_name + + def set_api_name(self, api_name): + """ + The method to set the value to api_name + + Parameters: + api_name (string) : A string representing the api_name + """ + + if api_name is not None and not isinstance(api_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: api_name EXPECTED TYPE: str', None, None) + + self.__api_name = api_name + self.__key_modified['api_name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/output_data.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/output_data.py new file mode 100644 index 0000000..b100835 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/output_data.py @@ -0,0 +1,109 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class OutputData(object): + def __init__(self): + """Creates an instance of OutputData""" + + self.__enrich_field = None + self.__crm_field = None + self.__key_modified = dict() + + def get_enrich_field(self): + """ + The method to get the enrich_field + + Returns: + EnrichField: An instance of EnrichField + """ + + return self.__enrich_field + + def set_enrich_field(self, enrich_field): + """ + The method to set the value to enrich_field + + Parameters: + enrich_field (EnrichField) : An instance of EnrichField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.enrich_field import EnrichField + except Exception: + from .enrich_field import EnrichField + + if enrich_field is not None and not isinstance(enrich_field, EnrichField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_field EXPECTED TYPE: EnrichField', None, None) + + self.__enrich_field = enrich_field + self.__key_modified['enrich_field'] = 1 + + def get_crm_field(self): + """ + The method to get the crm_field + + Returns: + CrmField: An instance of CrmField + """ + + return self.__crm_field + + def set_crm_field(self, crm_field): + """ + The method to set the value to crm_field + + Parameters: + crm_field (CrmField) : An instance of CrmField + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.crm_field import CrmField + except Exception: + from .crm_field import CrmField + + if crm_field is not None and not isinstance(crm_field, CrmField): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: crm_field EXPECTED TYPE: CrmField', None, None) + + self.__crm_field = crm_field + self.__key_modified['crm_field'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/response_wrapper.py new file mode 100644 index 0000000..62f797d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/response_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ResponseWrapper(object): + def __init__(self): + """Creates an instance of ResponseWrapper""" + + self.__data_enrichment = None + self.__key_modified = dict() + + def get_data_enrichment(self): + """ + The method to get the data_enrichment + + Returns: + list: An instance of list + """ + + return self.__data_enrichment + + def set_data_enrichment(self, data_enrichment): + """ + The method to set the value to data_enrichment + + Parameters: + data_enrichment (list) : An instance of list + """ + + if data_enrichment is not None and not isinstance(data_enrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: data_enrichment EXPECTED TYPE: list', None, None) + + self.__data_enrichment = data_enrichment + self.__key_modified['data_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_response.py new file mode 100644 index 0000000..fb271d3 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ScrapyActionResponse(ABC): + def __init__(self): + """Creates an instance of ScrapyActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_wrapper.py new file mode 100644 index 0000000..4630b6e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_action_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScrapyActionWrapper(object): + def __init__(self): + """Creates an instance of ScrapyActionWrapper""" + + self.__scrapy_feedback = None + self.__key_modified = dict() + + def get_scrapy_feedback(self): + """ + The method to get the scrapy_feedback + + Returns: + ScrapyActionResponse: An instance of ScrapyActionResponse + """ + + return self.__scrapy_feedback + + def set_scrapy_feedback(self, scrapy_feedback): + """ + The method to set the value to scrapy_feedback + + Parameters: + scrapy_feedback (ScrapyActionResponse) : An instance of ScrapyActionResponse + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_action_response import ScrapyActionResponse + except Exception: + from .scrapy_action_response import ScrapyActionResponse + + if scrapy_feedback is not None and not isinstance(scrapy_feedback, ScrapyActionResponse): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scrapy_feedback EXPECTED TYPE: ScrapyActionResponse', None, None) + + self.__scrapy_feedback = scrapy_feedback + self.__key_modified['scrapy_feedback'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_body_wrapper.py new file mode 100644 index 0000000..97bb4a2 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_body_wrapper.py @@ -0,0 +1,79 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ScrapyBodyWrapper(object): + def __init__(self): + """Creates an instance of ScrapyBodyWrapper""" + + self.__scrapy_feedback = None + self.__key_modified = dict() + + def get_scrapy_feedback(self): + """ + The method to get the scrapy_feedback + + Returns: + ScrapyFeedback: An instance of ScrapyFeedback + """ + + return self.__scrapy_feedback + + def set_scrapy_feedback(self, scrapy_feedback): + """ + The method to set the value to scrapy_feedback + + Parameters: + scrapy_feedback (ScrapyFeedback) : An instance of ScrapyFeedback + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_feedback import ScrapyFeedback + except Exception: + from .scrapy_feedback import ScrapyFeedback + + if scrapy_feedback is not None and not isinstance(scrapy_feedback, ScrapyFeedback): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: scrapy_feedback EXPECTED TYPE: ScrapyFeedback', None, None) + + self.__scrapy_feedback = scrapy_feedback + self.__key_modified['scrapy_feedback'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_feedback.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_feedback.py new file mode 100644 index 0000000..4d9d8c9 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_feedback.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class ScrapyFeedback(object): + def __init__(self): + """Creates an instance of ScrapyFeedback""" + + self.__enrich_id = None + self.__type = None + self.__feedback = None + self.__comment = None + self.__key_modified = dict() + + def get_enrich_id(self): + """ + The method to get the enrich_id + + Returns: + Choice: An instance of Choice + """ + + return self.__enrich_id + + def set_enrich_id(self, enrich_id): + """ + The method to set the value to enrich_id + + Parameters: + enrich_id (Choice) : An instance of Choice + """ + + if enrich_id is not None and not isinstance(enrich_id, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_id EXPECTED TYPE: Choice', None, None) + + self.__enrich_id = enrich_id + self.__key_modified['enrich_id'] = 1 + + def get_type(self): + """ + The method to get the type + + Returns: + Choice: An instance of Choice + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (Choice) : An instance of Choice + """ + + if type is not None and not isinstance(type, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: Choice', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_feedback(self): + """ + The method to get the feedback + + Returns: + Choice: An instance of Choice + """ + + return self.__feedback + + def set_feedback(self, feedback): + """ + The method to set the value to feedback + + Parameters: + feedback (Choice) : An instance of Choice + """ + + if feedback is not None and not isinstance(feedback, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: feedback EXPECTED TYPE: Choice', None, None) + + self.__feedback = feedback + self.__key_modified['feedback'] = 1 + + def get_comment(self): + """ + The method to get the comment + + Returns: + string: A string representing the comment + """ + + return self.__comment + + def set_comment(self, comment): + """ + The method to set the value to comment + + Parameters: + comment (string) : A string representing the comment + """ + + if comment is not None and not isinstance(comment, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: comment EXPECTED TYPE: str', None, None) + + self.__comment = comment + self.__key_modified['comment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_success.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_success.py new file mode 100644 index 0000000..e182b36 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/scrapy_success.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.scrapy_action_response import ScrapyActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .scrapy_action_response import ScrapyActionResponse + + +class ScrapySuccess(ScrapyActionResponse): + def __init__(self): + """Creates an instance of ScrapySuccess""" + super().__init__() + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/success_response.py new file mode 100644 index 0000000..79ed422 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/success_response.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + + +class SuccessResponse(object): + def __init__(self): + """Creates an instance of SuccessResponse""" + + self.__code = None + self.__details = None + self.__message = None + self.__status = None + self.__key_modified = dict() + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + string: A string representing the message + """ + + return self.__message + + def set_message(self, message): + """ + The method to set the value to message + + Parameters: + message (string) : A string representing the message + """ + + if message is not None and not isinstance(message, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: message EXPECTED TYPE: str', None, None) + + self.__message = message + self.__key_modified['message'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/user.py b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/user.py new file mode 100644 index 0000000..65fd721 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_enrichment/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__id = None + self.__name = None + self.__key_modified = dict() + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/__init__.py new file mode 100644 index 0000000..22ce24d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/__init__.py @@ -0,0 +1,18 @@ +from .action_wrapper import ActionWrapper +from .address import Address +from .zia_org_enrichment_operations import ZiaOrgEnrichmentOperations, GetZiaOrgEnrichmentsParam, CreateZiaOrgEnrichmentParam +from .description import Description +from .body_wrapper import BodyWrapper +from .industry import Industry +from .enrich_based_on import EnrichBasedOn +from .api_exception import APIException +from .response_handler import ResponseHandler +from .action_response import ActionResponse +from .success_response import SuccessResponse +from .enriched_data import EnrichedData +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .zia_org_enrichment import ZiaOrgEnrichment +from .user import User +from .social_media import SocialMedia +from .info import Info diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_wrapper.py new file mode 100644 index 0000000..a873ed7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__ziaorgenrichment = None + self.__key_modified = dict() + + def get_ziaorgenrichment(self): + """ + The method to get the ziaorgenrichment + + Returns: + list: An instance of list + """ + + return self.__ziaorgenrichment + + def set_ziaorgenrichment(self, ziaorgenrichment): + """ + The method to set the value to ziaorgenrichment + + Parameters: + ziaorgenrichment (list) : An instance of list + """ + + if ziaorgenrichment is not None and not isinstance(ziaorgenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziaorgenrichment EXPECTED TYPE: list', None, None) + + self.__ziaorgenrichment = ziaorgenrichment + self.__key_modified['__zia_org_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/address.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/address.py new file mode 100644 index 0000000..708c4b7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__country = None + self.__city = None + self.__pin_code = None + self.__state = None + self.__fill_address = None + self.__key_modified = dict() + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.__country + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.__country = country + self.__key_modified['country'] = 1 + + def get_city(self): + """ + The method to get the city + + Returns: + string: A string representing the city + """ + + return self.__city + + def set_city(self, city): + """ + The method to set the value to city + + Parameters: + city (string) : A string representing the city + """ + + if city is not None and not isinstance(city, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: city EXPECTED TYPE: str', None, None) + + self.__city = city + self.__key_modified['city'] = 1 + + def get_pin_code(self): + """ + The method to get the pin_code + + Returns: + string: A string representing the pin_code + """ + + return self.__pin_code + + def set_pin_code(self, pin_code): + """ + The method to set the value to pin_code + + Parameters: + pin_code (string) : A string representing the pin_code + """ + + if pin_code is not None and not isinstance(pin_code, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: pin_code EXPECTED TYPE: str', None, None) + + self.__pin_code = pin_code + self.__key_modified['pin_code'] = 1 + + def get_state(self): + """ + The method to get the state + + Returns: + string: A string representing the state + """ + + return self.__state + + def set_state(self, state): + """ + The method to set the value to state + + Parameters: + state (string) : A string representing the state + """ + + if state is not None and not isinstance(state, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: state EXPECTED TYPE: str', None, None) + + self.__state = state + self.__key_modified['state'] = 1 + + def get_fill_address(self): + """ + The method to get the fill_address + + Returns: + string: A string representing the fill_address + """ + + return self.__fill_address + + def set_fill_address(self, fill_address): + """ + The method to set the value to fill_address + + Parameters: + fill_address (string) : A string representing the fill_address + """ + + if fill_address is not None and not isinstance(fill_address, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: fill_address EXPECTED TYPE: str', None, None) + + self.__fill_address = fill_address + self.__key_modified['fill_address'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/api_exception.py new file mode 100644 index 0000000..4966e48 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/body_wrapper.py new file mode 100644 index 0000000..1647bca --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__ziaorgenrichment = None + self.__key_modified = dict() + + def get_ziaorgenrichment(self): + """ + The method to get the ziaorgenrichment + + Returns: + list: An instance of list + """ + + return self.__ziaorgenrichment + + def set_ziaorgenrichment(self, ziaorgenrichment): + """ + The method to set the value to ziaorgenrichment + + Parameters: + ziaorgenrichment (list) : An instance of list + """ + + if ziaorgenrichment is not None and not isinstance(ziaorgenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziaorgenrichment EXPECTED TYPE: list', None, None) + + self.__ziaorgenrichment = ziaorgenrichment + self.__key_modified['__zia_org_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/description.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/description.py new file mode 100644 index 0000000..552b37b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/description.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Description(object): + def __init__(self): + """Creates an instance of Description""" + + self.__title = None + self.__description = None + self.__key_modified = dict() + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enrich_based_on.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enrich_based_on.py new file mode 100644 index 0000000..fc3824d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enrich_based_on.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichBasedOn(object): + def __init__(self): + """Creates an instance of EnrichBasedOn""" + + self.__name = None + self.__email = None + self.__website = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enriched_data.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enriched_data.py new file mode 100644 index 0000000..1e5a4b7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/enriched_data.py @@ -0,0 +1,724 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichedData(object): + def __init__(self): + """Creates an instance of EnrichedData""" + + self.__org_status = None + self.__description = None + self.__ceo = None + self.__secondary_email = None + self.__revenue = None + self.__years_in_industry = None + self.__other_contacts = None + self.__techno_graphic_data = None + self.__logo = None + self.__secondary_contact = None + self.__id = None + self.__other_emails = None + self.__sign_in = None + self.__website = None + self.__address = None + self.__sign_up = None + self.__org_type = None + self.__head_quarters = None + self.__no_of_employees = None + self.__territory_list = None + self.__founding_year = None + self.__industries = None + self.__name = None + self.__primary_email = None + self.__business_model = None + self.__primary_contact = None + self.__social_media = None + self.__key_modified = dict() + + def get_org_status(self): + """ + The method to get the org_status + + Returns: + string: A string representing the org_status + """ + + return self.__org_status + + def set_org_status(self, org_status): + """ + The method to set the value to org_status + + Parameters: + org_status (string) : A string representing the org_status + """ + + if org_status is not None and not isinstance(org_status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_status EXPECTED TYPE: str', None, None) + + self.__org_status = org_status + self.__key_modified['org_status'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + list: An instance of list + """ + + return self.__description + + def set_description(self, description): + """ + The method to set the value to description + + Parameters: + description (list) : An instance of list + """ + + if description is not None and not isinstance(description, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: description EXPECTED TYPE: list', None, None) + + self.__description = description + self.__key_modified['description'] = 1 + + def get_ceo(self): + """ + The method to get the ceo + + Returns: + string: A string representing the ceo + """ + + return self.__ceo + + def set_ceo(self, ceo): + """ + The method to set the value to ceo + + Parameters: + ceo (string) : A string representing the ceo + """ + + if ceo is not None and not isinstance(ceo, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ceo EXPECTED TYPE: str', None, None) + + self.__ceo = ceo + self.__key_modified['ceo'] = 1 + + def get_secondary_email(self): + """ + The method to get the secondary_email + + Returns: + string: A string representing the secondary_email + """ + + return self.__secondary_email + + def set_secondary_email(self, secondary_email): + """ + The method to set the value to secondary_email + + Parameters: + secondary_email (string) : A string representing the secondary_email + """ + + if secondary_email is not None and not isinstance(secondary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secondary_email EXPECTED TYPE: str', None, None) + + self.__secondary_email = secondary_email + self.__key_modified['secondary_email'] = 1 + + def get_revenue(self): + """ + The method to get the revenue + + Returns: + string: A string representing the revenue + """ + + return self.__revenue + + def set_revenue(self, revenue): + """ + The method to set the value to revenue + + Parameters: + revenue (string) : A string representing the revenue + """ + + if revenue is not None and not isinstance(revenue, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: revenue EXPECTED TYPE: str', None, None) + + self.__revenue = revenue + self.__key_modified['revenue'] = 1 + + def get_years_in_industry(self): + """ + The method to get the years_in_industry + + Returns: + string: A string representing the years_in_industry + """ + + return self.__years_in_industry + + def set_years_in_industry(self, years_in_industry): + """ + The method to set the value to years_in_industry + + Parameters: + years_in_industry (string) : A string representing the years_in_industry + """ + + if years_in_industry is not None and not isinstance(years_in_industry, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: years_in_industry EXPECTED TYPE: str', None, None) + + self.__years_in_industry = years_in_industry + self.__key_modified['years_in_industry'] = 1 + + def get_other_contacts(self): + """ + The method to get the other_contacts + + Returns: + list: An instance of list + """ + + return self.__other_contacts + + def set_other_contacts(self, other_contacts): + """ + The method to set the value to other_contacts + + Parameters: + other_contacts (list) : An instance of list + """ + + if other_contacts is not None and not isinstance(other_contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_contacts EXPECTED TYPE: list', None, None) + + self.__other_contacts = other_contacts + self.__key_modified['other_contacts'] = 1 + + def get_techno_graphic_data(self): + """ + The method to get the techno_graphic_data + + Returns: + string: A string representing the techno_graphic_data + """ + + return self.__techno_graphic_data + + def set_techno_graphic_data(self, techno_graphic_data): + """ + The method to set the value to techno_graphic_data + + Parameters: + techno_graphic_data (string) : A string representing the techno_graphic_data + """ + + if techno_graphic_data is not None and not isinstance(techno_graphic_data, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: techno_graphic_data EXPECTED TYPE: str', None, None) + + self.__techno_graphic_data = techno_graphic_data + self.__key_modified['techno_graphic_data'] = 1 + + def get_logo(self): + """ + The method to get the logo + + Returns: + string: A string representing the logo + """ + + return self.__logo + + def set_logo(self, logo): + """ + The method to set the value to logo + + Parameters: + logo (string) : A string representing the logo + """ + + if logo is not None and not isinstance(logo, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: logo EXPECTED TYPE: str', None, None) + + self.__logo = logo + self.__key_modified['logo'] = 1 + + def get_secondary_contact(self): + """ + The method to get the secondary_contact + + Returns: + string: A string representing the secondary_contact + """ + + return self.__secondary_contact + + def set_secondary_contact(self, secondary_contact): + """ + The method to set the value to secondary_contact + + Parameters: + secondary_contact (string) : A string representing the secondary_contact + """ + + if secondary_contact is not None and not isinstance(secondary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secondary_contact EXPECTED TYPE: str', None, None) + + self.__secondary_contact = secondary_contact + self.__key_modified['secondary_contact'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_other_emails(self): + """ + The method to get the other_emails + + Returns: + list: An instance of list + """ + + return self.__other_emails + + def set_other_emails(self, other_emails): + """ + The method to set the value to other_emails + + Parameters: + other_emails (list) : An instance of list + """ + + if other_emails is not None and not isinstance(other_emails, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_emails EXPECTED TYPE: list', None, None) + + self.__other_emails = other_emails + self.__key_modified['other_emails'] = 1 + + def get_sign_in(self): + """ + The method to get the sign_in + + Returns: + string: A string representing the sign_in + """ + + return self.__sign_in + + def set_sign_in(self, sign_in): + """ + The method to set the value to sign_in + + Parameters: + sign_in (string) : A string representing the sign_in + """ + + if sign_in is not None and not isinstance(sign_in, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_in EXPECTED TYPE: str', None, None) + + self.__sign_in = sign_in + self.__key_modified['sign_in'] = 1 + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_address(self): + """ + The method to get the address + + Returns: + list: An instance of list + """ + + return self.__address + + def set_address(self, address): + """ + The method to set the value to address + + Parameters: + address (list) : An instance of list + """ + + if address is not None and not isinstance(address, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: address EXPECTED TYPE: list', None, None) + + self.__address = address + self.__key_modified['address'] = 1 + + def get_sign_up(self): + """ + The method to get the sign_up + + Returns: + string: A string representing the sign_up + """ + + return self.__sign_up + + def set_sign_up(self, sign_up): + """ + The method to set the value to sign_up + + Parameters: + sign_up (string) : A string representing the sign_up + """ + + if sign_up is not None and not isinstance(sign_up, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: sign_up EXPECTED TYPE: str', None, None) + + self.__sign_up = sign_up + self.__key_modified['sign_up'] = 1 + + def get_org_type(self): + """ + The method to get the org_type + + Returns: + string: A string representing the org_type + """ + + return self.__org_type + + def set_org_type(self, org_type): + """ + The method to set the value to org_type + + Parameters: + org_type (string) : A string representing the org_type + """ + + if org_type is not None and not isinstance(org_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: org_type EXPECTED TYPE: str', None, None) + + self.__org_type = org_type + self.__key_modified['org_type'] = 1 + + def get_head_quarters(self): + """ + The method to get the head_quarters + + Returns: + list: An instance of list + """ + + return self.__head_quarters + + def set_head_quarters(self, head_quarters): + """ + The method to set the value to head_quarters + + Parameters: + head_quarters (list) : An instance of list + """ + + if head_quarters is not None and not isinstance(head_quarters, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: head_quarters EXPECTED TYPE: list', None, None) + + self.__head_quarters = head_quarters + self.__key_modified['head_quarters'] = 1 + + def get_no_of_employees(self): + """ + The method to get the no_of_employees + + Returns: + string: A string representing the no_of_employees + """ + + return self.__no_of_employees + + def set_no_of_employees(self, no_of_employees): + """ + The method to set the value to no_of_employees + + Parameters: + no_of_employees (string) : A string representing the no_of_employees + """ + + if no_of_employees is not None and not isinstance(no_of_employees, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: no_of_employees EXPECTED TYPE: str', None, None) + + self.__no_of_employees = no_of_employees + self.__key_modified['no_of_employees'] = 1 + + def get_territory_list(self): + """ + The method to get the territory_list + + Returns: + list: An instance of list + """ + + return self.__territory_list + + def set_territory_list(self, territory_list): + """ + The method to set the value to territory_list + + Parameters: + territory_list (list) : An instance of list + """ + + if territory_list is not None and not isinstance(territory_list, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: territory_list EXPECTED TYPE: list', None, None) + + self.__territory_list = territory_list + self.__key_modified['territory_list'] = 1 + + def get_founding_year(self): + """ + The method to get the founding_year + + Returns: + string: A string representing the founding_year + """ + + return self.__founding_year + + def set_founding_year(self, founding_year): + """ + The method to set the value to founding_year + + Parameters: + founding_year (string) : A string representing the founding_year + """ + + if founding_year is not None and not isinstance(founding_year, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: founding_year EXPECTED TYPE: str', None, None) + + self.__founding_year = founding_year + self.__key_modified['founding_year'] = 1 + + def get_industries(self): + """ + The method to get the industries + + Returns: + list: An instance of list + """ + + return self.__industries + + def set_industries(self, industries): + """ + The method to set the value to industries + + Parameters: + industries (list) : An instance of list + """ + + if industries is not None and not isinstance(industries, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: industries EXPECTED TYPE: list', None, None) + + self.__industries = industries + self.__key_modified['industries'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_primary_email(self): + """ + The method to get the primary_email + + Returns: + string: A string representing the primary_email + """ + + return self.__primary_email + + def set_primary_email(self, primary_email): + """ + The method to set the value to primary_email + + Parameters: + primary_email (string) : A string representing the primary_email + """ + + if primary_email is not None and not isinstance(primary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_email EXPECTED TYPE: str', None, None) + + self.__primary_email = primary_email + self.__key_modified['primary_email'] = 1 + + def get_business_model(self): + """ + The method to get the business_model + + Returns: + list: An instance of list + """ + + return self.__business_model + + def set_business_model(self, business_model): + """ + The method to set the value to business_model + + Parameters: + business_model (list) : An instance of list + """ + + if business_model is not None and not isinstance(business_model, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: business_model EXPECTED TYPE: list', None, None) + + self.__business_model = business_model + self.__key_modified['business_model'] = 1 + + def get_primary_contact(self): + """ + The method to get the primary_contact + + Returns: + string: A string representing the primary_contact + """ + + return self.__primary_contact + + def set_primary_contact(self, primary_contact): + """ + The method to set the value to primary_contact + + Parameters: + primary_contact (string) : A string representing the primary_contact + """ + + if primary_contact is not None and not isinstance(primary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_contact EXPECTED TYPE: str', None, None) + + self.__primary_contact = primary_contact + self.__key_modified['primary_contact'] = 1 + + def get_social_media(self): + """ + The method to get the social_media + + Returns: + list: An instance of list + """ + + return self.__social_media + + def set_social_media(self, social_media): + """ + The method to set the value to social_media + + Parameters: + social_media (list) : An instance of list + """ + + if social_media is not None and not isinstance(social_media, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: social_media EXPECTED TYPE: list', None, None) + + self.__social_media = social_media + self.__key_modified['social_media'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/industry.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/industry.py new file mode 100644 index 0000000..b3c742a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/industry.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Industry(object): + def __init__(self): + """Creates an instance of Industry""" + + self.__name = None + self.__description = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/info.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_wrapper.py new file mode 100644 index 0000000..d5d89ed --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__ziaorgenrichment = None + self.__info = None + self.__key_modified = dict() + + def get_ziaorgenrichment(self): + """ + The method to get the ziaorgenrichment + + Returns: + list: An instance of list + """ + + return self.__ziaorgenrichment + + def set_ziaorgenrichment(self, ziaorgenrichment): + """ + The method to set the value to ziaorgenrichment + + Parameters: + ziaorgenrichment (list) : An instance of list + """ + + if ziaorgenrichment is not None and not isinstance(ziaorgenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziaorgenrichment EXPECTED TYPE: list', None, None) + + self.__ziaorgenrichment = ziaorgenrichment + self.__key_modified['__zia_org_enrichment'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/social_media.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/social_media.py new file mode 100644 index 0000000..75f5791 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/social_media.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SocialMedia(object): + def __init__(self): + """Creates an instance of SocialMedia""" + + self.__media_type = None + self.__media_url = None + self.__key_modified = dict() + + def get_media_type(self): + """ + The method to get the media_type + + Returns: + string: A string representing the media_type + """ + + return self.__media_type + + def set_media_type(self, media_type): + """ + The method to set the value to media_type + + Parameters: + media_type (string) : A string representing the media_type + """ + + if media_type is not None and not isinstance(media_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_type EXPECTED TYPE: str', None, None) + + self.__media_type = media_type + self.__key_modified['media_type'] = 1 + + def get_media_url(self): + """ + The method to get the media_url + + Returns: + list: An instance of list + """ + + return self.__media_url + + def set_media_url(self, media_url): + """ + The method to set the value to media_url + + Parameters: + media_url (list) : An instance of list + """ + + if media_url is not None and not isinstance(media_url, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_url EXPECTED TYPE: list', None, None) + + self.__media_url = media_url + self.__key_modified['media_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/success_response.py new file mode 100644 index 0000000..619ff25 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/user.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment.py new file mode 100644 index 0000000..dd737c8 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment.py @@ -0,0 +1,214 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ZiaOrgEnrichment(object): + def __init__(self): + """Creates an instance of ZiaOrgEnrichment""" + + self.__enriched_data = None + self.__created_time = None + self.__id = None + self.__created_by = None + self.__status = None + self.__enrich_based_on = None + self.__key_modified = dict() + + def get_enriched_data(self): + """ + The method to get the enriched_data + + Returns: + EnrichedData: An instance of EnrichedData + """ + + return self.__enriched_data + + def set_enriched_data(self, enriched_data): + """ + The method to set the value to enriched_data + + Parameters: + enriched_data (EnrichedData) : An instance of EnrichedData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.enriched_data import EnrichedData + except Exception: + from .enriched_data import EnrichedData + + if enriched_data is not None and not isinstance(enriched_data, EnrichedData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enriched_data EXPECTED TYPE: EnrichedData', None, None) + + self.__enriched_data = enriched_data + self.__key_modified['enriched_data'] = 1 + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_enrich_based_on(self): + """ + The method to get the enrich_based_on + + Returns: + EnrichBasedOn: An instance of EnrichBasedOn + """ + + return self.__enrich_based_on + + def set_enrich_based_on(self, enrich_based_on): + """ + The method to set the value to enrich_based_on + + Parameters: + enrich_based_on (EnrichBasedOn) : An instance of EnrichBasedOn + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.enrich_based_on import EnrichBasedOn + except Exception: + from .enrich_based_on import EnrichBasedOn + + if enrich_based_on is not None and not isinstance(enrich_based_on, EnrichBasedOn): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_based_on EXPECTED TYPE: EnrichBasedOn', None, None) + + self.__enrich_based_on = enrich_based_on + self.__key_modified['enrich_based_on'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment_operations.py b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment_operations.py new file mode 100644 index 0000000..63e5d2c --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_org_enrichment/zia_org_enrichment_operations.py @@ -0,0 +1,139 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class ZiaOrgEnrichmentOperations(object): + def __init__(self): + """Creates an instance of ZiaOrgEnrichmentOperations""" + pass + + def get_zia_org_enrichments(self, param_instance=None): + """ + The method to get zia org enrichments + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/__zia_org_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_zia_org_enrichment(self, zia_org_enrichment_id): + """ + The method to get zia org enrichment + + Parameters: + zia_org_enrichment_id (int) : An int representing the zia_org_enrichment_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(zia_org_enrichment_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_org_enrichment_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__zia_org_enrichment/' + api_path = api_path + str(zia_org_enrichment_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_zia_org_enrichment(self, request, param_instance=None): + """ + The method to create zia org enrichment + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/__zia_org_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetZiaOrgEnrichmentsParam(object): + status = Param('status', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + page = Param('page', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + per_page = Param('per_page', 'com.zoho.crm.api.ZiaOrgEnrichment.GetZiaOrgEnrichmentsParam') + + +class CreateZiaOrgEnrichmentParam(object): + module = Param('module', 'com.zoho.crm.api.ZiaOrgEnrichment.CreateZiaOrgEnrichmentParam') + record_id = Param('record_id', 'com.zoho.crm.api.ZiaOrgEnrichment.CreateZiaOrgEnrichmentParam') diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/__init__.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/__init__.py new file mode 100644 index 0000000..74825da --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/__init__.py @@ -0,0 +1,22 @@ +from .action_wrapper import ActionWrapper +from .address import Address +from .social import Social +from .email_info import EmailInfo +from .company_info import CompanyInfo +from .zia_people_enrichment import ZiaPeopleEnrichment +from .body_wrapper import BodyWrapper +from .industry import Industry +from .experience import Experience +from .enrich_based_on import EnrichBasedOn +from .api_exception import APIException +from .action_response import ActionResponse +from .response_handler import ResponseHandler +from .success_response import SuccessResponse +from .zia_people_enrichment_operations import ZiaPeopleEnrichmentOperations, GetZiaPeopleEnrichmentsParam, CreateZiaPeopleEnrichmentParam +from .enriched_data import EnrichedData +from .response_wrapper import ResponseWrapper +from .action_handler import ActionHandler +from .company import Company +from .user import User +from .info import Info +from .social_media import SocialMedia diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_handler.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_handler.py new file mode 100644 index 0000000..45ce840 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionHandler(ABC): + def __init__(self): + """Creates an instance of ActionHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_response.py new file mode 100644 index 0000000..2f5ad9b --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_response.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ActionResponse(ABC): + def __init__(self): + """Creates an instance of ActionResponse""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_wrapper.py new file mode 100644 index 0000000..a32e96e --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/action_wrapper.py @@ -0,0 +1,77 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .action_handler import ActionHandler + + +class ActionWrapper(ActionHandler): + def __init__(self): + """Creates an instance of ActionWrapper""" + super().__init__() + + self.__ziapeopleenrichment = None + self.__key_modified = dict() + + def get_ziapeopleenrichment(self): + """ + The method to get the ziapeopleenrichment + + Returns: + list: An instance of list + """ + + return self.__ziapeopleenrichment + + def set_ziapeopleenrichment(self, ziapeopleenrichment): + """ + The method to set the value to ziapeopleenrichment + + Parameters: + ziapeopleenrichment (list) : An instance of list + """ + + if ziapeopleenrichment is not None and not isinstance(ziapeopleenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziapeopleenrichment EXPECTED TYPE: list', None, None) + + self.__ziapeopleenrichment = ziapeopleenrichment + self.__key_modified['__zia_people_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/address.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/address.py new file mode 100644 index 0000000..8f6fa4a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/address.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Address(object): + def __init__(self): + """Creates an instance of Address""" + + self.__continent = None + self.__country = None + self.__name = None + self.__region = None + self.__primary = None + self.__key_modified = dict() + + def get_continent(self): + """ + The method to get the continent + + Returns: + string: A string representing the continent + """ + + return self.__continent + + def set_continent(self, continent): + """ + The method to set the value to continent + + Parameters: + continent (string) : A string representing the continent + """ + + if continent is not None and not isinstance(continent, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: continent EXPECTED TYPE: str', None, None) + + self.__continent = continent + self.__key_modified['continent'] = 1 + + def get_country(self): + """ + The method to get the country + + Returns: + string: A string representing the country + """ + + return self.__country + + def set_country(self, country): + """ + The method to set the value to country + + Parameters: + country (string) : A string representing the country + """ + + if country is not None and not isinstance(country, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: country EXPECTED TYPE: str', None, None) + + self.__country = country + self.__key_modified['country'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_region(self): + """ + The method to get the region + + Returns: + string: A string representing the region + """ + + return self.__region + + def set_region(self, region): + """ + The method to set the value to region + + Parameters: + region (string) : A string representing the region + """ + + if region is not None and not isinstance(region, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: region EXPECTED TYPE: str', None, None) + + self.__region = region + self.__key_modified['region'] = 1 + + def get_primary(self): + """ + The method to get the primary + + Returns: + bool: A bool representing the primary + """ + + return self.__primary + + def set_primary(self, primary): + """ + The method to set the value to primary + + Parameters: + primary (bool) : A bool representing the primary + """ + + if primary is not None and not isinstance(primary, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary EXPECTED TYPE: bool', None, None) + + self.__primary = primary + self.__key_modified['primary'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/api_exception.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/api_exception.py new file mode 100644 index 0000000..a936be4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/api_exception.py @@ -0,0 +1,156 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_response import ActionResponse + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_handler import ActionHandler +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + from .response_handler import ResponseHandler + from .action_handler import ActionHandler + + +class APIException(ResponseHandler, ActionHandler, ActionResponse): + def __init__(self): + """Creates an instance of APIException""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/body_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/body_wrapper.py new file mode 100644 index 0000000..01e2137 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/body_wrapper.py @@ -0,0 +1,74 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class BodyWrapper(object): + def __init__(self): + """Creates an instance of BodyWrapper""" + + self.__ziapeopleenrichment = None + self.__key_modified = dict() + + def get_ziapeopleenrichment(self): + """ + The method to get the ziapeopleenrichment + + Returns: + list: An instance of list + """ + + return self.__ziapeopleenrichment + + def set_ziapeopleenrichment(self, ziapeopleenrichment): + """ + The method to set the value to ziapeopleenrichment + + Parameters: + ziapeopleenrichment (list) : An instance of list + """ + + if ziapeopleenrichment is not None and not isinstance(ziapeopleenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziapeopleenrichment EXPECTED TYPE: list', None, None) + + self.__ziapeopleenrichment = ziapeopleenrichment + self.__key_modified['__zia_people_enrichment'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company.py new file mode 100644 index 0000000..a8986a5 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Company(object): + def __init__(self): + """Creates an instance of Company""" + + self.__website = None + self.__name = None + self.__key_modified = dict() + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company_info.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company_info.py new file mode 100644 index 0000000..602e9a4 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/company_info.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class CompanyInfo(object): + def __init__(self): + """Creates an instance of CompanyInfo""" + + self.__name = None + self.__industries = None + self.__experiences = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_industries(self): + """ + The method to get the industries + + Returns: + list: An instance of list + """ + + return self.__industries + + def set_industries(self, industries): + """ + The method to set the value to industries + + Parameters: + industries (list) : An instance of list + """ + + if industries is not None and not isinstance(industries, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: industries EXPECTED TYPE: list', None, None) + + self.__industries = industries + self.__key_modified['industries'] = 1 + + def get_experiences(self): + """ + The method to get the experiences + + Returns: + list: An instance of list + """ + + return self.__experiences + + def set_experiences(self, experiences): + """ + The method to set the value to experiences + + Parameters: + experiences (list) : An instance of list + """ + + if experiences is not None and not isinstance(experiences, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: experiences EXPECTED TYPE: list', None, None) + + self.__experiences = experiences + self.__key_modified['experiences'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/email_info.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/email_info.py new file mode 100644 index 0000000..55367c1 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/email_info.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EmailInfo(object): + def __init__(self): + """Creates an instance of EmailInfo""" + + self.__type = None + self.__email = None + self.__key_modified = dict() + + def get_type(self): + """ + The method to get the type + + Returns: + string: A string representing the type + """ + + return self.__type + + def set_type(self, type): + """ + The method to set the value to type + + Parameters: + type (string) : A string representing the type + """ + + if type is not None and not isinstance(type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: type EXPECTED TYPE: str', None, None) + + self.__type = type + self.__key_modified['type'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enrich_based_on.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enrich_based_on.py new file mode 100644 index 0000000..a2c8ca7 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enrich_based_on.py @@ -0,0 +1,159 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichBasedOn(object): + def __init__(self): + """Creates an instance of EnrichBasedOn""" + + self.__social = None + self.__name = None + self.__company = None + self.__email = None + self.__key_modified = dict() + + def get_social(self): + """ + The method to get the social + + Returns: + Social: An instance of Social + """ + + return self.__social + + def set_social(self, social): + """ + The method to set the value to social + + Parameters: + social (Social) : An instance of Social + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.social import Social + except Exception: + from .social import Social + + if social is not None and not isinstance(social, Social): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: social EXPECTED TYPE: Social', None, None) + + self.__social = social + self.__key_modified['social'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_company(self): + """ + The method to get the company + + Returns: + Company: An instance of Company + """ + + return self.__company + + def set_company(self, company): + """ + The method to set the value to company + + Parameters: + company (Company) : An instance of Company + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.company import Company + except Exception: + from .company import Company + + if company is not None and not isinstance(company, Company): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company EXPECTED TYPE: Company', None, None) + + self.__company = company + self.__key_modified['company'] = 1 + + def get_email(self): + """ + The method to get the email + + Returns: + string: A string representing the email + """ + + return self.__email + + def set_email(self, email): + """ + The method to set the value to email + + Parameters: + email (string) : A string representing the email + """ + + if email is not None and not isinstance(email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email EXPECTED TYPE: str', None, None) + + self.__email = email + self.__key_modified['email'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enriched_data.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enriched_data.py new file mode 100644 index 0000000..3792c52 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/enriched_data.py @@ -0,0 +1,559 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class EnrichedData(object): + def __init__(self): + """Creates an instance of EnrichedData""" + + self.__website = None + self.__email_infos = None + self.__gender = None + self.__company_info = None + self.__last_name = None + self.__educations = None + self.__middle_name = None + self.__skills = None + self.__other_contacts = None + self.__address_list_info = None + self.__primary_address_info = None + self.__name = None + self.__secondary_contact = None + self.__primary_email = None + self.__designation = None + self.__id = None + self.__interests = None + self.__first_name = None + self.__primary_contact = None + self.__social_media = None + self.__key_modified = dict() + + def get_website(self): + """ + The method to get the website + + Returns: + string: A string representing the website + """ + + return self.__website + + def set_website(self, website): + """ + The method to set the value to website + + Parameters: + website (string) : A string representing the website + """ + + if website is not None and not isinstance(website, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: website EXPECTED TYPE: str', None, None) + + self.__website = website + self.__key_modified['website'] = 1 + + def get_email_infos(self): + """ + The method to get the email_infos + + Returns: + list: An instance of list + """ + + return self.__email_infos + + def set_email_infos(self, email_infos): + """ + The method to set the value to email_infos + + Parameters: + email_infos (list) : An instance of list + """ + + if email_infos is not None and not isinstance(email_infos, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: email_infos EXPECTED TYPE: list', None, None) + + self.__email_infos = email_infos + self.__key_modified['email_infos'] = 1 + + def get_gender(self): + """ + The method to get the gender + + Returns: + string: A string representing the gender + """ + + return self.__gender + + def set_gender(self, gender): + """ + The method to set the value to gender + + Parameters: + gender (string) : A string representing the gender + """ + + if gender is not None and not isinstance(gender, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: gender EXPECTED TYPE: str', None, None) + + self.__gender = gender + self.__key_modified['gender'] = 1 + + def get_company_info(self): + """ + The method to get the company_info + + Returns: + CompanyInfo: An instance of CompanyInfo + """ + + return self.__company_info + + def set_company_info(self, company_info): + """ + The method to set the value to company_info + + Parameters: + company_info (CompanyInfo) : An instance of CompanyInfo + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.company_info import CompanyInfo + except Exception: + from .company_info import CompanyInfo + + if company_info is not None and not isinstance(company_info, CompanyInfo): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company_info EXPECTED TYPE: CompanyInfo', None, None) + + self.__company_info = company_info + self.__key_modified['company_info'] = 1 + + def get_last_name(self): + """ + The method to get the last_name + + Returns: + string: A string representing the last_name + """ + + return self.__last_name + + def set_last_name(self, last_name): + """ + The method to set the value to last_name + + Parameters: + last_name (string) : A string representing the last_name + """ + + if last_name is not None and not isinstance(last_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: last_name EXPECTED TYPE: str', None, None) + + self.__last_name = last_name + self.__key_modified['last_name'] = 1 + + def get_educations(self): + """ + The method to get the educations + + Returns: + list: An instance of list + """ + + return self.__educations + + def set_educations(self, educations): + """ + The method to set the value to educations + + Parameters: + educations (list) : An instance of list + """ + + if educations is not None and not isinstance(educations, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: educations EXPECTED TYPE: list', None, None) + + self.__educations = educations + self.__key_modified['educations'] = 1 + + def get_middle_name(self): + """ + The method to get the middle_name + + Returns: + string: A string representing the middle_name + """ + + return self.__middle_name + + def set_middle_name(self, middle_name): + """ + The method to set the value to middle_name + + Parameters: + middle_name (string) : A string representing the middle_name + """ + + if middle_name is not None and not isinstance(middle_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: middle_name EXPECTED TYPE: str', None, None) + + self.__middle_name = middle_name + self.__key_modified['middle_name'] = 1 + + def get_skills(self): + """ + The method to get the skills + + Returns: + list: An instance of list + """ + + return self.__skills + + def set_skills(self, skills): + """ + The method to set the value to skills + + Parameters: + skills (list) : An instance of list + """ + + if skills is not None and not isinstance(skills, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: skills EXPECTED TYPE: list', None, None) + + self.__skills = skills + self.__key_modified['skills'] = 1 + + def get_other_contacts(self): + """ + The method to get the other_contacts + + Returns: + list: An instance of list + """ + + return self.__other_contacts + + def set_other_contacts(self, other_contacts): + """ + The method to set the value to other_contacts + + Parameters: + other_contacts (list) : An instance of list + """ + + if other_contacts is not None and not isinstance(other_contacts, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: other_contacts EXPECTED TYPE: list', None, None) + + self.__other_contacts = other_contacts + self.__key_modified['other_contacts'] = 1 + + def get_address_list_info(self): + """ + The method to get the address_list_info + + Returns: + list: An instance of list + """ + + return self.__address_list_info + + def set_address_list_info(self, address_list_info): + """ + The method to set the value to address_list_info + + Parameters: + address_list_info (list) : An instance of list + """ + + if address_list_info is not None and not isinstance(address_list_info, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: address_list_info EXPECTED TYPE: list', None, None) + + self.__address_list_info = address_list_info + self.__key_modified['address_list_info'] = 1 + + def get_primary_address_info(self): + """ + The method to get the primary_address_info + + Returns: + Address: An instance of Address + """ + + return self.__primary_address_info + + def set_primary_address_info(self, primary_address_info): + """ + The method to set the value to primary_address_info + + Parameters: + primary_address_info (Address) : An instance of Address + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.address import Address + except Exception: + from .address import Address + + if primary_address_info is not None and not isinstance(primary_address_info, Address): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_address_info EXPECTED TYPE: Address', None, None) + + self.__primary_address_info = primary_address_info + self.__key_modified['primary_address_info'] = 1 + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_secondary_contact(self): + """ + The method to get the secondary_contact + + Returns: + string: A string representing the secondary_contact + """ + + return self.__secondary_contact + + def set_secondary_contact(self, secondary_contact): + """ + The method to set the value to secondary_contact + + Parameters: + secondary_contact (string) : A string representing the secondary_contact + """ + + if secondary_contact is not None and not isinstance(secondary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: secondary_contact EXPECTED TYPE: str', None, None) + + self.__secondary_contact = secondary_contact + self.__key_modified['secondary_contact'] = 1 + + def get_primary_email(self): + """ + The method to get the primary_email + + Returns: + string: A string representing the primary_email + """ + + return self.__primary_email + + def set_primary_email(self, primary_email): + """ + The method to set the value to primary_email + + Parameters: + primary_email (string) : A string representing the primary_email + """ + + if primary_email is not None and not isinstance(primary_email, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_email EXPECTED TYPE: str', None, None) + + self.__primary_email = primary_email + self.__key_modified['primary_email'] = 1 + + def get_designation(self): + """ + The method to get the designation + + Returns: + string: A string representing the designation + """ + + return self.__designation + + def set_designation(self, designation): + """ + The method to set the value to designation + + Parameters: + designation (string) : A string representing the designation + """ + + if designation is not None and not isinstance(designation, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: designation EXPECTED TYPE: str', None, None) + + self.__designation = designation + self.__key_modified['designation'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + string: A string representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (string) : A string representing the id + """ + + if id is not None and not isinstance(id, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: str', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_interests(self): + """ + The method to get the interests + + Returns: + list: An instance of list + """ + + return self.__interests + + def set_interests(self, interests): + """ + The method to set the value to interests + + Parameters: + interests (list) : An instance of list + """ + + if interests is not None and not isinstance(interests, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: interests EXPECTED TYPE: list', None, None) + + self.__interests = interests + self.__key_modified['interests'] = 1 + + def get_first_name(self): + """ + The method to get the first_name + + Returns: + string: A string representing the first_name + """ + + return self.__first_name + + def set_first_name(self, first_name): + """ + The method to set the value to first_name + + Parameters: + first_name (string) : A string representing the first_name + """ + + if first_name is not None and not isinstance(first_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: first_name EXPECTED TYPE: str', None, None) + + self.__first_name = first_name + self.__key_modified['first_name'] = 1 + + def get_primary_contact(self): + """ + The method to get the primary_contact + + Returns: + string: A string representing the primary_contact + """ + + return self.__primary_contact + + def set_primary_contact(self, primary_contact): + """ + The method to set the value to primary_contact + + Parameters: + primary_contact (string) : A string representing the primary_contact + """ + + if primary_contact is not None and not isinstance(primary_contact, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary_contact EXPECTED TYPE: str', None, None) + + self.__primary_contact = primary_contact + self.__key_modified['primary_contact'] = 1 + + def get_social_media(self): + """ + The method to get the social_media + + Returns: + list: An instance of list + """ + + return self.__social_media + + def set_social_media(self, social_media): + """ + The method to set the value to social_media + + Parameters: + social_media (list) : An instance of list + """ + + if social_media is not None and not isinstance(social_media, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: social_media EXPECTED TYPE: list', None, None) + + self.__social_media = social_media + self.__key_modified['social_media'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/experience.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/experience.py new file mode 100644 index 0000000..7d41c13 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/experience.py @@ -0,0 +1,174 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Experience(object): + def __init__(self): + """Creates an instance of Experience""" + + self.__end_date = None + self.__company_name = None + self.__title = None + self.__start_date = None + self.__primary = None + self.__key_modified = dict() + + def get_end_date(self): + """ + The method to get the end_date + + Returns: + string: A string representing the end_date + """ + + return self.__end_date + + def set_end_date(self, end_date): + """ + The method to set the value to end_date + + Parameters: + end_date (string) : A string representing the end_date + """ + + if end_date is not None and not isinstance(end_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: end_date EXPECTED TYPE: str', None, None) + + self.__end_date = end_date + self.__key_modified['end_date'] = 1 + + def get_company_name(self): + """ + The method to get the company_name + + Returns: + string: A string representing the company_name + """ + + return self.__company_name + + def set_company_name(self, company_name): + """ + The method to set the value to company_name + + Parameters: + company_name (string) : A string representing the company_name + """ + + if company_name is not None and not isinstance(company_name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: company_name EXPECTED TYPE: str', None, None) + + self.__company_name = company_name + self.__key_modified['company_name'] = 1 + + def get_title(self): + """ + The method to get the title + + Returns: + string: A string representing the title + """ + + return self.__title + + def set_title(self, title): + """ + The method to set the value to title + + Parameters: + title (string) : A string representing the title + """ + + if title is not None and not isinstance(title, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: title EXPECTED TYPE: str', None, None) + + self.__title = title + self.__key_modified['title'] = 1 + + def get_start_date(self): + """ + The method to get the start_date + + Returns: + string: A string representing the start_date + """ + + return self.__start_date + + def set_start_date(self, start_date): + """ + The method to set the value to start_date + + Parameters: + start_date (string) : A string representing the start_date + """ + + if start_date is not None and not isinstance(start_date, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: start_date EXPECTED TYPE: str', None, None) + + self.__start_date = start_date + self.__key_modified['start_date'] = 1 + + def get_primary(self): + """ + The method to get the primary + + Returns: + bool: A bool representing the primary + """ + + return self.__primary + + def set_primary(self, primary): + """ + The method to set the value to primary + + Parameters: + primary (bool) : A bool representing the primary + """ + + if primary is not None and not isinstance(primary, bool): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: primary EXPECTED TYPE: bool', None, None) + + self.__primary = primary + self.__key_modified['primary'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/industry.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/industry.py new file mode 100644 index 0000000..b3c742a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/industry.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Industry(object): + def __init__(self): + """Creates an instance of Industry""" + + self.__name = None + self.__description = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_description(self): + """ + The method to get the description + + Returns: + string: A string representing the description + """ + + return self.__description + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/info.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/info.py new file mode 100644 index 0000000..94d9020 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/info.py @@ -0,0 +1,149 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Info(object): + def __init__(self): + """Creates an instance of Info""" + + self.__per_page = None + self.__count = None + self.__page = None + self.__more_records = None + self.__key_modified = dict() + + def get_per_page(self): + """ + The method to get the per_page + + Returns: + int: An int representing the per_page + """ + + return self.__per_page + + def set_per_page(self, per_page): + """ + The method to set the value to per_page + + Parameters: + per_page (int) : An int representing the per_page + """ + + if per_page is not None and not isinstance(per_page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: per_page EXPECTED TYPE: int', None, None) + + self.__per_page = per_page + self.__key_modified['per_page'] = 1 + + def get_count(self): + """ + The method to get the count + + Returns: + int: An int representing the count + """ + + return self.__count + + def set_count(self, count): + """ + The method to set the value to count + + Parameters: + count (int) : An int representing the count + """ + + if count is not None and not isinstance(count, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: count EXPECTED TYPE: int', None, None) + + self.__count = count + self.__key_modified['count'] = 1 + + def get_page(self): + """ + The method to get the page + + Returns: + int: An int representing the page + """ + + return self.__page + + def set_page(self, page): + """ + The method to set the value to page + + Parameters: + page (int) : An int representing the page + """ + + if page is not None and not isinstance(page, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: page EXPECTED TYPE: int', None, None) + + self.__page = page + self.__key_modified['page'] = 1 + + def get_more_records(self): + """ + The method to get the more_records + + Returns: + bool: A bool representing the more_records + """ + + return self.__more_records + + 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 is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_handler.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_handler.py new file mode 100644 index 0000000..02bc304 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_handler.py @@ -0,0 +1,8 @@ +from abc import ABC, abstractmethod + + +class ResponseHandler(ABC): + def __init__(self): + """Creates an instance of ResponseHandler""" + pass + diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_wrapper.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_wrapper.py new file mode 100644 index 0000000..8302985 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/response_wrapper.py @@ -0,0 +1,107 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler +except Exception: + from ..exception import SDKException + from ..util import Constants + from .response_handler import ResponseHandler + + +class ResponseWrapper(ResponseHandler): + def __init__(self): + """Creates an instance of ResponseWrapper""" + super().__init__() + + self.__ziapeopleenrichment = None + self.__info = None + self.__key_modified = dict() + + def get_ziapeopleenrichment(self): + """ + The method to get the ziapeopleenrichment + + Returns: + list: An instance of list + """ + + return self.__ziapeopleenrichment + + def set_ziapeopleenrichment(self, ziapeopleenrichment): + """ + The method to set the value to ziapeopleenrichment + + Parameters: + ziapeopleenrichment (list) : An instance of list + """ + + if ziapeopleenrichment is not None and not isinstance(ziapeopleenrichment, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: ziapeopleenrichment EXPECTED TYPE: list', None, None) + + self.__ziapeopleenrichment = ziapeopleenrichment + self.__key_modified['__zia_people_enrichment'] = 1 + + def get_info(self): + """ + The method to get the info + + Returns: + Info: An instance of Info + """ + + return self.__info + + def set_info(self, info): + """ + The method to set the value to info + + Parameters: + info (Info) : An instance of Info + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.info import Info + except Exception: + from .info import Info + + if info is not None and not isinstance(info, Info): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: info EXPECTED TYPE: Info', None, None) + + self.__info = info + self.__key_modified['info'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social.py new file mode 100644 index 0000000..1b02f22 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social.py @@ -0,0 +1,124 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class Social(object): + def __init__(self): + """Creates an instance of Social""" + + self.__twitter = None + self.__facebook = None + self.__linkedin = None + self.__key_modified = dict() + + def get_twitter(self): + """ + The method to get the twitter + + Returns: + string: A string representing the twitter + """ + + return self.__twitter + + def set_twitter(self, twitter): + """ + The method to set the value to twitter + + Parameters: + twitter (string) : A string representing the twitter + """ + + if twitter is not None and not isinstance(twitter, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: twitter EXPECTED TYPE: str', None, None) + + self.__twitter = twitter + self.__key_modified['twitter'] = 1 + + def get_facebook(self): + """ + The method to get the facebook + + Returns: + string: A string representing the facebook + """ + + return self.__facebook + + def set_facebook(self, facebook): + """ + The method to set the value to facebook + + Parameters: + facebook (string) : A string representing the facebook + """ + + if facebook is not None and not isinstance(facebook, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: facebook EXPECTED TYPE: str', None, None) + + self.__facebook = facebook + self.__key_modified['facebook'] = 1 + + def get_linkedin(self): + """ + The method to get the linkedin + + Returns: + string: A string representing the linkedin + """ + + return self.__linkedin + + def set_linkedin(self, linkedin): + """ + The method to set the value to linkedin + + Parameters: + linkedin (string) : A string representing the linkedin + """ + + if linkedin is not None and not isinstance(linkedin, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: linkedin EXPECTED TYPE: str', None, None) + + self.__linkedin = linkedin + self.__key_modified['linkedin'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social_media.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social_media.py new file mode 100644 index 0000000..75f5791 --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/social_media.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class SocialMedia(object): + def __init__(self): + """Creates an instance of SocialMedia""" + + self.__media_type = None + self.__media_url = None + self.__key_modified = dict() + + def get_media_type(self): + """ + The method to get the media_type + + Returns: + string: A string representing the media_type + """ + + return self.__media_type + + def set_media_type(self, media_type): + """ + The method to set the value to media_type + + Parameters: + media_type (string) : A string representing the media_type + """ + + if media_type is not None and not isinstance(media_type, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_type EXPECTED TYPE: str', None, None) + + self.__media_type = media_type + self.__key_modified['media_type'] = 1 + + def get_media_url(self): + """ + The method to get the media_url + + Returns: + list: An instance of list + """ + + return self.__media_url + + def set_media_url(self, media_url): + """ + The method to set the value to media_url + + Parameters: + media_url (list) : An instance of list + """ + + if media_url is not None and not isinstance(media_url, list): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: media_url EXPECTED TYPE: list', None, None) + + self.__media_url = media_url + self.__key_modified['media_url'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/success_response.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/success_response.py new file mode 100644 index 0000000..011001a --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/success_response.py @@ -0,0 +1,152 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Choice, Constants + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_response import ActionResponse +except Exception: + from ..exception import SDKException + from ..util import Choice, Constants + from .action_response import ActionResponse + + +class SuccessResponse(ActionResponse): + def __init__(self): + """Creates an instance of SuccessResponse""" + super().__init__() + + self.__status = None + self.__code = None + self.__message = None + self.__details = None + self.__key_modified = dict() + + def get_status(self): + """ + The method to get the status + + Returns: + Choice: An instance of Choice + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (Choice) : An instance of Choice + """ + + if status is not None and not isinstance(status, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: Choice', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_code(self): + """ + The method to get the code + + Returns: + Choice: An instance of Choice + """ + + return self.__code + + def set_code(self, code): + """ + The method to set the value to code + + Parameters: + code (Choice) : An instance of Choice + """ + + if code is not None and not isinstance(code, Choice): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: code EXPECTED TYPE: Choice', None, None) + + self.__code = code + self.__key_modified['code'] = 1 + + def get_message(self): + """ + The method to get the message + + Returns: + Choice: An instance of Choice + """ + + return self.__message + + 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 get_details(self): + """ + The method to get the details + + Returns: + dict: An instance of dict + """ + + return self.__details + + def set_details(self, details): + """ + The method to set the value to details + + Parameters: + details (dict) : An instance of dict + """ + + if details is not None and not isinstance(details, dict): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: details EXPECTED TYPE: dict', None, None) + + self.__details = details + self.__key_modified['details'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/user.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/user.py new file mode 100644 index 0000000..fb0384d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/user.py @@ -0,0 +1,99 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class User(object): + def __init__(self): + """Creates an instance of User""" + + self.__name = None + self.__id = None + self.__key_modified = dict() + + def get_name(self): + """ + The method to get the name + + Returns: + string: A string representing the name + """ + + return self.__name + + def set_name(self, name): + """ + The method to set the value to name + + Parameters: + name (string) : A string representing the name + """ + + if name is not None and not isinstance(name, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: name EXPECTED TYPE: str', None, None) + + self.__name = name + self.__key_modified['name'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment.py new file mode 100644 index 0000000..c3e2ccc --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment.py @@ -0,0 +1,214 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import Constants +except Exception: + from ..exception import SDKException + from ..util import Constants + + +class ZiaPeopleEnrichment(object): + def __init__(self): + """Creates an instance of ZiaPeopleEnrichment""" + + self.__created_time = None + self.__id = None + self.__created_by = None + self.__status = None + self.__enriched_data = None + self.__enrich_based_on = None + self.__key_modified = dict() + + def get_created_time(self): + """ + The method to get the created_time + + Returns: + string: A string representing the created_time + """ + + return self.__created_time + + def set_created_time(self, created_time): + """ + The method to set the value to created_time + + Parameters: + created_time (string) : A string representing the created_time + """ + + if created_time is not None and not isinstance(created_time, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_time EXPECTED TYPE: str', None, None) + + self.__created_time = created_time + self.__key_modified['created_time'] = 1 + + def get_id(self): + """ + The method to get the id + + Returns: + int: An int representing the id + """ + + return self.__id + + def set_id(self, id): + """ + The method to set the value to id + + Parameters: + id (int) : An int representing the id + """ + + if id is not None and not isinstance(id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: id EXPECTED TYPE: int', None, None) + + self.__id = id + self.__key_modified['id'] = 1 + + def get_created_by(self): + """ + The method to get the created_by + + Returns: + User: An instance of User + """ + + return self.__created_by + + def set_created_by(self, created_by): + """ + The method to set the value to created_by + + Parameters: + created_by (User) : An instance of User + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.user import User + except Exception: + from .user import User + + if created_by is not None and not isinstance(created_by, User): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: created_by EXPECTED TYPE: User', None, None) + + self.__created_by = created_by + self.__key_modified['created_by'] = 1 + + def get_status(self): + """ + The method to get the status + + Returns: + string: A string representing the status + """ + + return self.__status + + def set_status(self, status): + """ + The method to set the value to status + + Parameters: + status (string) : A string representing the status + """ + + if status is not None and not isinstance(status, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: status EXPECTED TYPE: str', None, None) + + self.__status = status + self.__key_modified['status'] = 1 + + def get_enriched_data(self): + """ + The method to get the enriched_data + + Returns: + EnrichedData: An instance of EnrichedData + """ + + return self.__enriched_data + + def set_enriched_data(self, enriched_data): + """ + The method to set the value to enriched_data + + Parameters: + enriched_data (EnrichedData) : An instance of EnrichedData + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.enriched_data import EnrichedData + except Exception: + from .enriched_data import EnrichedData + + if enriched_data is not None and not isinstance(enriched_data, EnrichedData): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enriched_data EXPECTED TYPE: EnrichedData', None, None) + + self.__enriched_data = enriched_data + self.__key_modified['enriched_data'] = 1 + + def get_enrich_based_on(self): + """ + The method to get the enrich_based_on + + Returns: + EnrichBasedOn: An instance of EnrichBasedOn + """ + + return self.__enrich_based_on + + def set_enrich_based_on(self, enrich_based_on): + """ + The method to set the value to enrich_based_on + + Parameters: + enrich_based_on (EnrichBasedOn) : An instance of EnrichBasedOn + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.enrich_based_on import EnrichBasedOn + except Exception: + from .enrich_based_on import EnrichBasedOn + + if enrich_based_on is not None and not isinstance(enrich_based_on, EnrichBasedOn): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: enrich_based_on EXPECTED TYPE: EnrichBasedOn', None, None) + + self.__enrich_based_on = enrich_based_on + self.__key_modified['enrich_based_on'] = 1 + + def is_key_modified(self, key): + """ + The method to check if the user has modified the given key + + Parameters: + key (string) : A string representing the key + + Returns: + int: An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if key in self.__key_modified: + return self.__key_modified.get(key) + + return None + + def set_key_modified(self, key, modification): + """ + The method to mark the given key as modified + + Parameters: + key (string) : A string representing the key + modification (int) : An int representing the modification + """ + + if key is not None and not isinstance(key, str): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: key EXPECTED TYPE: str', None, None) + + if modification is not None and not isinstance(modification, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: modification EXPECTED TYPE: int', None, None) + + self.__key_modified[key] = modification diff --git a/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment_operations.py b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment_operations.py new file mode 100644 index 0000000..f24a50d --- /dev/null +++ b/zohocrmsdk/src/com/zoho/crm/api/zia_people_enrichment/zia_people_enrichment_operations.py @@ -0,0 +1,140 @@ +try: + from zohocrmsdk.src.com.zoho.crm.api.exception import SDKException + from zohocrmsdk.src.com.zoho.crm.api.util import APIResponse, Choice, CommonAPIHandler, Constants + from zohocrmsdk.src.com.zoho.crm.api.param import Param +except Exception: + from ..exception import SDKException + from ..util import APIResponse, Choice, CommonAPIHandler, Constants + from ..param import Param + + +class ZiaPeopleEnrichmentOperations(object): + def __init__(self): + """Creates an instance of ZiaPeopleEnrichmentOperations""" + pass + + def get_zia_people_enrichments(self, param_instance=None): + """ + The method to get zia people enrichments + + Parameters: + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + 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/v7/__zia_people_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def get_zia_people_enrichment(self, zia_people_enrichment_id): + """ + The method to get zia people enrichment + + Parameters: + zia_people_enrichment_id (int) : An int representing the zia_people_enrichment_id + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + if not isinstance(zia_people_enrichment_id, int): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: zia_people_enrichment_id EXPECTED TYPE: int', None, None) + + handler_instance = CommonAPIHandler() + api_path = '' + api_path = api_path + '/crm/v7/__zia_people_enrichment/' + api_path = api_path + str(zia_people_enrichment_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) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.response_handler import ResponseHandler + except Exception: + from .response_handler import ResponseHandler + return handler_instance.api_call(ResponseHandler.__module__, 'application/json') + + def create_zia_people_enrichment(self, request, param_instance=None): + """ + The method to create zia people enrichment + + Parameters: + request (BodyWrapper) : An instance of BodyWrapper + param_instance (ParameterMap) : An instance of ParameterMap + + Returns: + APIResponse: An instance of APIResponse + + Raises: + SDKException + """ + + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.body_wrapper import BodyWrapper + except Exception: + from .body_wrapper import BodyWrapper + + try: + from zohocrmsdk.src.com.zoho.crm.api import ParameterMap + except Exception: + from ..parameter_map import ParameterMap + + if request is not None and not isinstance(request, BodyWrapper): + raise SDKException(Constants.DATA_TYPE_ERROR, 'KEY: request EXPECTED TYPE: BodyWrapper', None, None) + + 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/v7/__zia_people_enrichment' + 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.set_param(param_instance) + try: + from zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.action_handler import ActionHandler + except Exception: + from .action_handler import ActionHandler + return handler_instance.api_call(ActionHandler.__module__, 'application/json') + + +class GetZiaPeopleEnrichmentsParam(object): + status = Param('status', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + sort_order = Param('sort_order', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + sort_by = Param('sort_by', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + page = Param('page', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + per_page = Param('per_page', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + count = Param('count', 'com.zoho.crm.api.ZiaPeopleEnrichment.GetZiaPeopleEnrichmentsParam') + + +class CreateZiaPeopleEnrichmentParam(object): + module = Param('module', 'com.zoho.crm.api.ZiaPeopleEnrichment.CreateZiaPeopleEnrichmentParam') + record_id = Param('record_id', 'com.zoho.crm.api.ZiaPeopleEnrichment.CreateZiaPeopleEnrichmentParam') diff --git a/zohocrmsdk/src/json_details.json b/zohocrmsdk/src/json_details.json new file mode 100644 index 0000000..1170db6 --- /dev/null +++ b/zohocrmsdk/src/json_details.json @@ -0,0 +1 @@ +{"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Data":{"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Template","request_supported":["action","create","delete","read","update"],"name":"template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Template","unique_for":"none","structure":true},"data_subject_request":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest","request_supported":["action","create","delete","read","update"],"name":"data_subject_request","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest","unique_for":"none","structure":true},"bcc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc"},"request_supported":["action","create","delete","read","update"],"name":"bcc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mail_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["html","text"],"name":"mail_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"scheduled_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduled_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"in_reply_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo","request_supported":["action","create","delete","read","update"],"name":"in_reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo","unique_for":"none","structure":true},"consent_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord","unique_for":"none","structure":true},"org_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"org_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"from_1":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.From","request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.From","unique_for":"none","structure":true},"reply_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To","request_supported":["action","create","delete","read","update"],"name":"reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To","unique_for":"none","structure":true},"inventory_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails","request_supported":["action","create","delete","read","update"],"name":"inventory_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails","unique_for":"none","structure":true},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.To"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail":{"result":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result","request_supported":["action","create","delete","read","update"],"name":"result","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["csv"],"name":"file_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"query":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","request_supported":["action","create","delete","read","update"],"name":"query","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","IN PROGRESS","ADDED","FAILURE"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"operation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["cvid","id","Owner"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found","the cvid given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseWrapper":{"associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.GetDeletedRecordsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseWrapper":{"currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency"},"request_supported":["action","create","delete","read","update"],"name":"currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.coql.ClauseDetails":{"clause":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clause","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.GetAppointmentRescheduledHistoryParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException","zohocrmsdk.src.com.zoho.crm.api.custom_views.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.roles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseWrapper":{"shift_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount","request_supported":["action","create","delete","read","update"],"name":"shift_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount","unique_for":"none","structure":true},"shift_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours"},"request_supported":["action","create","delete","read","update"],"name":"shift_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineWrapper":{"transfer_pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline"},"request_supported":["action","create","delete","read","update"],"name":"transfer_pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portals.ResponseWrapper":{"portals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals"},"request_supported":["action","create","delete","read","update"],"name":"portals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Tax":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask":{"open_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"open_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"failed_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"completed_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"completed_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"created_tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"tasks_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tasks_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status":{"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"not_converted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Not_Converted_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"converted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Converted_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseWrapper":{"transfer_and_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionWrapper":{"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseWrapper":{"emails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email"},"request_supported":["action","create","delete","read","update"],"name":"Emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.GetAssociatedContactRolesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields"},"request_supported":["action","create","delete","read","update"],"name":"show_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"revalidate_filter_during_edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"revalidate_filter_during_edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"query_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","request_supported":["action","create","delete","read","update"],"name":"query_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CreateDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.BodyWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"defaultview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","request_supported":["action","create","delete","read","update"],"name":"_default_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.territory_users.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.RecordCountParam":{"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"word":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"word","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionWrapper":{"emaildrafts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__email_drafts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.ActionWrapper":{"backup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"backup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.backup.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordsUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.BodyWrapper":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.Record":{"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","RECORD_NOT_IN_PROCESS","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"info_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","invalid transition","invalid data","record not in process"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionWrapper":{"get_unassigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionResponse","request_supported":["action","create","delete","read","update"],"name":"get_unassigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Shift":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result":{"download_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"download_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionWrapper":{"appointment_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"appointment_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["active","inactive","deleted"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Fields":{"associated_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"associated_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"operation_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","request_supported":["action","create","delete","read","update"],"name":"operation_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","unique_for":"none","structure":true},"updateexistingrecords":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_update_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"colour_code_enabled_by_system":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code_enabled_by_system","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","unique_for":"none","structure":true},"textarea":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","request_supported":["action","create","delete","read","update"],"name":"textarea","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customizable_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"customizable_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","unique_for":"none","structure":true},"businesscard_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"businesscard_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"sharing_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","request_supported":["action","create","delete","read","update"],"name":"sharing_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"refer_from_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","request_supported":["action","create","delete","read","update"],"name":"refer_from_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","unique_for":"none","structure":true},"subform":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","request_supported":["action","create","delete","read","update"],"name":"subform","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","unique_for":"none","structure":true},"separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"searchable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"searchable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"virtual_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"virtual_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"auto_number_61":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"allowed_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"allowed_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_upolad_optionlist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption"},"request_supported":["action","create","delete","read","update"],"name":"file_upolad_optionlist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email_parser":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","request_supported":["action","create","delete","read","update"],"name":"email_parser","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","unique_for":"none","structure":true},"multiuserlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiuserlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","unique_for":"none","structure":true},"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","unique_for":"none","structure":true},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","unique_for":"none","structure":true},"rollup_summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","request_supported":["action","create","delete","read","update"],"name":"rollup_summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","unique_for":"none","structure":true},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"global_picklist":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"autonumber":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"autonumber","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","unique_for":"none","structure":true},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","unique_for":"none","structure":true},"additional_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"additional_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"static_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"static_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"mass_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mass_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"blueprint_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"blueprint_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.RemindAt":{"alarm":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ALARM","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_DATA","INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["tags created successfully","tags updated successfully","tags deleted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.UpdatePipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.RecordSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details":{"template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template","request_supported":["action","create","delete","read","update"],"name":"template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroupsWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.Backup":{"requester":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","request_supported":["action","create","delete","read","update"],"name":"requester","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","unique_for":"none","structure":true},"rrule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rrule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"scheduled_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduled_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"start_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["equal","not_equal","in","not_in","less_than","less_equal","greater_than","greater_equal","contains","not_contains","starts_with","ends_with","between","not_between"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["and","or"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territory_users.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.associate_email.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.GetAssignmentRulesParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DeleteRelatedRecordsUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INTERNAL_SERVER_ERROR","UNABLE_TO_PARSE_DATA_TYPE","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","either the request body or parameters is in wrong format","One of the expected parameter is missing"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social":{"twitter":{"regex":"https[:][/][/]twitter[.]com[/][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"twitter","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"facebook":{"regex":"https[:][/][/]facebook[.]com[/][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"facebook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linkedin":{"regex":"https[:][/][/]linkedin[.]com[/][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"linkedin","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.DeleteNotificationParam":{"channel_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_hour":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","request_supported":["action","create","delete","read","update"],"name":"shift_hour","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.BodyWrapper":{"body":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"body","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.ResponseWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress":{"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NOT_APPROVED","LIMIT_EXCEEDED","REQUIRED_PARAM_MISSING","ID_ALREADY_CONVERTED","EXPECTED_FIELD_MISSING","NOT_REVIEWED","AMBIGUITY_DURING_PROCESSING","MANDATORY_NOT_FOUND","NO_PERMISSION"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[50],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","id already converted","required field not found","Specify atleast one field"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DeleteDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"report_link","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.Dependee":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","NO_PERMISSION","INVALID_URL_PATTERN","REQUIRED_PARAM_MISSING","INVALID_TOKEN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the user doesn't have permission for that module.","Please check if the URL trying to access is a correct one.","One of the expected parameter is missing.","the module name given seems to be invalid."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionWrapper":{"service_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"service_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.GetMapDependenciesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"module":{"name":"module","type":"String","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","unique_for":"none","structure":true},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties":{"scheduler_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduler_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"share_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["full-access","read-write","read-only"],"name":"share_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"share_preference_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_preference_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseWrapper":{"share":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord"},"request_supported":["action","create","delete","read","update"],"name":"share","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"shareable_user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"shareable_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["FILE_UPLOAD_SUCCESS","SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["file uploaded.","success"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status":{"updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"not_updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Not_Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","RUNNING","FAILED"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.backup.HISTORYParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ALREADY_ENABLED","INTERNAL_SERVER_ERROR","INVALID_DATA","OAUTH_SCOPE_MISMATCH","FEATURE_NOT_ENABLED","NOT_ALLOWED","ACTIVE_STATE_LIMIT_EXCEEDED","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","DUPLICATE_DATA","LIMIT_EXCEEDED","MANDATORY_NOT_FOUND","CURRENCIES_NOT_ENABLED","FEATURE_NOT_SUPPORTED","No Content","BAD_REQUEST","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"related_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one.","The http request method type is not a valid one","The module name given seems to be invalid","The multi-currency is already enabled","Currency name is invalid.","ISO code is invalid.","Currency symbol is invalid.","The multi-currency feature is not available except the Enterprise and higher editions.","required field not found","unable to process your request. please verify whether you have entered proper method name"," parameter and parameter values.","Currency symbol is invalid.","Multi currency is not enabled","No Content","Currency id is invalid."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.BodyWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.GetShiftHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.UpdateRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.contact_roles.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNoteParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.backup.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.UrlsWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.HistoryWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.modules.Modules":{"global_search_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_search_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"activity_badge":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Enabled","Disabled"],"name":"activity_badge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"zia_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zia_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layouts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"recycle_bin_on_delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"recycle_bin_on_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"email_parser_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_parser_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"business_card_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"business_card_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"inventory_template_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"inventory_template_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"track_current_data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"track_current_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"presence_sub_menu":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"presence_sub_menu","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"chart_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"chart_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"triggers_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"triggers_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sub_menu_available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sub_menu_available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"visibility":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visibility","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"static_subform_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties","request_supported":["action","create","delete","read","update"],"name":"static_subform_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"filter_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filter_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"kanban_view_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"kanban_view_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"web_link":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"web_link","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"lookup_field_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties","request_supported":["action","create","delete","read","update"],"name":"lookup_field_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties","unique_for":"none","structure":true},"viewable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"viewable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"emailtemplate_support":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"emailTemplate_support","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"chart_view_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"chart_view_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"parent_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"parent_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"custom_view":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","request_supported":["action","create","delete","read","update"],"name":"custom_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"has_more_profiles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_more_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"kanban_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"kanban_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_states":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$field_states","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"related_lists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList"},"request_supported":["action","create","delete","read","update"],"name":"related_lists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"deletable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deletable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":255},"creatable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"creatable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"filter_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filter_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"related_list_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties","request_supported":["action","create","delete","read","update"],"name":"related_list_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties","unique_for":"none","structure":true},"isblueprintsupported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isBlueprintSupported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"default_mapping_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField"},"request_supported":["action","create","delete","read","update"],"name":"default_mapping_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"convertable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"convertable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_as_tab":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_as_tab","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"search_layout_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"search_layout_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"singular_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"singular_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"quick_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"on_demand_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$on_demand_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"generated_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["default","web","custom","linking"],"name":"generated_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"feeds_required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feeds_required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"scoring_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scoring_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"webform_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webform_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"arguments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Argument","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Argument"},"request_supported":["action","create","delete","read","update"],"name":"arguments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"profile_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"profile_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"business_card_field_limit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"business_card_field_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reference_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reference_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.MassWrapper":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notes.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Section":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"categories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Category","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Category"},"request_supported":["action","create","delete","read","update"],"name":"categories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming":{"break_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"LocalTime"},"request_supported":["action","create","delete","read","update"],"name":"break_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.DeassociateTerritoryUsersParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Formula":{"return_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expression":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expression","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionWrapper":{"custom_views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"custom_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.GetEmailsRelatedRecordsParam":{"filter":{"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria","name":"filter","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria","structure":true},"owner_id":{"name":"owner_id","type":"Long","structure":false},"index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"name":"type","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData":{"crm_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","request_supported":["action","create","delete","read","update"],"name":"crm_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","unique_for":"none","structure":true},"enrich_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","request_supported":["action","create","delete","read","update"],"name":"enrich_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionWrapper":{"send_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"send_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException","zohocrmsdk.src.com.zoho.crm.api.global_picklists.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.FileHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.profiles.DeleteProfileParam":{"transfer_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_to","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS","SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink":{"transfer_to_user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser","request_supported":["action","create","delete","read","update"],"name":"transfer_to_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionWrapper":{"share":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"share","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeleteTerritoryParam":{"delete_previous_forecasts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_previous_forecasts","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.DeleteFieldParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"deleted_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"deleted_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"deleted_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionWrapper":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ResponseWrapper":{"record_locking_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock"},"request_supported":["action","create","delete","read","update"],"name":"record_locking_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference":{"allow_booking_outside_businesshours":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allow_booking_outside_businesshours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"deal_record_configuration":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration","request_supported":["action","create","delete","read","update"],"name":"deal_record_configuration","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration","unique_for":"none","structure":true},"show_job_sheet":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_job_sheet","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"when_duration_exceeds":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"when_duration_exceeds","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"when_appointment_completed":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["do_not_create_deal","create_deal"],"name":"when_appointment_completed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"allow_booking_outside_service_availability":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allow_booking_outside_service_availability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.GetEntityScoresParam":{"cvid":{"name":"cvid","type":"String","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"name":"fields","type":"String","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeleteTerritoriesParam":{"delete_previous_forecasts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_previous_forecasts","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseWrapper":{"variable_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup"},"request_supported":["action","create","delete","read","update"],"name":"variable_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.Territory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.CreateRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseWrapper":{"service_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","request_supported":["action","create","delete","read","update"],"name":"service_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.Summary":{"task_follow_up_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"task_follow_up_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"call_follow_up_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call_follow_up_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"email_follow_up_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_follow_up_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser":{"user_group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup","request_supported":["action","create","delete","read","update"],"name":"user_group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup","unique_for":"none","structure":true},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue","request_supported":["action","create","delete","read","update"],"name":"_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData":{"iframe_url_tracking_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iframe_url_tracking_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"url_analytics_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"url_analytics_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"analytics_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"analytics_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"analytics_enabled_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"analytics_enabled_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"tracking_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tracking_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseWrapper":{"blueprint":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","request_supported":["action","create","delete","read","update"],"name":"blueprint","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.templates.Folder":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Template":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["profile created successfully","profile updated successfully","Profile deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Users":{"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name_format__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Salutation,First Name,Last Name","Saluation,Last Name,First Name","First Name,Last Name,Saluation"],"name":"name_format__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"language":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"language","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Reporting_To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_time_9":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"microsoft":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"microsoft","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sandboxdeveloper":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sandboxDeveloper","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"isonline":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Isonline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"fax":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fax","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"country_locale":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country_locale","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"imap_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"imap_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"zip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"decimal_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Comma","Period"],"name":"decimal_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"created_by_17":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"current_shift":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","request_supported":["action","create","delete","read","update"],"name":"$current_shift","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","unique_for":"none","structure":true},"time_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["HH:mm","hh:mm a"],"name":"time_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"image_link":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"image_link","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"offset":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"offset","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_shift":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","request_supported":["action","create","delete","read","update"],"name":"$next_shift","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Shift","unique_for":"none","structure":true},"profile":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Profile","request_supported":["action","create","delete","read","update"],"name":"profile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Profile","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ezuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ezuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"full_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"full_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"dob":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"dob","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order_preference__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order_preference__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"role":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Role","request_supported":["action","create","delete","read","update"],"name":"role","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Role","unique_for":"none","structure":true},"customize_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo","request_supported":["action","create","delete","read","update"],"name":"customize_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo","unique_for":"none","structure":true},"city":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"city","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"signature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order_preference":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_effective_from":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$shift_effective_from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"locale":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locale","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"personal_account":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personal_account","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"ntc_notification_type":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ntc_notification_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"default_tab_group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_tab_group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"street":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"street","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"alias":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"alias","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"currency":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"theme":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Theme","request_supported":["action","create","delete","read","update"],"name":"theme","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Theme","unique_for":"none","structure":true},"first_name":{"regex":"[A-Za-z0-9]","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":50},"email":{"regex":"[a-z0-9]{9}[@][a-z0-9]{5}[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"telephony_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"telephony_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"status_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status_reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"website":{"regex":"[a-z0-9]{5}[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mobile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mobile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_name":{"regex":"[A-Za-z0-9]","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":50},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Space"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"time_zone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time_zone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TTimeZone","nullable_for":"none","type":"TimeZone","unique_for":"none","structure":false},"confirm":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"confirm","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"rtl_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rtl_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"date_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MMM d, yyyy"],"name":"date_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ntc_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ntc_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.features.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.features.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"presence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"presence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"actual_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails":{"query_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"query_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"quick_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ChangeSortOrderOfCustomViewParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.business_hours.UpdateBusinessHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_REQUEST","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ResponseWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","NOT_ALLOWED","DUPLICATE_DATA","LIMIT_EXCEEDED","DEPENDENT_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ApinameJsonPathDetail","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency":{"symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"is_active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"exchange_rate":{"regex":"[1-9][0-9]{1,8}[.][0-9]{9}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exchange_rate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"format":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","request_supported":["action","create","delete","read","update"],"name":"format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"prefix_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"is_base":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_base","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData"},"request_supported":["action","create","delete","read","update"],"name":"_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails":{"related_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"related_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"lookup_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"lookup_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules":{"query_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"query_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","unique_for":"none","structure":true},"actions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Actions","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Actions"},"request_supported":["action","create","delete","read","update"],"name":"actions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"execute_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["create","edit","create_edit"],"name":"execute_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"contact_role":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole","request_supported":["action","create","delete","read","update"],"name":"Contact_Role","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_write.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify":{"send_cancelling_mail":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"send_cancelling_mail","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCountWrapper":{"grouped_counts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount"},"request_supported":["action","create","delete","read","update"],"name":"grouped_counts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetDeletedParentRecordsRelatedRecordParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.webforms.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.BodyWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.CreateTagsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.GetHolidayHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"permissions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions","request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters"},"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","request_supported":["action","create","delete","read","update"],"name":"views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.GetFieldAttachmentsParam":{"fields_attachment_id":{"name":"fields_attachment_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cadences_execution.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field","unique_for":"none","structure":true},"matched_lead_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"matched_lead_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails":{"paid_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paid_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"users_license_purchased":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"users_license_purchased","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"trial_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trial_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"trial_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trial_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"paid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"paid_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paid_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"trial_action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trial_action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.UpdateRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordUsingExternalIDHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseWrapper":{"timeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline"},"request_supported":["action","create","delete","read","update"],"name":"__timeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.BodyWrapper":{"blueprint":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint"},"request_supported":["action","create","delete","read","update"],"name":"blueprint","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unblock_email.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer":{"records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assignment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"assignment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock":{"locked_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked_reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"record_locking_rule_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_locking_rule_id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"lock_source__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Manual","Automatic"],"name":"lock_source__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"locked_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Locked_time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"record_locking_configuration_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_locking_configuration_id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"locked_for_s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS","request_supported":["action","create","delete","read","update"],"name":"locked_for_s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"locked_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"locked_by__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.GetMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.GetHolidaysHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.DeleteVariablesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_URL_PATTERN","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","LIMIT_EXCEEDED","EXPECTED_FIELD_MISSING","DUPLICATE_DATA","ALREADY_SCHEDULED","INVALID_MODULE","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","the module name given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.CountResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.service_preference.BodyWrapper":{"service_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","request_supported":["action","create","delete","read","update"],"name":"service_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData":{"enrich_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField","request_supported":["action","create","delete","read","update"],"name":"enrich_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField","unique_for":"none","structure":true},"crm_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField"},"request_supported":["action","create","delete","read","update"],"name":"crm_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMergeWrapper":{"download_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge"},"request_supported":["action","create","delete","read","update"],"name":"download_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.PriceBook":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.definition.ResponseWrapper":{"definition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.Definition","request_supported":["action","create","delete","read","update"],"name":"definition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.definition.Definition","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.APIException","zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge":{"bcc_email":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address"},"request_supported":["action","create","delete","read","update"],"name":"bcc_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_merge_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","request_supported":["action","create","delete","read","update"],"name":"mail_merge_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","unique_for":"none","structure":true},"cc_email":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address"},"request_supported":["action","create","delete","read","update"],"name":"cc_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"attachment_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"attachment_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address"},"request_supported":["action","create","delete","read","update"],"name":"to_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"from_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","request_supported":["action","create","delete","read","update"],"name":"from_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionWrapper":{"contact_roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"contact_roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource","request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource","unique_for":"none","structure":true},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.ParseErrorDetails":{"line":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"line","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"near":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"near","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseWrapper":{"users_unavailability":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability"},"request_supported":["action","create","delete","read","update"],"name":"users_unavailability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.Currency":{"rounding_option":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["normal","round_off","round_up","round_down"],"name":"rounding_option","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"precision":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"precision","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula":{"return_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expression":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expression","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.GetPipelinesParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"master_record_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields"},"request_supported":["action","create","delete","read","update"],"name":"master_record_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.To":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Field":{"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt","unique_for":"none","structure":true},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout","request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout","unique_for":"none","structure":true},"mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[-1,2],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"validation_rule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"validation_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Module","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Module","unique_for":"none","structure":true},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType","unique_for":"none","structure":true},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"personality_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"transition_sequence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transition_sequence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula","unique_for":"none","structure":true},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"auto_number":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete":{"permanent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permanent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.GetTagsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"my_tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"my_tags","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseWrapper":{"custom_views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews"},"request_supported":["action","create","delete","read","update"],"name":"custom_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.GetRelatedListsParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.DeletePipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.BodyWrapper":{"transfer_and_delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete"},"name":"transfer_and_delete","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.profiles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["LICENSE_LIMIT_EXCEEDED","INVALID_DATA","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INTERNAL_ERROR","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[25],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["name","Description","permissions_details","profiles"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["jsonobject","text","jsonarray"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[50,250,1],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["permissions_details"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Request exceeds your license limit.","The action given is invalid","invalid data","required field not found","the id given seems to be invalid or already deleted","duplicate data","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","Internal server error occurred."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard":{"exempted_portal_user_types":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType"},"request_supported":["action","create","delete","read","update"],"name":"exempted_portal_user_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"portal_user_types":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType"},"request_supported":["action","create","delete","read","update"],"name":"portal_user_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"parent_wizard":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","request_supported":["action","create","delete","read","update"],"name":"parent_wizard","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"draft":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"draft","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"containers":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Container","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Container"},"request_supported":["action","create","delete","read","update"],"name":"containers","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.files.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.modules.Argument":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory":{"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["DUPLICATE_DATA","NOT_ALLOWED","REQUIRED_PARAM_MISSING","INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_DATA","EXPECTED_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces"},"request_supported":["action","create","delete","read","update"],"name":"associated_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NOT_ALLOWED","RESOURCE_NOT_FOUND","NO_PERMISSION","FEATURE_NOT_ENABLED","LIMIT_EXCEEDED","API_NOT_SUPPORTED","REQUIRED_PARAM_MISSING","INVALID_MODULE","EXPECTED_FIELD_MISSING","DEPENDENT_FIELD_MISSING","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permissions_needed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"supported_version","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.DETAIL1","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The requested resource doesn`t exist."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.Widget":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.BodyWrapper":{"backup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","request_supported":["action","create","delete","read","update"],"name":"backup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"minimum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.Info":{"call":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia":{"media_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"media_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"media_url":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"media_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Private":{"restricted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ResponseWrapper":{"emaildrafts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts"},"request_supported":["action","create","delete","read","update"],"name":"__email_drafts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationWrapper":{"validate_before_transfer":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationGroup","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationGroup"},"request_supported":["action","create","delete","read","update"],"name":"validate_before_transfer","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"owner_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.BodyWrapper":{"unsubscribe_links":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks"},"request_supported":["action","create","delete","read","update"],"name":"unsubscribe_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notes.DeleteNotesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseWrapper":{"audit_log_export":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport"},"request_supported":["action","create","delete","read","update"],"name":"audit_log_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipelineWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_API_NAME","NOT_SUPPORTED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory":{"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.apis.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.share_records.BodyWrapper":{"notify_on_completion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_on_completion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"share":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord"},"name":"share","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":10},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionWrapper":{"transfer_pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordsParam":{"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings":{"mapped_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField","request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField","unique_for":"none","structure":true},"current_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField","request_supported":["action","create","delete","read","update"],"name":"current_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Connection":{"source_button":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button","request_supported":["action","create","delete","read","update"],"name":"source_button","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button","unique_for":"none","structure":true},"target_screen":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","request_supported":["action","create","delete","read","update"],"name":"target_screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.BodyWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount":{"total_shift_with_user":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_shift_with_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_shift":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_shift","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.GetAssignmentRuleParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount":{"territories":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"roles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"groups":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Users","request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Users","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.Note","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notes.Note"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_MODULE","LIMIT_EXCEEDED","RECORD_LOCKED","REQUIRED_PARAM_MISSING","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found","Invalid data"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.UpsertRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.GetPipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.BulkValidation":{"alert":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"alert","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assignment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"assignment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionWrapper":{"org_taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"org_taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.CreateMapDependencyHeader":{},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","ID_ALREADY_CONVERTED","MAPPING_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","required field not found","id already converted","Pipeline doesn`t contain the Stage"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SERVICE_NOT_FOUND","CONNECTION_TIMEOUT","AUTHORIZATION_FAILED","NO_PERMISSION","INVALID_DATA","MANDATORY_NOT_FOUND","NO_PERMISSION","FEATURE_NOT_AVAILABLE","UNCONFIRMED_EMAIL","PATTERN_NOT_MATCHED","INVALID_DATA","FUNCTION_NOT_CREATED","FUNCTION_NOT_UPDATED","FUNCTION_NOT_DELETED","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["service unavailable. please try after sometime","unable to connect. please try after sometime","unable to authorize your request.","no permission to perform an action on this record","your edition doesn't support this feature","please confirm your email","failed to update function","unable to delete a configured function.","permission denied","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseWrapper":{"ziaorgenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"__zia_org_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PATTERN_NOT_MATCHED","MANDATORY_NOT_FOUND","INVALID_DATA","UNABLE_TO_PARSE_DATA_TYPE","INVALID_MODULE","INVALID_URL_PATTERN","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["include_inner_details"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Please check whether the input values are correct","required field not found","either the request body or parameters is in wrong format","Ids should be Long value with comma separated","Please check if the URL trying to access is a correct one"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetSourcesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"user_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap":{"input_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData"},"request_supported":["action","create","delete","read","update"],"name":"input_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"output_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData"},"request_supported":["action","create","delete","read","update"],"name":"output_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.LookupField":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo":{"notes_desc":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notes_desc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"show_right_panel":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_right_panel","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"bc_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bc_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"show_home":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_home","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_detail_view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_detail_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unpin_recent_item":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unpin_recent_item","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NOT_SUPPORTED","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.from_addresses.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo":{"field_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"escalation":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation","request_supported":["action","create","delete","read","update"],"name":"escalation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation","unique_for":"none","structure":true},"is_continuous":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_continuous","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"continuous":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"continuous","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"current_picklist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist","request_supported":["action","create","delete","read","update"],"name":"current_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail":{"pathfinder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder","request_supported":["action","create","delete","read","update"],"name":"pathfinder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder","unique_for":"none","structure":true},"rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","request_supported":["action","create","delete","read","update"],"name":"rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.ResponseWrapper":{"allowed_field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap","request_supported":["action","create","delete","read","update"],"name":"allowed_field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutsHeader":{},"zohocrmsdk.src.com.zoho.crm.api.definition.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_DATA"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["resource"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["resource"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["One of the expected parameter is missing","invalid param"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CreateZiaPeopleEnrichmentParam":{"record_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.BodyWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors":{"template_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"template_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"template_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"template_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"from_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress","request_supported":["action","create","delete","read","update"],"name":"from_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.RemoveTagsFromMultipleRecordsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Tab":{"font_color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#FFFFFF"],"name":"font_color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"background":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#222222"],"name":"background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","record not deleted","the module name given seems to be invalid","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseWrapper":{"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours":{"business_days":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice"},"request_supported":["action","create","delete","read","update"],"name":"business_days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"custom_timing":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming"},"request_supported":["action","create","delete","read","update"],"name":"custom_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"daily_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"daily_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":2},"week_starts_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"name":"week_starts_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"same_as_everyday":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"same_as_everyday","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["24_by_7","24_by_5","custom"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationGroup":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.Validation","zohocrmsdk.src.com.zoho.crm.api.users_territories.BulkValidation"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinUnpinFields":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.GetOrganizationHeader":{},"zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["FILTER_CRITERIA_NOT_SATISFIED","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_MODULE","LIMIT_EXCEEDED","DEPENDENT_FIELD_MISSING","INVALID_DATA","NOT_ALLOWED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MandatoryDetails","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MandatoryDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"minimum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_URL_PATTERN","INVALID_MODULE","NOT_SUPPORTED","INVALID_DATA","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.BulkWriteResponse":{"result":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result","request_supported":["action","create","delete","read","update"],"name":"result","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"character_encoding":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"character_encoding","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"callback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","request_supported":["action","create","delete","read","update"],"name":"callback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"operation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs":{"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages":{"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionWrapper":{"ziapeopleenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__zia_people_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["contact role added","contact role updated","contact role deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.definition.Definition":{"root_element_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"root_element_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"extradetails":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"extraDetails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.Property","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.definition.Property"},"request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionWrapper":{"base_currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionResponse","request_supported":["action","create","delete","read","update"],"name":"base_currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseWrapper":{"available_currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency"},"request_supported":["action","create","delete","read","update"],"name":"available_currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.GetNotificationsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"channel_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.GetWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNotesHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.GetFeatureDetailsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_names":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_names","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linking_module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"linking_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"lookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedlookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedlookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue":{"new":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"new","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"old":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"old","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.Sections":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"issubformsection":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isSubformSection","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tab_traversal":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tab_traversal","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"generated_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"generated_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Properties","request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Properties","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapySuccess","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.roles.Role":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"forecast_manager":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","request_supported":["action","create","delete","read","update"],"name":"forecast_manager","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","unique_for":"none","structure":true},"share_with_peers":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_with_peers","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","request_supported":["action","create","delete","read","update"],"name":"reporting_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"admin_user":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"admin_user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.Available":{"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","unique_for":"none","structure":true},"record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Record","request_supported":["action","create","delete","read","update"],"name":"record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Record","unique_for":"none","structure":true},"available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification":{"notify_on_related_action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_on_related_action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"deleteevents":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"_delete_events","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"resource_uri":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_uri","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notify_url":{"regex":"www[.][a-z]{5}zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notification_condition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition"},"request_supported":["action","create","delete","read","update"],"name":"notification_condition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"return_affected_field_values":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_affected_field_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"channel_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"resource_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"resource_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"channel_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"events":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"events","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields":{"hidden":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hidden","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"site_key":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"site_key","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"advanced":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"advanced","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","unique_for":"none","structure":true},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","unique_for":"none","structure":true},"help":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"help","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secret_key":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secret_key","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"recaptcha_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"recaptcha_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"theme":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"theme","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"date_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.GetCustomViewParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.Subform":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.DeleteScoringRulesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portals.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.CreateHolidaysHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.BodyWrapper":{"variables":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable"},"request_supported":["action","create","delete","read","update"],"name":"variables","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionWrapper":{"audit_log_export":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"audit_log_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","InvalidModule","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","NOT_ALLOWED","NO_PERMISSION","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"info_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","api_name cannot be changed","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","invalid transition","invalid data","record not in process"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.wizards.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectPicklist":{"fieldname":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fieldName","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["BACKUP_ALREADY_SCHEDULED","REQUEST_BODY_NOT_READABLE","INVALID_DATA","ALREADY_CANCELLED","RESOURCE_NOT_FOUND","INPROGRESS","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address":{"continent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"continent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"region":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"region","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Component":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","unique_for":"none","structure":true},"feature_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation":{"resources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordsHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","EXPECTED_FIELD_MISSING","INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","AMBIGUITY_DURING_PROCESSING","LIMIT_EXCEEDED","NOT_SUPPORTED","INVALID_MODULE","RECORD_LOCKED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Invalid data","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"submission_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"submission_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["custom","standard"],"name":"page_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"location_url_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"location_url_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"custom_location_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_location_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action_on_unsubscribe":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action_on_unsubscribe","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","unique_for":"none","structure":true},"landing_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"landing_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"submission_redirect_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"submission_redirect_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"standard_page_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"standard_page_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"submission_action_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["display_message","redirect"],"name":"submission_action_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionWrapper":{"ziaorgenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__zia_org_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition":{"field_selection":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","request_supported":["action","create","delete","read","update"],"name":"field_selection","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Module","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.isc_signature.Signature":{"isc_signature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isc_signature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign":{"related_entity_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"related_entity_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"feature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["user_groups"],"name":"feature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"userMessage","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"output_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"output","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["function executed successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionWrapper":{"get_assigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionResponse","request_supported":["action","create","delete","read","update"],"name":"get_assigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ActionWrapper":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notifications.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NOT_SUBSCRIBED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetMassUpdateStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.GetUserTypesParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyWrapper":{"base_currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency","request_supported":["action","create","delete","read","update"],"name":"base_currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.BodyWrapper":{"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"allowed_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Please give a valid month","Please give a valid value","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.BodyWrapper":{"portals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals.Portals"},"request_supported":["action","create","delete","read","update"],"name":"portals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["converted_records","mapped_module_records"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration"},"request_supported":["action","create","delete","read","update"],"name":"type_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.features.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.BodyWrapper":{"select_query":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"select_query","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties":{"sort_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionWrapper":{"share":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionResponse","request_supported":["action","create","delete","read","update"],"name":"share","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_FORM_ID","EXPECTED_FIELD_MISSING","REQUIRED_PARAM_MISSING","INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Details","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Details"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics":{"tracked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tracked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"delivered":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delivered","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"opened":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"opened","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"bounced":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"clicked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clicked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration":{"field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings"},"request_supported":["action","create","delete","read","update"],"name":"field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mapped_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule","request_supported":["action","create","delete","read","update"],"name":"mapped_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["layout updated","layout deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Event","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Event"},"request_supported":["action","create","delete","read","update"],"name":"events","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_uri","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Successfully subscribed for actions-watch of the given module","Successfully un-subscribed from actions-watch","Successfully updated the subscribe details","Successfully removed the subscribe details"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.GetWizardByIDParam":{"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrappe","zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"se_module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$se_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sharing_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$sharing_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"attachment_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$attachment_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"parent_id":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId","request_supported":["action","create","delete","read","update"],"name":"Parent_Id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId","unique_for":"none","structure":true},"file_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"link_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$link_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrapper":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseWrapper":{"related_lists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList"},"request_supported":["action","create","delete","read","update"],"name":"related_lists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.Feature":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_lists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetDeletedRecordsHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.blueprint.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reference_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reference_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"conditional_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules"},"request_supported":["action","create","delete","read","update"],"name":"conditional_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"segments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment"},"request_supported":["action","create","delete","read","update"],"name":"segments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.BodyWrapper":{"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile":{"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"defaultview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView","request_supported":["action","create","delete","read","update"],"name":"_default_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView","unique_for":"none","structure":true},"custom":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["normal_profile","lite_profile"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"sections":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Section","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Section"},"request_supported":["action","create","delete","read","update"],"name":"sections","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"permissions_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail"},"request_supported":["action","create","delete","read","update"],"name":"permissions_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseWrapper":{"org_taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","request_supported":["action","create","delete","read","update"],"name":"org_taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status":{"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"deleted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Deleted_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","RUNNING","FAILED"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseWrapper":{"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.digest.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"digest_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Digest has been successfully generated"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData"},"request_supported":["action","create","delete","read","update"],"name":"_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles":{"defaultassignmentview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView","request_supported":["action","create","delete","read","update"],"name":"_default_assignment_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView","unique_for":"none","structure":true},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"defaultview":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView","request_supported":["action","create","delete","read","update"],"name":"_default_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordUsingExternalIDParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.modules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The fiscal year configuration has been updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.GetRecordLockingInformationsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action":{"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.DeleteMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming":{"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"business_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"business_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.Cadences":{"summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.Summary","request_supported":["action","create","delete","read","update"],"name":"summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.Summary","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.Module","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"execution_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail","request_supported":["action","create","delete","read","update"],"name":"execution_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail","unique_for":"none","structure":true},"published":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"published","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.User","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"custom_view":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView","request_supported":["action","create","delete","read","update"],"name":"custom_view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge":{"password":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"password","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mail_merge_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","request_supported":["action","create","delete","read","update"],"name":"mail_merge_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","unique_for":"none","structure":true},"output_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["pdf","docx","html"],"name":"output_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":255}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.BodyWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.Territories"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.send_mail.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PAGE_RANGE_EXCEEDED","VALUE_TYPE_NOT_SUPPORTED","MODULE_NOT_SUPPORTED","REQUEST_BODY_NOT_SUPPORTED","FIELD_IN_CRITERIA_NOT_SUPPORTED","FIELD_COMPARATOR_IN_CRITERIA_NOT_SUPPORTED","RESOURCE_NOT_FOUND","INVALID_CALLBACK_METHOD","INVALID_CALLBACK_URL","GROUP_OPERATOR_NOT_SUPPORTED","AMBIGUOUS_CRITERIA","AMBIGUOUS_GROUP_IN_CRITERIA","INVALID_CRITERIA","CVID_NOT_SUPPORTED","INVALID_REQUEST","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_SERVICE_NAME","INVALID_BULK_OPERATION","MEDIA_TYPE_NOT_SUPPORTED","REQUEST_BODY_NOT_READABLE","REQUEST_BODY_IS_EMPTY","MODULE_NOT_AVAILABLE","NOT_SUPPORTED_FEATURE","NO_PERMISSION","JOB_NOT_SUPPORTED","QUERY_NOT_SUPPORTED","JOIN_LIMIT_EXCEEDED","CRITERIA_NOT_SUPPORTED","CRITERIA_LIMIT_EXCEEDED","FIELD_AND_COMPARATOR_IN_CRITERIA_NOT_COMPATIBLE","FIELD_IN_CRITERIA_NOT_AVAILABLE","VALUE_IN_CRITERIA_NOT_SUPPORTED","FIELD_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE","COMPARATOR_AND_VALUE_IN_CRITERIA_NOT_COMPATIBLE","COMPARATOR_AND_ENCRYPTED_VALUE_IN_CRITERIA_NOT_COMPATIBLE","FIELD_NOT_AVAILABLE","FIELD_NOT_SUPPORTED","VALUE_LIMIT_EXCEEDED_IN_CRITERIA","PAGE_NOT_SUPPORTED","TOO_MANY_REQUESTS","CALLBACK_FAILURE","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"max_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.TransferBodyWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.GetUsersOfUserTypeParam":{"filter":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filter","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year":{"display_based_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["end_month","start_month"],"name":"display_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"start_month":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["January","February","March","April","May","June","July","August","September","October","November","December"],"name":"start_month","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NO_PERMISSION","AMBIGUITY_DURING_PROCESSING","INVALID_DATA","NOT_ALLOWED","NOT_REVIEWED","MANDATORY_NOT_FOUND","ID_ALREADY_CONVERTED","NOT_APPROVED","EXPECTED_FIELD_MISSING"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ApinameJsonpathDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["id already converted","invalid data","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.org.ResponseWrapper":{"org":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Org","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Org"},"request_supported":["action","create","delete","read","update"],"name":"org","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Reminder":{"period":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"period","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"unit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryModule":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"permissions_details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.Tag":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":25},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#F17574","#F48435","#E7A826","#A8C026","#63C57E","#1DB9B4","#57B1FD","#879BFC","#D297EE","#FD87BD","#969696","#658BA8","#B88562"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.related_records.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.business_hours.Features":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.GetJobStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.files.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_lists.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionWrapper":{"map_dependency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"map_dependency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config":{"tpt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt"},"request_supported":["action","create","delete","read","update"],"name":"tpt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"section":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section"},"request_supported":["action","create","delete","read","update"],"name":"section","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"zoho_integ":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt"},"request_supported":["action","create","delete","read","update"],"name":"zoho_integ","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"wf_scheduler":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_scheduler","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"success_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"success_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"locked_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData":{"canvas_width":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"canvas_width","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"nodes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Node","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Node"},"request_supported":["action","create","delete","read","update"],"name":"nodes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"canvas_height":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"canvas_height","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"connections":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Connection","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Connection"},"request_supported":["action","create","delete","read","update"],"name":"connections","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"color_palette":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground","request_supported":["action","create","delete","read","update"],"name":"color_palette","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters"},"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views"},"request_supported":["action","create","delete","read","update"],"name":"views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.GetAttachmentsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionWrapper":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.UsersCountParam":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ActiveUsers","DeactiveUsers","NotConfirmedUsers","ConfirmedUsers","CurrentUser","ActiveConfirmedUsers"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.RecordIdBodyWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":10},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module":{"plural_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"plural_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseWrapper":{"map_dependency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency"},"request_supported":["action","create","delete","read","update"],"name":"map_dependency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours":{"custom_timing":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming"},"request_supported":["action","create","delete","read","update"],"name":"custom_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"daily_timing":{"response_supported":["action","create","delete","read","update"],"min_length":2,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":false,"sub_type":{"type":"LocalTime"},"name":"daily_timing","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":2},"same_as_everyday":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"same_as_everyday","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"break_days":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"break_days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.BodyWrapper":{"users_unavailability":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability"},"request_supported":["action","create","delete","read","update"],"name":"users_unavailability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.download_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.download_attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record is deleted","mass delete scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryOthers":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"permissions_details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.GetUsersHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.SearchRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordParam":{"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"mail_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mail_content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"last_version_statistics":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics","request_supported":["action","create","delete","read","update"],"name":"last_version_statistics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"folder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","request_supported":["action","create","delete","read","update"],"name":"folder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","unique_for":"none","structure":true},"last_usage_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_usage_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"associated":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"associated","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"consent_linked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_linked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"editor_mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editor_mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"favorite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favorite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist":{"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.GetDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingRequestBodyHeader":{"custom_functions_header":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"custom_functions_header","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory"},"name":"data","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingRequestBodyParam":{"auth_type":{"name":"auth_type","type":"String","structure":false},"arguments":{"name":"arguments","type":"Map","structure":false},"custom_functions_param":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"custom_functions_param","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordUsingExternalIDHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.GetEmailTemplatesParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"locked_for":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked_for","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"excluded_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField"},"request_supported":["action","create","delete","read","update"],"name":"excluded_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"feature_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"locking_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules"},"request_supported":["action","create","delete","read","update"],"name":"locking_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"restricted_actions":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"restricted_actions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"lock_for_portal_users":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lock_for_portal_users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"restricted_communications":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"restricted_communications","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"system_defined":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_defined","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"lock_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["manual","automatic","both"],"name":"lock_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"restricted_custom_buttons":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton"},"request_supported":["action","create","delete","read","update"],"name":"restricted_custom_buttons","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"lock_excluded_profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile"},"request_supported":["action","create","delete","read","update"],"name":"lock_excluded_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn":{"social":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social","request_supported":["action","create","delete","read","update"],"name":"social","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social","unique_for":"none","structure":true},"name":{"regex":"[a-zA-Z]{5}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":150},"company":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company","request_supported":["action","create","delete","read","update"],"name":"company","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company","unique_for":"none","structure":true},"email":{"regex":"[a-z]{7}[@]google[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.UploadFilesHeader":{},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email":{"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"has_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sentiment_info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["positive","negative","neutral"],"name":"sentiment_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"thread_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"thread_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"from_1":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","unique_for":"none","structure":true},"reply_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","request_supported":["action","create","delete","read","update"],"name":"reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","unique_for":"none","structure":true},"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"summary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"has_thread_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_thread_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"read":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"activity_info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"activity_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mail_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mail_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"intent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["query","request","purchase","complaints","others","spam"],"name":"intent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord","unique_for":"none","structure":true},"sent_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"emotion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"emotion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status"},"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.BodyWrapper":{"cadences_ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"cadences_ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseWrapper":{"assignment_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules"},"request_supported":["action","create","delete","read","update"],"name":"assignment_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unblock_email.APIException","zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Features","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.Features"},"request_supported":["action","create","delete","read","update"],"name":"features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule":{"score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signal":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal","request_supported":["action","create","delete","read","update"],"name":"signal","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources":{"sub_territories":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sub_territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Source","request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Source","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["users","territories","roles"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expected_data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"maps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Maps","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Maps"},"request_supported":["action","create","delete","read","update"],"name":"maps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"probability":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"probability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"forecast_category":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory","request_supported":["action","create","delete","read","update"],"name":"forecast_category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory","unique_for":"none","structure":true},"sys_ref_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sys_ref_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"forecast_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"forecast_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["used","unused"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DeleteRelatedRecordUsingExternalIDHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.AddTagsToMultipleRecordsParam":{"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency":{"rounding_option":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rounding_option","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"precision":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"precision","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.digest.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelinesParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt":{"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"table":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"table","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseWrapper":{"inventory_templates":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates"},"request_supported":["action","create","delete","read","update"],"name":"inventory_templates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.GetScoringRuleParam":{"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true,false],"name":"active","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"customizable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customizable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"parent_permissions":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"parent_permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"translation":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation","request_supported":["action","create","delete","read","update"],"name":"translation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation","unique_for":"none","structure":true},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser":{"fields_update_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields_update_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"record_operations_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_operations_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.CreateZiaOrgEnrichmentParam":{"record_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["LIMIT_EXCEEDED","NOT_SUPPORTED","DEPENDENT_MISMATCH","INVALID_URL_PATTERN","INVALID_TOKEN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.CadencesAnalyticsGet":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"follow_ups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics"},"request_supported":["action","create","delete","read","update"],"name":"follow_ups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"default_assignee":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee","request_supported":["action","create","delete","read","update"],"name":"default_assignee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall":{"created_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"cancelled_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cancelled_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"failed_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"completed_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"completed_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"scheduled_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduled_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"overdue_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"overdue_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"missed_calls_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"missed_calls_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Info Icon"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation":{"public_views":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"public_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"other_users_views":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"other_users_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_with_me":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_with_me","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by_me":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_by_me","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"process_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo","request_supported":["action","create","delete","read","update"],"name":"process_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo","unique_for":"none","structure":true},"transition_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transition_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"transitions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition"},"request_supported":["action","create","delete","read","update"],"name":"transitions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.org.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.org.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.org.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.org.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionWrapper":{"change_status":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"change_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.Format":{"decimal_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Period","Comma"],"name":"decimal_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"thousand_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Period","Comma","Space"],"name":"thousand_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"decimal_places":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["0","2","3"],"name":"decimal_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionWrapper":{"currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record added","record updated","record deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Unique":{"casesensitive":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"casesensitive","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"name":"data","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateBodyWrapper":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.associate_email.BodyWrapper":{"emails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail"},"request_supported":["action","create","delete","read","update"],"name":"Emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.ActionWrapper":{"org":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"org","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","group_type":"one-of","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.ResponseWrapper":{"apis":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI"},"request_supported":["action","create","delete","read","update"],"name":"__apis","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail":{"unenroll_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty","request_supported":["action","create","delete","read","update"],"name":"unenroll_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty","unique_for":"none","structure":true},"end_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"end_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"automatic_unenroll":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"automatic_unenroll","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"execute_every":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery","request_supported":["action","create","delete","read","update"],"name":"execute_every","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule":{"score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseWrapper":{"webforms":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm"},"request_supported":["action","create","delete","read","update"],"name":"webforms","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DelinkRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"issupported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isSupported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"isenabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"isEnabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyBodyWrapper":{"scrapy_feedback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback","request_supported":["action","create","delete","read","update"],"name":"scrapy_feedback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.features.ResponseWrapper":{"features":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Feature","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.features.Feature"},"request_supported":["action","create","delete","read","update"],"name":"__features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory":{"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.UpdateWebFormParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields"},"request_supported":["action","create","delete","read","update"],"name":"_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionWrapper":{"transfer_and_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed":{"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"rename":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rename","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"clone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"downgrade":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"downgrade","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"deactivate":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deactivate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"set_layout_permissions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"set_layout_permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["People Enrichment scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"buttons":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Button"},"request_supported":["action","create","delete","read","update"],"name":"buttons","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"column_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"elements":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Element","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Element"},"request_supported":["action","create","delete","read","update"],"name":"elements","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.variables.GetVariableByIDParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.DeleteGlobalPicklistsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_write.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"decimal_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"thousand_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"thousand_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"decimal_places":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapySuccess":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enrich_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetPickListValueAssociationsParam":{"picklist_value_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"picklist_value_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.Org":{"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"hierarchy_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences","request_supported":["action","create","delete","read","update"],"name":"hierarchy_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences","unique_for":"none","structure":true},"max_per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"max_per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"photo_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"photo_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"city":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"city","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Production","Sandbox","Bigin","Developer"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"mc_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mc_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"gapps_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"gapps_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"lite_users_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lite_users_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"domain_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"domain_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"translation_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"translation_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"street":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"street","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"alias":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"alias","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"currency":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"deletable_org_account":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deletable_org_account","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"call_icon":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call_icon","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fax":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fax","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"employee_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"employee_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"website":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zia_zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zia_zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"currency_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"currency_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ezgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ezgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"oauth_presence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"oauth_presence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"mobile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mobile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"currency_locale":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"currency_locale","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zia_portal_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zia_portal_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"time_zone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time_zone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"checkin_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences","request_supported":["action","create","delete","read","update"],"name":"checkin_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences","unique_for":"none","structure":true},"zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"country_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"license_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails","request_supported":["action","create","delete","read","update"],"name":"license_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails","unique_for":"none","structure":true},"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"company_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"company_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"privacy_settings":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"privacy_settings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"primary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionWrapper":{"sign_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"sign_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"mail_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mail_content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"folder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","request_supported":["action","create","delete","read","update"],"name":"folder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","unique_for":"none","structure":true},"last_usage_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_usage_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"editor_mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"editor_mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"favorite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favorite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.UpdateMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.BodyWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["static","merge_field"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.UploadFilesParam":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo":{"industries":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry"},"request_supported":["action","create","delete","read","update"],"name":"industries","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"experiences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience"},"request_supported":["action","create","delete","read","update"],"name":"experiences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.GetCustomViewsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","REQUIRED_PARAM_MISSING","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INTERNAL_ERROR","MANDATORY_NOT_FOUND","NOT_SUPPORTED","REQUIRED_PARAM_MISSING","INVALID_MODULE","INTERNAL_SERVER_ERROR","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","One of the expected parameter is missing","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the id given seems to be invalid","One of the expected parameter is missing","record not deleted","Internal server error occurred.","the module name given seems to be invalid","required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrappe":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.FileDetails":{"owner__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"created_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"size__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Size__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"file_name__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Name__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.org.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.org.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"show_data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseWrapper":{"global_picklists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist"},"request_supported":["action","create","delete","read","update"],"name":"global_picklists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.UpdateShiftHourHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes":{"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"width":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"width","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"font_attributes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes","request_supported":["action","create","delete","read","update"],"name":"font_attributes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes","unique_for":"none","structure":true},"display_form_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_form_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"align":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"align","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.GetProfileHeader":{},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory":{"manager":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","request_supported":["action","create","delete","read","update"],"name":"Manager","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","request_supported":["action","create","delete","read","update"],"name":"Reporting_To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress":{"reason":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.GetBusinessHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_MODULE","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.UpdateRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.GetShiftHourHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline":{"extension":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"extension","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"done_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","request_supported":["action","create","delete","read","update"],"name":"done_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","unique_for":"none","structure":true},"related_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord","request_supported":["action","create","delete","read","update"],"name":"related_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord","unique_for":"none","structure":true},"automation_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail","request_supported":["action","create","delete","read","update"],"name":"automation_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail","unique_for":"none","structure":true},"record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Record","request_supported":["action","create","delete","read","update"],"name":"record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Record","unique_for":"none","structure":true},"audited_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"audited_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_history":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory"},"request_supported":["action","create","delete","read","update"],"name":"field_history","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approval_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record added","record deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.LookupField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.GetStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.ResponseWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_write.BulkWriteResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.BodyWrapper":{"emaildrafts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts"},"request_supported":["action","create","delete","read","update"],"name":"__email_drafts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionWrapper":{"users_unavailability":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users_unavailability","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PATTERN_NOT_MATCHED","INVALID_DATA","JSON_PARSE_ERROR","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"minimum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseWrapper":{"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType"},"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NOT_ALLOWED","MANDATORY_NOT_FOUND","REQUIRED_PARAM_MISSING","EXPECTED_FIELD_MISSING","AMBIGUITY_DURING_PROCESSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ErrorDetail"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationWrapper":{"associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack":{"method":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["post"],"name":"method","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.GetVariableByAPINameParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetAssignBodyWrapper":{"get_assigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","request_supported":["action","create","delete","read","update"],"name":"get_assigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList":{"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap","unique_for":"none","structure":true},"sort_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedmodule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedmodule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linkingmodule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"linkingmodule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"customize_sort":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customize_sort","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customize_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customize_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"customize_display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"customize_display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"href":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"href","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["visible","user_hidden","scheduled_for_deletion"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.GetEntityScoreParam":{"cvid":{"name":"cvid","type":"String","structure":false},"fields":{"name":"fields","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Category":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryModule","zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryOthers"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territories.GetTerritoriesParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.profiles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.notifications.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordUsingExternalIDParam":{"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["scoring rule created successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesWrapper":{"sources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources"},"request_supported":["action","create","delete","read","update"],"name":"sources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.FileBodyWrapper":{"inputfile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"inputFile","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["owner is successfully updated"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.BodyWrapper":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","DUPLICATE_DATA","REQUIRED_PARAM_MISSING","JSON_PARSE_ERROR","PATTERN_NOT_MATCHED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Appointments preferences updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ResponseWrapper":{"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.HistoryWrapper":{"history":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.History","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.backup.History"},"request_supported":["action","create","delete","read","update"],"name":"history","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping":{"deals":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"accounts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"contacts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping":{"parent_column_index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_column_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"find_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"find_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue","request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionWrapper":{"duplicate_check_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"duplicate_check_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.BodyWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS","SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.GetChildTerritoryParam":{"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Actions":{"exempted_profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"exempted_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","unique_for":"none","structure":true},"segment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","request_supported":["action","create","delete","read","update"],"name":"segment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory":{"rescheduled_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Rescheduled_To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"review_process":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$review_process","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"orchestration":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$orchestration","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"in_merge":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$in_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"rescheduled_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Rescheduled_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approved","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sharing_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$sharing_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"review":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$review","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"rescheduled_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","request_supported":["action","create","delete","read","update"],"name":"Rescheduled_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"currency_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$currency_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approval":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval","request_supported":["action","create","delete","read","update"],"name":"$approval","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval","unique_for":"none","structure":true},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"appointment_name":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName","request_supported":["action","create","delete","read","update"],"name":"Appointment_Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","unique_for":"none","structure":true},"reschedule_reason":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Reschedule_Reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zia_visions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$zia_visions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"reschedule_note":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Reschedule_Note","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"process_flow":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$process_flow","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","unique_for":"none","structure":true},"canvas_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$canvas_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"rescheduled_from":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Rescheduled_From","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"approval_state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approval_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingParametersParam":{"auth_type":{"name":"auth_type","type":"String","structure":false},"get_custom_functions_param":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"get_custom_functions_param","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"arguments":{"name":"arguments","type":"Map","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionWrapper":{"watch":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"watch","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.APIException":{"features":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Feature","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Feature"},"request_supported":["action","create","delete","read","update"],"name":"features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","CANNOT_UPDATE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.org.Feature","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.org.Feature"},"request_supported":["action","create","delete","read","update"],"name":"features","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Company not created"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline","request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline","unique_for":"none","structure":true},"stages":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages"},"request_supported":["action","create","delete","read","update"],"name":"stages","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["transition updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.BodyWrapper":{"portal_invite":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite"},"request_supported":["action","create","delete","read","update"],"name":"portal_invite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notes.APIException","zohocrmsdk.src.com.zoho.crm.api.notes.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.CreatePipelineParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail":{"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"linked_record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","request_supported":["action","create","delete","read","update"],"name":"linked_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","unique_for":"none","structure":true},"bcc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To"},"request_supported":["action","create","delete","read","update"],"name":"bcc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"from_1":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.From","request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.From","unique_for":"none","structure":true},"date_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"subject":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":250},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.To"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_format":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["html","text"],"name":"mail_format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"original_message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"original_message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sent":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["equal","not_equal","in","not_in","less_than","less_equal","greater_than","greater_equal","contains","not_contains","starts_with","ends_with","between","not_between"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["and","or"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectLookup":{"fieldname":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fieldName","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"has_more":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$has_more","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldsHeader":{},"zohocrmsdk.src.com.zoho.crm.api.notes.ParentId":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData":{"org_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"org_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description"},"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ceo":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ceo","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secondary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secondary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"revenue":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"revenue","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"years_in_industry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"years_in_industry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"other_contacts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"other_contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"techno_graphic_data":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"techno_graphic_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"logo":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"logo","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secondary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secondary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"other_emails":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"other_emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"sign_in":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign_in","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"website":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address"},"request_supported":["action","create","delete","read","update"],"name":"address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sign_up":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign_up","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"org_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"org_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"head_quarters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address"},"request_supported":["action","create","delete","read","update"],"name":"head_quarters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"no_of_employees":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"no_of_employees","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory_list":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"territory_list","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"founding_year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"founding_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"industries":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry"},"request_supported":["action","create","delete","read","update"],"name":"industries","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"business_model":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"business_model","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"primary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"social_media":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia"},"request_supported":["action","create","delete","read","update"],"name":"social_media","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.profiles.GetProfilesParam":{"include_lite_profile":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_lite_profile","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper":{"conflict_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"conflict_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"access_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["public","only_to_me","shared"],"name":"access_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","unique_for":"none","structure":true},"system_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","unique_for":"none","structure":true},"sort_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy","request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","unique_for":"none","structure":true},"shared_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo"},"request_supported":["action","create","delete","read","update"],"name":"shared_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"offline":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"offline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","unique_for":"none","structure":true},"system_defined":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_defined","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_accessed_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_accessed_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"locked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"locked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"favorite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favorite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["asc","desc"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portals.APIException","zohocrmsdk.src.com.zoho.crm.api.portals.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails":{"related_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","request_supported":["action","create","delete","read","update"],"name":"related_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","unique_for":"none","structure":true},"lookup_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","request_supported":["action","create","delete","read","update"],"name":"lookup_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["RESOURCE_NOT_FOUND","INVALID_DATA","NOT_ALLOWED","EXPECTED_FIELD_MISSING","LIMIT_EXCEEDED","MANDATORY_NOT_FOUND","NO_PERMISSION","REQUIRED_PARAM_MISSING","INVALID_MODULE","API_NOT_SUPPORTED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permissions_needed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.DETAIL1"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"supported_version","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["permission denied"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.JsonDetails":{"expected_data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitor":{"auto_response_rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule","request_supported":["action","create","delete","read","update"],"name":"auto_response_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule","unique_for":"none","structure":true},"template_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"template_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.UpdateTagsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetGlobalPicklistsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.holidays.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.timelines.State":{"trigger_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"trigger_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"is_last_state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_last_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Tags":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","DUPLICATE_DATA","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the name given seems to be invalid","the id given seems to be invalid","the default_assignee given seems to be invalid","the module name given seems to be invalid","the given assignment rule name already exists","One of the expected parameter is missing"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["OR","AND"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"min_length":2,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria"},"name":"group","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":2}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.From":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes":{"method":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"method","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"oauth_scope":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"oauth_scope","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"max_credits":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"max_credits","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"min_credits":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"min_credits","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes":{"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"family":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"family","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.Info":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"allowed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allowed_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.UploadPhotoParam":{"restrict_triggers":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_triggers","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.GetModulesHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.ChangeUsersStatusParam":{"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingFileHeader":{"upload_file_header":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"upload_file_header","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType":{"web_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"web_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"web_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"web_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseWrapper":{"duplicate_check_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","request_supported":["action","create","delete","read","update"],"name":"duplicate_check_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ResonseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseWrapper":{"replaced_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue"},"request_supported":["action","create","delete","read","update"],"name":"replaced_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"owner_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty":{"end_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"end_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_read.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Source":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","EXPECTED_FIELD_MISSING","INVALID_DATA","MANDATORY_NOT_FOUND","INVALID_MODULE","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_related_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.ActionWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BodyWrapper":{"shift_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours"},"request_supported":["action","create","delete","read","update"],"name":"shift_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info":{"call":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty"},"request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData":{"website":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email_infos":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo"},"request_supported":["action","create","delete","read","update"],"name":"email_infos","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"gender":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"gender","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"company_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo","request_supported":["action","create","delete","read","update"],"name":"company_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo","unique_for":"none","structure":true},"last_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"educations":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"educations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"middle_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"middle_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"skills":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"skills","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"other_contacts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"other_contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"address_list_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address"},"request_supported":["action","create","delete","read","update"],"name":"address_list_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"primary_address_info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","request_supported":["action","create","delete","read","update"],"name":"primary_address_info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"secondary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"secondary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"designation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"designation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"interests":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"interests","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"first_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"social_media":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia"},"request_supported":["action","create","delete","read","update"],"name":"social_media","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails":{"record":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"inventory_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate","request_supported":["action","create","delete","read","update"],"name":"inventory_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate","unique_for":"none","structure":true},"paper_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"paper_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.backup.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territories.Territories":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"manager":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Manager","request_supported":["action","create","delete","read","update"],"name":"manager","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Manager","unique_for":"none","structure":true},"account_rule_criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","request_supported":["action","create","delete","read","update"],"name":"account_rule_criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"lead_rule_criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","request_supported":["action","create","delete","read","update"],"name":"lead_rule_criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","unique_for":"none","structure":true},"reporting_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo","request_supported":["action","create","delete","read","update"],"name":"reporting_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"deal_rule_criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","request_supported":["action","create","delete","read","update"],"name":"deal_rule_criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["read_write_delete","read_only"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.CreateWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notifications.Event":{"channel_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"resource_uri":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_uri","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resource_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"resource_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notification_condition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition"},"request_supported":["action","create","delete","read","update"],"name":"notification_condition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"channel_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"channel_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionWrapper":{"shift_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"shift_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.BodyWrapper":{"webforms":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm"},"request_supported":["action","create","delete","read","update"],"name":"webforms","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.InviteUsersParam":{"user_type_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_type_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"language":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["en_US","en_GB","bg_BG","zh_CN","zh_TW","hr_HR","ar_EG","in_ID","cs_CZ","da_DK","nl_NL","fr_FR","de_DE","hu_HU","","hi_IN","it_IT","ja_JP","pl_PL","pt_BR","pt_PT","ru_RU","es_ES","sv_SE","th_TH","tr_TR","vi_VN","ko_KR","iw_IL"],"name":"language","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invite","reinvite"],"name":"type","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.TimeRange":{"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"From","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"To","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.GetTimelinesParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["extension","type"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["field_history.data_type","field_history.enable_colour_code","field_history.pick_list_values","field_history.field_label"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"include_timeline_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_timeline_type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["desc","asc"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.ResponseWrapper":{"roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.Role","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.roles.Role"},"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":80},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["shift_holiday"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"shift_hour":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","request_supported":["action","create","delete","read","update"],"name":"shift_hour","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.JobsWrapper":{"deletion_jobs":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs"},"request_supported":["action","create","delete","read","update"],"name":"deletion_jobs","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores":{"scoring_rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule","request_supported":["action","create","delete","read","update"],"name":"Scoring_Rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule","unique_for":"none","structure":true},"score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"zia_visions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$zia_visions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"touch_point_negative_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Touch_Point_Negative_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"touch_point_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Touch_Point_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"positive_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Positive_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"field_states":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"$field_states","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"touch_point_positive_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Touch_Point_Positive_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"entity":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity","request_supported":["action","create","delete","read","update"],"name":"Entity","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity","unique_for":"none","structure":true},"negative_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Negative_Score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.BodyWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":5},"unblock_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"unblock_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NO_CONTENT","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","TERRITORY_NOT_ENABLED","DEPENDENT_FIELD_MISSING","EXPECTED_FIELD_MISSING","FEATURE_NOT_SUPPORTED","CONVERTED_RECORD","NOT_FOUND","NO_RECORDS_FOUND","NOT_APPROVED","LIMIT_EXCEEDED","ALREADY_SCHEDULED","CANNOT_PERFORM_ACTION","CANNOT_PROCESS","INTERNAL_ERROR","INVALID_TOKEN","INVALID_DATA","STORAGE_SPACE_EXCEEDED","MANDATORY_NOT_FOUND","NO_PERMISSION","INVALID_MODULE","NOT_SUPPORTED","PATTERN_NOT_MATCHED","OAUTH_SCOPE_MISMATCH","DUPLICATE_DATA","INVALID_QUERY","MAPPING_MISMATCH","ID_ALREADY_CONVERTED","FILE_SIZE_MORE_THAN_ALLOWED_SIZE","RECORD_IN_BLUEPRINT","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","CANNOT_DELETE","REQUIRED_PARAM_MISSING","DATA_MISMATCH","RECORD_LOCKED","BAD_REQUEST","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord","request_supported":["action","create","delete","read","update"],"name":"duplicate_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allowed_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"parent_api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"External","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record under merge is locked","the given id seems to be invalid","The record is not approved","The external ID of the lookup field or the Price Book is incorrect","The value of the external field is invalid.","There is no data for the ID specified or there is no matching record in the given module.","The external field contains duplicate data.","the territory feature is not enabled","Given Probability is not valid","duplicate territory id found","Given Territory id already exists for that record","User has no permission to assign this territory","Maximum limit of territories for that record exceeds","Invalid Sequence Number","Record insertion limit for Image upload field has been exceeded.","Record insertion limit has been exceeded.","The image format is invalid.","Dependent Fields missing","Specify Atleast one field","the id given seems to be invalid.","Already an Mass Action scheduler is runing for the given cvid","Scheduled Mass Operation feature is not available in your edition","can't update the converted record","Field cannot be updated in Scheduled Mass Update","Field is not visible","Field cannot be updated as it is associated with a validation rule.","Field cannot be updated as it is associated with a layout rule.This field cannot be updated in the Mass Update","Max field limit exceeded","Maximum lookup field limit in criteria exceeded","No field found","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","Territory is not supported for the given module","Please check whether the input values are correct","invalid data","permission denied","Internal server error occurred.","duplicate data","required field not found","Layout doesn't contain the Pipeline","Pipeline doesn't contain the Stage","the id given seems to be invalid","record not deleted","record not deletable","Authentication failed","One of the expected parameter is missing","mandatory param missing","invalid query formed","id already converted","body","given id is invalid","Already a Mass Action scheduler is running for the given cvid","The record is in stop processing","The record is in blue print","no permission to perform an action on this record","Record count exceeded","record not approved","no record found to update","Field Edit Permission not given","Customview not accessible","Empty response","give contact id is mismatched with the data","give account id is mismatched with the data","Territory id which you are trying to remove was system assigned"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal":{"namespace":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"namespace","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DealField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.BodyWrapper":{"org_taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","request_supported":["action","create","delete","read","update"],"name":"org_taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","unique_for":"none","structure":true,"max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingParametersHeader":{"get_custom_functions_header":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"get_custom_functions_header","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCountWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","unique_for":"none","structure":true},"file_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ics"],"name":"file_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"regex":"[1-9]|[1-4][1-9]|50","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.UpdatePipelinesParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.CountHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.CountWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.GetDownloadAttachmentsDetailsParam":{"user_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DelinkRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Feature":{"components":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Component","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.features.Component"},"request_supported":["action","create","delete","read","update"],"name":"components","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"parent_feature":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Feature","request_supported":["action","create","delete","read","update"],"name":"parent_feature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Feature","unique_for":"none","structure":true},"module_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Detail","unique_for":"none","structure":true},"feature_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","PATTERN_NOT_MATCHED","INTERNAL_ERROR","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","REQUIRED_PARAM_MISSING","BAD_REQUEST","NO_PERMISSION","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Invalid Wizard ID","the module name given seems to be invalid","feature not available in this edition","permission denied","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","Internal server error occurred."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.UpdateFieldParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","DUPLICATE_DATA","INVALID_MODULE","INTERNAL_SERVER_ERROR","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation":{"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["BAD_REQUEST","INVALID_MODULE","SHARE_LIMIT_EXCEEDED","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","DUPLICATE_DATA","LIMIT_EXCEEDED","MANDATORY_NOT_FOUND","INVALID_DATA","ENTITY_ID_INVALID","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Scheduler is running","cannot share to the user","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","record not deleted","the related id given seems to be invalid","The relation name given seems to be invalid.","invalid oauth scope to access this URL","Please check if the URL trying to access is a correct one.","Permission is invalid","record is already visible to the user.","Cannot share a record to more than 10 users.","No sharing through this record is available to revoke.","ENTITY_ID_INVALID"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionWrapper":{"webforms":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"webforms","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DownloadHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.Participants":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"invited":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"invited","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"participant":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"participant","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association":{"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module","unique_for":"none","structure":true},"layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout"},"request_supported":["action","create","delete","read","update"],"name":"layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout","unique_for":"none","structure":true},"field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings"},"request_supported":["action","create","delete","read","update"],"name":"field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["VERSION_NOT_SUPPORTED","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.Resources":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.BodyWrapper":{"record_locking_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock"},"request_supported":["action","create","delete","read","update"],"name":"record_locking_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.Manager":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.Preference":{"auto_populate_tax":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"auto_populate_tax","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modify_tax_rates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modify_tax_rates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.Variable":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["text","integer","percent","double","currency","date","datetime","email","phone","website","textarea","checkbox","long"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"variable_group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup","request_supported":["action","create","delete","read","update"],"name":"variable_group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.CountResponseWrapper":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DelinkRecordsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"jobId","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["User added","User updated","User deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.DeleteUserFromThePortalParam":{"personality_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false,"max_length":10},"colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"forecast_category":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory","request_supported":["action","create","delete","read","update"],"name":"forecast_category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory","unique_for":"none","structure":true},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"forecast_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"forecast_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm":{"google_site":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"google_site","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"encrypted_form_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"encrypted_form_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"acknowledge_visitor":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors","request_supported":["action","create","delete","read","update"],"name":"acknowledge_visitor","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors","unique_for":"none","structure":true},"button_attributes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes"},"request_supported":["action","create","delete","read","update"],"name":"button_attributes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action_on_submit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action_on_submit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"iframe_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iframe_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"form_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields"},"request_supported":["action","create","delete","read","update"],"name":"form_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","unique_for":"none","structure":true},"encrypted_zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"encrypted_zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"abtesting":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting"},"request_supported":["action","create","delete","read","update"],"name":"abtesting","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"action_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","unique_for":"none","structure":true},"embed_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"embed_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"analytics_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData","request_supported":["action","create","delete","read","update"],"name":"analytics_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","unique_for":"none","structure":true},"suggestion":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion","request_supported":["action","create","delete","read","update"],"name":"suggestion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion","unique_for":"none","structure":true},"encrypted_module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"encrypted_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"adword_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"adword_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"notify_owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","request_supported":["action","create","delete","read","update"],"name":"notify_owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.User","unique_for":"none","structure":true},"form_attributes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes","request_supported":["action","create","delete","read","update"],"name":"form_attributes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes","unique_for":"none","structure":true},"location_url":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"location_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"landing_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"landing_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"double_optin_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"double_optin_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Tags","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Tags"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"last_submitted_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_submitted_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","unique_for":"none","structure":true},"code_formats":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"code_formats","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"approval_request":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approval_request","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assignment_rule":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule","request_supported":["action","create","delete","read","update"],"name":"assignment_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"source_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"spam_control":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll","request_supported":["action","create","delete","read","update"],"name":"spam_control","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll","unique_for":"none","structure":true},"visitor_tracking":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visitor_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.BodyWrapper":{"ziaorgenrichment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment"},"name":"__zia_org_enrichment","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.related_records.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NO_PERMISSION","CANNOT_BE_UPDATED","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","INTERNAL_ERROR","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid data","invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","record not deleted","the related id given seems to be invalid","Internal server error occurred.","The relation name given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["used","unused"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments":{"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.UpdateHolidayHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDeleteByID":{"move_subordinate":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","request_supported":["action","create","delete","read","update"],"name":"move_subordinate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","unique_for":"none","structure":true},"transfer":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","request_supported":["action","create","delete","read","update"],"name":"transfer","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.digest.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.digest.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea":{"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"prev_index":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prev_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException":{"error_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Bad Request"],"name":"ERROR_MESSAGE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","FILE_TOO_LARGE","INVALID_FILE_FORMAT","MANDATORY_FIELDS_NOT_MAPPED","MANDATORY_NOT_FOUND","INVALID_FIELD","INVALID_FORMAT","INVALID_FILE_ID","HEADER_LIMIT_EXCEEDED","COLUMN_INDEX_NOT_FOUND","MODULE_NOT_AVAILABLE","INVALID_DATA","DUPLICATE_DATA","NOT_APPROVED","BLOCKED_RECORD","CANNOT_PROCESS","LIMIT_EXCEEDED","RESOURCE_NOT_FOUND","MISSING_REQUIRED_KEY","INVALID_FIELD_NAME","FILE_NOT_SUPPORTED","COEXISTENCE_NOT_ALLOWED","INVALID_CALLBACK_METHOD","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"x_info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Link not valid"],"name":"x-info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_callback_methods","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"error_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ERROR_CODE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"http_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"http_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","invalid file format. only zip format is supported","File size too large to process","The requested resource doesn't exist.","required key operation is not found in request body.","improper file id","required key index for field Company is not found in request body.","All mandatory fields are not mapped for the layout","Requested module 'asdf' is not available.","invalid mapping. invalid api_name ast_Name.","File not supported for bulk write"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"x_error":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["check if headers [feature, X-CRM-ORG] are present and valid"],"name":"x-error","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"info":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Forbidden"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["MANDATORY_NOT_FOUND","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","EXPECTED_FIELD_MISSING","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday":{"date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":80},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.RequestWrapper":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource"},"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ignore_empty":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ignore_empty","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"character_encoding":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"character_encoding","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"callback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","request_supported":["action","create","delete","read","update"],"name":"callback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","unique_for":"none","structure":true},"operation":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["insert","update","upsert"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings":{"share_from_users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser"},"request_supported":["action","create","delete","read","update"],"name":"share_from_users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"available_types":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"available_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.BodyWrapper":{"digest":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.digest.Digest","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.digest.Digest"},"request_supported":["action","create","delete","read","update"],"name":"__digest","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"first_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.From":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.DeleteAttachmentsParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.BodyWrapper":{"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience":{"end_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"end_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"company_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"company_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"start_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"primary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"primary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences":{"restricted_event_types":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted_event_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.CreateShiftHoliday":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn":{"website":{"regex":"www[.][a-z0-9]+[.][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"regex":"[a-zA-Z]{5}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":150},"email":{"regex":"[a-z]{7}[@]google[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.ResponseWrapper":{"backup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","request_supported":["action","create","delete","read","update"],"name":"backup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Backup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Wizard":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MAPPING_MISMATCH","DUPLICATE_DATA","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","INTERNAL_SERVER_ERROR","PATTERN_NOT_MATCHED","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails","request_supported":["action","create","delete","read","update"],"name":"mapped_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section":{"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"options":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option"},"request_supported":["action","create","delete","read","update"],"name":"options","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.Theme":{"normal_tab":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","request_supported":["action","create","delete","read","update"],"name":"normal_tab","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","unique_for":"none","structure":true},"selected_tab":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","request_supported":["action","create","delete","read","update"],"name":"selected_tab","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Tab","unique_for":"none","structure":true},"new_background":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"new_background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"background":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["#F3F0EB"],"name":"background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"screen":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["fixed"],"name":"screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.util.Model":{"classes":["zohocrmsdk.src.com.zoho.crm.api.attachments.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.CreateBusinessHoliday","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules","zohocrmsdk.src.com.zoho.crm.api.shift_hours.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child","zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Info","zohocrmsdk.src.com.zoho.crm.api.wizards.Segment","zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline","zohocrmsdk.src.com.zoho.crm.api.apis.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Attachments","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.Jobs","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Expression","zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Wrapper","zohocrmsdk.src.com.zoho.crm.api.tags.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.backup.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrency","zohocrmsdk.src.com.zoho.crm.api.notes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.isc_signature.Signature","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.DealRecordConfiguration","zohocrmsdk.src.com.zoho.crm.api.territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.features.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","zohocrmsdk.src.com.zoho.crm.api.tags.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.DefaultAssignee","zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","zohocrmsdk.src.com.zoho.crm.api.timelines.NameIdStructure","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField","zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Criteria","zohocrmsdk.src.com.zoho.crm.api.fields.Formula","zohocrmsdk.src.com.zoho.crm.api.user_groups.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHour","zohocrmsdk.src.com.zoho.crm.api.taxes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.definition.APIException","zohocrmsdk.src.com.zoho.crm.api.record.FileDetails","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","zohocrmsdk.src.com.zoho.crm.api.service_preference.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground","zohocrmsdk.src.com.zoho.crm.api.send_mail.Cc","zohocrmsdk.src.com.zoho.crm.api.record_locking.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferToUser","zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineWrapper","zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectLookup","zohocrmsdk.src.com.zoho.crm.api.blueprint.ProcessInfo","zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistoryValue","zohocrmsdk.src.com.zoho.crm.api.associate_email.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable","zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter","zohocrmsdk.src.com.zoho.crm.api.fields.Subform","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Wrapper","zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.files.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Field","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment","zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakCustomTiming","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroupsWrapper","zohocrmsdk.src.com.zoho.crm.api.record.PriceBook","zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipelineWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.JobDetail","zohocrmsdk.src.com.zoho.crm.api.webforms.User","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.timelines.PicklistDetail","zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","zohocrmsdk.src.com.zoho.crm.api.change_owner.MassWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info","zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity","zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed","zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes","zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource","zohocrmsdk.src.com.zoho.crm.api.portals.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.user_type_users.Info","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Social","zohocrmsdk.src.com.zoho.crm.api.email_templates.LastVersionStatistics","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ShareFromUser","zohocrmsdk.src.com.zoho.crm.api.territories.TransferBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Tax","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord","zohocrmsdk.src.com.zoho.crm.api.user_groups.UserGroup","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails","zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCountWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.UrlsWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks","zohocrmsdk.src.com.zoho.crm.api.download_inline_images.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule","zohocrmsdk.src.com.zoho.crm.api.layouts.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo","zohocrmsdk.src.com.zoho.crm.api.notes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.business_hours.Features","zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax","zohocrmsdk.src.com.zoho.crm.api.record.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_write.Result","zohocrmsdk.src.com.zoho.crm.api.timelines.AutomationDetail","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company","zohocrmsdk.src.com.zoho.crm.api.templates.Templates","zohocrmsdk.src.com.zoho.crm.api.notes.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","zohocrmsdk.src.com.zoho.crm.api.portals.Portals","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields","zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView","zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours","zohocrmsdk.src.com.zoho.crm.api.email_related_records.UserDetails","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.record.RecurringActivity","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ExpectedFields","zohocrmsdk.src.com.zoho.crm.api.profiles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.RecordIdBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedFieldMap","zohocrmsdk.src.com.zoho.crm.api.roles.APIException","zohocrmsdk.src.com.zoho.crm.api.profiles.Section","zohocrmsdk.src.com.zoho.crm.api.blueprint.Currency","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts","zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.InventoryConverter","zohocrmsdk.src.com.zoho.crm.api.backup.Backup","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","zohocrmsdk.src.com.zoho.crm.api.webforms.Owner","zohocrmsdk.src.com.zoho.crm.api.org.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryModule","zohocrmsdk.src.com.zoho.crm.api.layouts.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.Territory","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapySuccess","zohocrmsdk.src.com.zoho.crm.api.convert_lead.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences","zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","zohocrmsdk.src.com.zoho.crm.api.email_drafts.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Data","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule","zohocrmsdk.src.com.zoho.crm.api.blueprint.Layout","zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap","zohocrmsdk.src.com.zoho.crm.api.entity_scores.EntityScores","zohocrmsdk.src.com.zoho.crm.api.custom_views.Translation","zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder","zohocrmsdk.src.com.zoho.crm.api.fields.Fields","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users.CustomizeInfo","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.MultiSelectLookup","zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions","zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateTerritory","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","zohocrmsdk.src.com.zoho.crm.api.webforms.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedTerritories","zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.definition.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.APIException","zohocrmsdk.src.com.zoho.crm.api.templates.Wrapper","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.APIException","zohocrmsdk.src.com.zoho.crm.api.blueprint.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.APIException","zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues","zohocrmsdk.src.com.zoho.crm.api.cadences.Summary","zohocrmsdk.src.com.zoho.crm.api.user_groups.Source","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.APIException","zohocrmsdk.src.com.zoho.crm.api.users.APIException","zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status","zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultAssignmentView","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment","zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.Node","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module","zohocrmsdk.src.com.zoho.crm.api.portals.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.CadencesAnalyticsGet","zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.backup.HistoryWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.wizards.Container","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unblock_email.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.Info","zohocrmsdk.src.com.zoho.crm.api.wizards.Message","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.APIException","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ContactRole","zohocrmsdk.src.com.zoho.crm.api.cadences.User","zohocrmsdk.src.com.zoho.crm.api.files.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.EnrichField","zohocrmsdk.src.com.zoho.crm.api.fields.Unique","zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.templates.Folder","zohocrmsdk.src.com.zoho.crm.api.cadences.ExecutionDetail","zohocrmsdk.src.com.zoho.crm.api.webforms.FromAddress","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","zohocrmsdk.src.com.zoho.crm.api.business_hours.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDeleteByID","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.FieldMappings","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","zohocrmsdk.src.com.zoho.crm.api.email_related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.conversion_option.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval","zohocrmsdk.src.com.zoho.crm.api.functions.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RecordLock","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules","zohocrmsdk.src.com.zoho.crm.api.record.Consent","zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.AllowedOutputData","zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse","zohocrmsdk.src.com.zoho.crm.api.users_territories.Info","zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.user_groups.UnAssignedActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton","zohocrmsdk.src.com.zoho.crm.api.taxes.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Module","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport","zohocrmsdk.src.com.zoho.crm.api.users.Role","zohocrmsdk.src.com.zoho.crm.api.backup.Urls","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.unblock_email.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address","zohocrmsdk.src.com.zoho.crm.api.layouts.DealField","zohocrmsdk.src.com.zoho.crm.api.users.Profile","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap","zohocrmsdk.src.com.zoho.crm.api.backup.Requester","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Association","zohocrmsdk.src.com.zoho.crm.api.bulk_write.CallBack","zohocrmsdk.src.com.zoho.crm.api.send_mail.From","zohocrmsdk.src.com.zoho.crm.api.blueprint.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.taxes.Tax","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData","zohocrmsdk.src.com.zoho.crm.api.users_territories.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Widget","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SocialMedia","zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.download_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount","zohocrmsdk.src.com.zoho.crm.api.email_drafts.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.Manager","zohocrmsdk.src.com.zoho.crm.api.layouts.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.variables.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.DataFields","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MergeData","zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.associate_email.Available","zohocrmsdk.src.com.zoho.crm.api.webforms.Fields","zohocrmsdk.src.com.zoho.crm.api.notifications.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.templates.APIException","zohocrmsdk.src.com.zoho.crm.api.business_hours.Resources","zohocrmsdk.src.com.zoho.crm.api.blueprint.Crypt","zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper","zohocrmsdk.src.com.zoho.crm.api.variables.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.TypeConfiguration","zohocrmsdk.src.com.zoho.crm.api.send_mail.DataSubjectRequest","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails","zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner","zohocrmsdk.src.com.zoho.crm.api.field_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Profile","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers","zohocrmsdk.src.com.zoho.crm.api.fields.Maps","zohocrmsdk.src.com.zoho.crm.api.users.Theme","zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo","zohocrmsdk.src.com.zoho.crm.api.custom_views.SortBy","zohocrmsdk.src.com.zoho.crm.api.change_owner.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Actions","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.AssignmentRules","zohocrmsdk.src.com.zoho.crm.api.related_lists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.files.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.RecordSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException","zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","zohocrmsdk.src.com.zoho.crm.api.backup.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.profiles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territory_users.Info","zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role","zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays","zohocrmsdk.src.com.zoho.crm.api.download_inline_images.APIException","zohocrmsdk.src.com.zoho.crm.api.record.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate","zohocrmsdk.src.com.zoho.crm.api.roles.Role","zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.User","zohocrmsdk.src.com.zoho.crm.api.portals.Owner","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.entity_scores.ScoringRule","zohocrmsdk.src.com.zoho.crm.api.portals.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.APIException","zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll","zohocrmsdk.src.com.zoho.crm.api.timelines.Record","zohocrmsdk.src.com.zoho.crm.api.record.Reminder","zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline","zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps","zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition","zohocrmsdk.src.com.zoho.crm.api.variable_groups.MinifiedVariableGroup","zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup","zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.CountWrapper","zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryTemplate","zohocrmsdk.src.com.zoho.crm.api.holidays.CreateShiftHoliday","zohocrmsdk.src.com.zoho.crm.api.blueprint.Escalation","zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn","zohocrmsdk.src.com.zoho.crm.api.timelines.Info","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.Attachments","zohocrmsdk.src.com.zoho.crm.api.entity_scores.Info","zohocrmsdk.src.com.zoho.crm.api.fields.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Resource","zohocrmsdk.src.com.zoho.crm.api.users.Tab","zohocrmsdk.src.com.zoho.crm.api.territory_users.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.APIException","zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo","zohocrmsdk.src.com.zoho.crm.api.related_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser","zohocrmsdk.src.com.zoho.crm.api.timelines.State","zohocrmsdk.src.com.zoho.crm.api.timelines.Timeline","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.notifications.Module","zohocrmsdk.src.com.zoho.crm.api.tags.NewTagRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.download_attachments.APIException","zohocrmsdk.src.com.zoho.crm.api.profiles.PermissionDetail","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions","zohocrmsdk.src.com.zoho.crm.api.custom_views.Info","zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping","zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria","zohocrmsdk.src.com.zoho.crm.api.variable_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.convert_lead.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.ConditionalRules","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences.Module","zohocrmsdk.src.com.zoho.crm.api.users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.digest.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty1","zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValues","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation","zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.record.LineTax","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field","zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Resource","zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.attachments.Info","zohocrmsdk.src.com.zoho.crm.api.roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules","zohocrmsdk.src.com.zoho.crm.api.tags.Info","zohocrmsdk.src.com.zoho.crm.api.attachments.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User","zohocrmsdk.src.com.zoho.crm.api.record.Territory","zohocrmsdk.src.com.zoho.crm.api.custom_views.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField","zohocrmsdk.src.com.zoho.crm.api.pipeline.JsonDetails","zohocrmsdk.src.com.zoho.crm.api.user_type_users.StatusActionWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUserCount","zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTagRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.features.APIException","zohocrmsdk.src.com.zoho.crm.api.user_type_users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User","zohocrmsdk.src.com.zoho.crm.api.send_mail.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Field","zohocrmsdk.src.com.zoho.crm.api.record_locking.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours","zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EmailInfo","zohocrmsdk.src.com.zoho.crm.api.tags.CountResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config","zohocrmsdk.src.com.zoho.crm.api.webforms.AutoResponseRule","zohocrmsdk.src.com.zoho.crm.api.definition.Property","zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMergeWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationWrapper","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_lists.APIException","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.profiles.Info","zohocrmsdk.src.com.zoho.crm.api.modules.Argument","zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","zohocrmsdk.src.com.zoho.crm.api.record.Criteria","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.notifications.NotificationCondition","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.digest.Dependee","zohocrmsdk.src.com.zoho.crm.api.pipeline.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI","zohocrmsdk.src.com.zoho.crm.api.notes.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portals.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Industry","zohocrmsdk.src.com.zoho.crm.api.users_territories.Validation","zohocrmsdk.src.com.zoho.crm.api.timelines.Module","zohocrmsdk.src.com.zoho.crm.api.org.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo","zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces","zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.blueprint.Profile","zohocrmsdk.src.com.zoho.crm.api.wizards.Button","zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","zohocrmsdk.src.com.zoho.crm.api.tags.Tag","zohocrmsdk.src.com.zoho.crm.api.users.Owner","zohocrmsdk.src.com.zoho.crm.api.record_locking.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.InventoryTemplates","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesWrapper","zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty","zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery","zohocrmsdk.src.com.zoho.crm.api.variables.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings","zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.AssociateEmail","zohocrmsdk.src.com.zoho.crm.api.webforms.AnalyticsData","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module","zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module","zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate","zohocrmsdk.src.com.zoho.crm.api.related_records.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.bulk_write.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User","zohocrmsdk.src.com.zoho.crm.api.timelines.RelatedRecord","zohocrmsdk.src.com.zoho.crm.api.users.Info","zohocrmsdk.src.com.zoho.crm.api.coql.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.Users","zohocrmsdk.src.com.zoho.crm.api.mass_convert.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.pipeline.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFieldLookup","zohocrmsdk.src.com.zoho.crm.api.blueprint.Field","zohocrmsdk.src.com.zoho.crm.api.backup.Info","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.business_hours.BreakHoursCustomTiming","zohocrmsdk.src.com.zoho.crm.api.profiles.MinifiedProfile","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Info","zohocrmsdk.src.com.zoho.crm.api.cadences.Info","zohocrmsdk.src.com.zoho.crm.api.functions.APIException","zohocrmsdk.src.com.zoho.crm.api.files.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.related_lists.RelatedList","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.APIException","zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup","zohocrmsdk.src.com.zoho.crm.api.record.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.functions.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.wizards.Element","zohocrmsdk.src.com.zoho.crm.api.record.Participants","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment","zohocrmsdk.src.com.zoho.crm.api.coql.ClauseDetails","zohocrmsdk.src.com.zoho.crm.api.features.Feature","zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.Tags","zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrappe","zohocrmsdk.src.com.zoho.crm.api.notes.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.LayoutRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data","zohocrmsdk.src.com.zoho.crm.api.fields.Criteria","zohocrmsdk.src.com.zoho.crm.api.email_templates.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","zohocrmsdk.src.com.zoho.crm.api.features.Component","zohocrmsdk.src.com.zoho.crm.api.blueprint.Module","zohocrmsdk.src.com.zoho.crm.api.associate_email.APIException","zohocrmsdk.src.com.zoho.crm.api.digest.Digest","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp","zohocrmsdk.src.com.zoho.crm.api.contact_roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.email_related_records.LinkedRecord","zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource","zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.User","zohocrmsdk.src.com.zoho.crm.api.blueprint.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdate","zohocrmsdk.src.com.zoho.crm.api.roles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.notifications.Event","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType","zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.Info","zohocrmsdk.src.com.zoho.crm.api.email_templates.Info","zohocrmsdk.src.com.zoho.crm.api.timelines.FieldHistory","zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.APIException","zohocrmsdk.src.com.zoho.crm.api.related_lists.Field","zohocrmsdk.src.com.zoho.crm.api.change_owner.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Field","zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup","zohocrmsdk.src.com.zoho.crm.api.bulk_write.RequestWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData","zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord","zohocrmsdk.src.com.zoho.crm.api.webforms.FontAttributes","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment","zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","zohocrmsdk.src.com.zoho.crm.api.cadences.Cadences","zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","zohocrmsdk.src.com.zoho.crm.api.notifications.Notification","zohocrmsdk.src.com.zoho.crm.api.modules.LookupFieldProperties","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Status","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Experience","zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.coql.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCount","zohocrmsdk.src.com.zoho.crm.api.service_preference.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules","zohocrmsdk.src.com.zoho.crm.api.fields.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Info","zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.Record","zohocrmsdk.src.com.zoho.crm.api.record.RemindAt","zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException","zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord","zohocrmsdk.src.com.zoho.crm.api.mail_merge.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.CurrentPicklist","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.Note","zohocrmsdk.src.com.zoho.crm.api.entity_scores.APIException","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Signal","zohocrmsdk.src.com.zoho.crm.api.user_groups.GetUnassignBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.WebForm","zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType","zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Views","zohocrmsdk.src.com.zoho.crm.api.wizards.Connection","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps","zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField","zohocrmsdk.src.com.zoho.crm.api.holidays.Holidays","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipeline","zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.Preference","zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCountWrapper","zohocrmsdk.src.com.zoho.crm.api.org.Resource","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.MasterRecordFields","zohocrmsdk.src.com.zoho.crm.api.backup.History","zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadMailMerge","zohocrmsdk.src.com.zoho.crm.api.cadences.APIException","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field","zohocrmsdk.src.com.zoho.crm.api.record.Comment","zohocrmsdk.src.com.zoho.crm.api.related_records.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.SharingProperties","zohocrmsdk.src.com.zoho.crm.api.associate_email.LinkedRecord","zohocrmsdk.src.com.zoho.crm.api.variables.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.backup.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.MergeWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.org.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field","zohocrmsdk.src.com.zoho.crm.api.bulk_write.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.CompanyInfo","zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip","zohocrmsdk.src.com.zoho.crm.api.territories.ReportingTo","zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal","zohocrmsdk.src.com.zoho.crm.api.record_locking.Info","zohocrmsdk.src.com.zoho.crm.api.layouts.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.notifications.Criteria","zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException","zohocrmsdk.src.com.zoho.crm.api.backup.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.global_picklists.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.contact_roles.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference","zohocrmsdk.src.com.zoho.crm.api.profiles.CategoryOthers","zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Info","zohocrmsdk.src.com.zoho.crm.api.record.TimeRange","zohocrmsdk.src.com.zoho.crm.api.notifications.Field","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module","zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","zohocrmsdk.src.com.zoho.crm.api.backup.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature","zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo","zohocrmsdk.src.com.zoho.crm.api.portal_invite.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout","zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber","zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles","zohocrmsdk.src.com.zoho.crm.api.layouts.SectionSubformField","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData","zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","zohocrmsdk.src.com.zoho.crm.api.currencies.Format","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.RoleRequestWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module","zohocrmsdk.src.com.zoho.crm.api.users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes","zohocrmsdk.src.com.zoho.crm.api.pipeline.Stages","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge","zohocrmsdk.src.com.zoho.crm.api.from_addresses.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.Owner","zohocrmsdk.src.com.zoho.crm.api.mass_convert.Status","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Tpt","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","zohocrmsdk.src.com.zoho.crm.api.email_drafts.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField","zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","zohocrmsdk.src.com.zoho.crm.api.cancel_meetings.Notify","zohocrmsdk.src.com.zoho.crm.api.coql.ParseErrorDetails","zohocrmsdk.src.com.zoho.crm.api.mail_merge.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics","zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info","zohocrmsdk.src.com.zoho.crm.api.bulk_write.BulkWriteResponse","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Dependee","zohocrmsdk.src.com.zoho.crm.api.email_drafts.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.Currency","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule","zohocrmsdk.src.com.zoho.crm.api.blueprint.ToolTip","zohocrmsdk.src.com.zoho.crm.api.org.LicenseDetails","zohocrmsdk.src.com.zoho.crm.api.roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description","zohocrmsdk.src.com.zoho.crm.api.users.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecordsWrapper","zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","zohocrmsdk.src.com.zoho.crm.api.modules.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","zohocrmsdk.src.com.zoho.crm.api.tags.Resources","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert","zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User","zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference","zohocrmsdk.src.com.zoho.crm.api.holidays.ShiftHoliday","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Info","zohocrmsdk.src.com.zoho.crm.api.attachments.Owner","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status","zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete","zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","zohocrmsdk.src.com.zoho.crm.api.cadences.CustomView","zohocrmsdk.src.com.zoho.crm.api.roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge","zohocrmsdk.src.com.zoho.crm.api.custom_views.Field","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability","zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting","zohocrmsdk.src.com.zoho.crm.api.assignment_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.blueprint.AssociationDetails","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.associate_email.From","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Layouts","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn","zohocrmsdk.src.com.zoho.crm.api.features.Limit","zohocrmsdk.src.com.zoho.crm.api.timelines.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.Currency","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Email","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord","zohocrmsdk.src.com.zoho.crm.api.send_mail.Data","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferActionWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType","zohocrmsdk.src.com.zoho.crm.api.layouts.Sections","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule","zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.Info","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","zohocrmsdk.src.com.zoho.crm.api.user_groups.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner","zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue","zohocrmsdk.src.com.zoho.crm.api.related_records.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field","zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist","zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory","zohocrmsdk.src.com.zoho.crm.api.org.Org","zohocrmsdk.src.com.zoho.crm.api.profiles.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences.UnenrollProperty","zohocrmsdk.src.com.zoho.crm.api.available_currencies.Currency","zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMergeWrapper","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField","zohocrmsdk.src.com.zoho.crm.api.user_groups.Field","zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner","zohocrmsdk.src.com.zoho.crm.api.record.LineItemProduct","zohocrmsdk.src.com.zoho.crm.api.user_type_users.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","zohocrmsdk.src.com.zoho.crm.api.attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.RelatedListProperties","zohocrmsdk.src.com.zoho.crm.api.coql.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action","zohocrmsdk.src.com.zoho.crm.api.record_locking.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType","zohocrmsdk.src.com.zoho.crm.api.wizards.Transition","zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion","zohocrmsdk.src.com.zoho.crm.api.pick_list_values.PickListValues","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.record.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.org.Feature","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Section","zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.User","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Address","zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users.Users","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Folder","zohocrmsdk.src.com.zoho.crm.api.modules.Territory","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.DeletedAssociatedWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.BulkValidation","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink","zohocrmsdk.src.com.zoho.crm.api.holidays.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Filters","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.CvidBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.conversion_option.Field","zohocrmsdk.src.com.zoho.crm.api.record_locking.RecordLock","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCountWrapper","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module","zohocrmsdk.src.com.zoho.crm.api.bulk_write.File","zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option","zohocrmsdk.src.com.zoho.crm.api.associate_email.To","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance","zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ModuleDetails","zohocrmsdk.src.com.zoho.crm.api.functions.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.digest.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.related_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException","zohocrmsdk.src.com.zoho.crm.api.modules.Modules","zohocrmsdk.src.com.zoho.crm.api.notes.ParentId","zohocrmsdk.src.com.zoho.crm.api.record.MultiSelectPicklist","zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Views","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules","zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException","zohocrmsdk.src.com.zoho.crm.api.fiscal_year.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.backup.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.ErrorDetails","zohocrmsdk.src.com.zoho.crm.api.org.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","zohocrmsdk.src.com.zoho.crm.api.user_type_users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.contact_roles.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portals_meta.Wrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress","zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag","zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status","zohocrmsdk.src.com.zoho.crm.api.bulk_read.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.Manager","zohocrmsdk.src.com.zoho.crm.api.modules.LookupField","zohocrmsdk.src.com.zoho.crm.api.custom_views.PinUnpinFields","zohocrmsdk.src.com.zoho.crm.api.webforms.Layout","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portals.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User","zohocrmsdk.src.com.zoho.crm.api.bulk_read.Criteria","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.blueprint.Formula","zohocrmsdk.src.com.zoho.crm.api.fields.External","zohocrmsdk.src.com.zoho.crm.api.org.CheckinPreferences","zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitors","zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException","zohocrmsdk.src.com.zoho.crm.api.service_preference.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Module","zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCount","zohocrmsdk.src.com.zoho.crm.api.fields.ForecastCategory","zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS","zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.layouts.Properties","zohocrmsdk.src.com.zoho.crm.api.available_currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.share_records.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address","zohocrmsdk.src.com.zoho.crm.api.pipeline.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","zohocrmsdk.src.com.zoho.crm.api.territories.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","zohocrmsdk.src.com.zoho.crm.api.notifications.Info","zohocrmsdk.src.com.zoho.crm.api.notifications.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","zohocrmsdk.src.com.zoho.crm.api.users_territories.ValidationWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields","zohocrmsdk.src.com.zoho.crm.api.business_hours.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency","zohocrmsdk.src.com.zoho.crm.api.features.Detail","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.To","zohocrmsdk.src.com.zoho.crm.api.attachments.APIException","zohocrmsdk.src.com.zoho.crm.api.field_attachments.APIException","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.variables.Variable","zohocrmsdk.src.com.zoho.crm.api.org.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.Module","zohocrmsdk.src.com.zoho.crm.api.fields.Private","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.User","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Details","zohocrmsdk.src.com.zoho.crm.api.webforms.Module","zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups","zohocrmsdk.src.com.zoho.crm.api.territory_users.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.webforms.FormAttributes","zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_write.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.APIException","zohocrmsdk.src.com.zoho.crm.api.layouts.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence","zohocrmsdk.src.com.zoho.crm.api.holidays.Info","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule","zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","zohocrmsdk.src.com.zoho.crm.api.features.Info","zohocrmsdk.src.com.zoho.crm.api.attachments.ParentId","zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeWrapper","zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday","zohocrmsdk.src.com.zoho.crm.api.user_groups.JobsWrapper","zohocrmsdk.src.com.zoho.crm.api.webforms.AcknowledgeVisitor","zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties","zohocrmsdk.src.com.zoho.crm.api.associate_email.Record","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ExpectedField","zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord","zohocrmsdk.src.com.zoho.crm.api.territories.Field","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Fields","zohocrmsdk.src.com.zoho.crm.api.users.CountWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap","zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails","zohocrmsdk.src.com.zoho.crm.api.user_groups.GetAssignBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceSuccessResponse","zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.FieldMappings","zohocrmsdk.src.com.zoho.crm.api.files.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.unblock_email.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.users.Shift","zohocrmsdk.src.com.zoho.crm.api.record.Wizard","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException","zohocrmsdk.src.com.zoho.crm.api.wizards.Field","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule","zohocrmsdk.src.com.zoho.crm.api.blueprint.BluePrint","zohocrmsdk.src.com.zoho.crm.api.definition.Definition","zohocrmsdk.src.com.zoho.crm.api.digest.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.territories.Territories","zohocrmsdk.src.com.zoho.crm.api.notifications.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags","zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources","zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BodyWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDeleteDetails","zohocrmsdk.src.com.zoho.crm.api.record.PricingDetails","zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.record.ImageUpload"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Mass Convert scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.GetRecordCountForTagParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Module","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.apis.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_FIELD_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNotesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.DeleteHolidayHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.GetAppointmentPreferenceParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.CountHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.APIException","zohocrmsdk.src.com.zoho.crm.api.users.CountWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.RecurringActivity":{"rrule":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"RRULE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exdate":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"EXDATE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ResponseWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.tags.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.roles.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","REQUIRED_PARAM_MISSING","MANDATORY_NOT_FOUND","PATTERN_NOT_MATCHED","INVALID_DATA","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockExcludedProfile":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territory_users.APIException","zohocrmsdk.src.com.zoho.crm.api.users.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroup":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.LeadConverter":{"notify_lead_owner":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_lead_owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"add_to_existing_record":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"add_to_existing_record","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"assign_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"assign_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"module":"Deals","name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags","request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"overwrite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"overwrite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"notify_new_entity_owner":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify_new_entity_owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"move_attachments_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo","request_supported":["action","create","delete","read","update"],"name":"move_attachments_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.convert_lead.MoveAttachmentsTo","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.BodyWrapper":{"fiscal_year":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","request_supported":["action","create","delete","read","update"],"name":"fiscal_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack":{"method":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["post"],"name":"method","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.service_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_unavailability.APIException","zohocrmsdk.src.com.zoho.crm.api.users_unavailability.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Validation":{"records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments":{"service_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"service_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_size":{"regex":"[0-9]","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.functions.ExecuteFunctionUsingFileParam":{"auth_type":{"name":"auth_type","type":"String","structure":false},"arguments":{"name":"arguments","type":"Map","structure":false},"upload_file_param":{"response_supported":["action","create","delete","read","update"],"sub_type":{"sub_type":{"type":"String"},"type":"Map","sub_type_1":{"type":"Object"}},"request_supported":["action","create","delete","read","update"],"name":"upload_file_param","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_drafts.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.email_drafts.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionWrapper":{"user_groups":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"user_groups","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTagRequestWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ExistingTag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","MANDATORY_NOT_FOUND","DEPENDENT_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_DATA","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions":{"module_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","request_supported":["action","create","delete","read","update"],"name":"module_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"preference_field_matched_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue","request_supported":["action","create","delete","read","update"],"name":"preference_field_matched_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue","unique_for":"none","structure":true},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"modules_with_multiple_layouts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules_with_multiple_layouts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ID_ALREADY_DELETED","CANNOT_UPDATE_DELETED_USER","AUTHORIZATION_FAILED","PATTERN_NOT_MATCHED","INVALID_REQUEST","LICENSE_LIMIT_EXCEEDED","DUPLICATE_DATA","INVALID_DATA","UNAPPROVABLE","MANDATORY_NOT_FOUND","EMAIL_UPDATE_NOT_ALLOWED","ID_ALREADY_DEACTIVATED","ID_ALREADY_ACTIVE","FEATURE_PERMISSION","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","EMAIL_UPDATE_NOT_ALOWED","INVALID_MODULE","BAD_REQUEST","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"owner_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","required field not found","invalid data","The http request method type is not a valid one","Please check whether the input values are correct","the id given seems to be invalid","Cannot add user under CRM Plus account. Kindly use CRMPlus URL to add user","Request exceeds your license limit. Need to upgrade in order to add","Failed to add user since same email id is already present","Email Id should not contain @skydesk.jp. Please choose a different email id","Invalid Email Id. Please choose a different email id","Cannot add user for CRMPlus account from CRM. Kindly add user through CRMPlus","Company Name is required","Error occurred in resending the invitation of CRMPLUS user in CRM account","Cannot update the time_zone of another User","Either trial has expired or user does not have sufficient privilege to perform this action","Error occurred while updating CRMPlus User in CRM Account","invalid_data","Deleted user cannot be updated","Re-invite is not allowed for a confirmed user","Cannot update email of a confirmed CRM User","User with same email id is already in CRM Plus","User is already deactivated","Primary Contact cannot be deactivated","User is already active","Share among Subordinates Feature is not available","Profile and Role cannot be Updated by the user.","the_id_given_seems_to_be_invalid","Primary contact cannot be deleted","User is already deleted","User does not have sufficient privilege to delete users","Cannot update email of a confirmed CRM User"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordsHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.layouts.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.roles.ActionWrapper":{"roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.roles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.files.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["failure_in_attachment_handling","FILE_SIZE_MORE_THAN_ALLOWED_SIZE","INVALID_DATA","VIRUS_DETECTED","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Unavailability Hours saved successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockRecord":{"locked_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Locked_Reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues":{"old_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","request_supported":["action","create","delete","read","update"],"name":"old_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","unique_for":"none","structure":true},"new_value":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","request_supported":["action","create","delete","read","update"],"name":"new_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValue","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.GetStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping":{"salesorders":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"SalesOrders","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"invoices":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"Invoices","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.download_attachments.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers":{"action_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["sign","approve"],"name":"action_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"recipient":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","request_supported":["action","create","delete","read","update"],"name":"recipient","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Address","unique_for":"none","structure":true},"recipient_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"recipient_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferWrapper":{"transfer_and_delink":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users_territories.TransferAndDelink"},"request_supported":["action","create","delete","read","update"],"name":"transfer_and_delink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria_matched":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria_matched","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.UpdateVariableByIDParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","request_supported":["action","create","delete","read","update"],"name":"Sales_Orders","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","request_supported":["action","create","delete","read","update"],"name":"Invoices","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.Digest":{"record_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.AppointmentName":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_user_type.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Module":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.CvidBodyWrapper":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.modules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.modules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.BodyWrapper":{"merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge"},"request_supported":["action","create","delete","read","update"],"name":"merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Wrapper":{"privacy_configurable_apps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps"},"request_supported":["action","create","delete","read","update"],"name":"privacy_configurable_apps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.profiles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.profiles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.territories.ActionWrapper":{"territories":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"territories","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Filters":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence"},"request_supported":["action","create","delete","read","update"],"name":"cadences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ResponseWrapper":{"contact_roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole"},"request_supported":["action","create","delete","read","update"],"name":"contact_roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Wrapper":{"related_lists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists"},"request_supported":["action","create","delete","read","update"],"name":"related_lists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.GetScoringRulesParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true,false],"name":"active","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.VariableGroup":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Status"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.GetProfilesHeader":{},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.variable_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.variable_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences.ExecuteEvery":{"unit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"period":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"period","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.CreateBusinessHoliday":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.BusinessHoliday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.GetWebFormParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.BodyWrapper":{"map_dependency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency"},"request_supported":["action","create","delete","read","update"],"name":"map_dependency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.NewTagRequestWrapper":{"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.GetAppointmentsRescheduledHistoryParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"parent":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","request_supported":["action","create","delete","read","update"],"name":"parent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Pipeline","unique_for":"none","structure":true},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"maps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Maps"},"request_supported":["action","create","delete","read","update"],"name":"maps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"child_available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"child_available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.GetDownloadInlineImagesParam":{"user_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING","INVALID_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionSubformField":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal":{"user_type_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_type_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"language":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["en_US","en_GB","bg_BG","zh_CN","zh_TW","hr_HR","ar_EG","in_ID","cs_CZ","da_DK","nl_NL","fr_FR","de_DE","hu_HU","","hi_IN","it_IT","ja_JP","pl_PL","pt_BR","pt_PT","ru_RU","es_ES","sv_SE","th_TH","tr_TR","vi_VN","ko_KR","iw_IL"],"name":"language","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invite","reinvite"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.BlockedEmailAddress"},"request_supported":["action","create","delete","read","update"],"name":"blocked_email_addresses","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.GetZiaOrgEnrichmentsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","FAILED","DATA_NOT_FOUND"],"name":"status","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.custom_views.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.EmailDrafts":{"cc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To"},"request_supported":["action","create","delete","read","update"],"name":"cc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template","request_supported":["action","create","delete","read","update"],"name":"template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template","unique_for":"none","structure":true},"schedule_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails","request_supported":["action","create","delete","read","update"],"name":"schedule_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails","unique_for":"none","structure":true},"summary":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"bcc":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To"},"request_supported":["action","create","delete","read","update"],"name":"bcc","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Attachments"},"request_supported":["action","create","delete","read","update"],"name":"attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"email_opt_out":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_opt_out","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reply_to":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reply_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"rich_text":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rich_text","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"inventory_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails","request_supported":["action","create","delete","read","update"],"name":"inventory_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.InventoryDetails","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_drafts.To"},"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.cadences_execution.APIException","zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseWrapper":{"emailssharingdetails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.EmailSharings"},"request_supported":["action","create","delete","read","update"],"name":"__emails_sharing_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.privacy_configurable_apps.Apps":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.PricingDetails":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"to_range":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to_range","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"discount":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"discount","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"from_range":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from_range","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.File":{"skipped_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"skipped_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"updated_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"added_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"added_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ADDED","IN PROGRESS","COMPLETED","SKIPPED","FAILED"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS","SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Cadence":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Button":{"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shape":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shape","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"visibility":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visibility","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"reference_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reference_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"resource":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Criteria","unique_for":"none","structure":true},"target_screen":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","request_supported":["action","create","delete","read","update"],"name":"target_screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Message","request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Message","unique_for":"none","structure":true},"transition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Transition","request_supported":["action","create","delete","read","update"],"name":"transition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Transition","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"background_color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"background_color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetGroupedCountsParam":{"group_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_by","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.org.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.templates.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["REQUIRED_PARAM_MISSING"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Appointments preferences updated successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionWrapper":{"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"personality_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule","request_supported":["action","create","delete","read","update"],"name":"personality_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.PersonalityModule","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Owner","unique_for":"none","structure":true},"no_of_users":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"no_of_users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Modules"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineSuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record will be shared successfully","Sharing Revoked"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SCHEDULED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Org Enrichment scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"External_Deal_ID","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["relation added","relation removed"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.currencies.APIException","zohocrmsdk.src.com.zoho.crm.api.currencies.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.currencies.BaseCurrencyActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.webforms.UpdateWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTrackingModule","unique_for":"none","structure":true},"duration_configured_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"duration_configured_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.apis.SupportedAPI":{"path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"operation_types":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.apis.OperationTypes"},"request_supported":["action","create","delete","read","update"],"name":"operation_types","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.share_records.Dependee":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.inventory_templates.APIException","zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Address":{"country":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"country","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"city":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"city","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pin_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pin_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fill_address":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fill_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.LayoutAssociation":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.LayoutRequestWrapper":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.variables.ActionWrapper":{"variables":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"variables","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionWrapper":{"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_DATA","NOT_ALLOWED","MANDATORY_NOT_FOUND","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"supported_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Approval":{"delegate":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delegate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"approve":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approve","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"reject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"resubmit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resubmit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Analytics":{"analytics":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false,"extend_property":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall","request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsCall","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask","request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsTask","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert","request_supported":["action","create","delete","read","update"],"name":"analytics","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert","unique_for":"none","structure":true}]},"parent_follow_up":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp","request_supported":["action","create","delete","read","update"],"name":"parent_follow_up","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.ParentFollowUp","unique_for":"none","structure":true},"action":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action","request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Action","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Status":{"first_open":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"first_open","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"bounced_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sub_category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sub_category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"bounced_reason":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced_reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"last_open":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"last_open","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.GetEntityScoresHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.GetZiaPeopleEnrichmentsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","FAILED","DATA_NOT_FOUND"],"name":"status","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.LookupField":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_DATA","NOT_SUPPORTED","MANDATORY_NOT_FOUND","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Limit":{"edition_limit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edition_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.RelatedLists":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Modules","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdate":{"updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Total_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"not_updated_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Not_Updated_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Failed_Count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","SCHEDULED","RUNNING","FAILED"],"name":"Status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.LockingRules":{"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.Criteria","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"lock_existing_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lock_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.AssociatedPlaces":{"resources":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"resources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.BodyWrapper":{"roles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.roles.Role","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.roles.Role"},"request_supported":["action","create","delete","read","update"],"name":"roles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Comment":{"commented_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"commented_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"commented_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"commented_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"comment_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comment_content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.BodyWrapper":{"portal_user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType","request_supported":["action","create","delete","read","update"],"name":"portal_user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType","unique_for":"none","structure":true},"apply_assignment_threshold":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"apply_assignment_threshold","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"assign_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo","request_supported":["action","create","delete","read","update"],"name":"assign_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.AssignTo","unique_for":"none","structure":true},"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo"},"request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"move_attachments_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","request_supported":["action","create","delete","read","update"],"name":"move_attachments_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_convert.MoveAttachmentsTo","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.currencies.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The multi-currency feature is enabled and given currency is created as the base currency.","The currency created successfully.","The currency updated successfully."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.BodyWrapper":{"audit_log_export":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport"},"request_supported":["action","create","delete","read","update"],"name":"audit_log_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDeleteDetails"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Data"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.service_preference.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.digest.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","DEPENDENT_PARAM_MISSING","MANDATORY_NOT_FOUND","NO_PERMISSION","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.digest.Dependee","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.digest.Dependee","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["required field not found","Permission Denied."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.DeleteRelatedRecordsUsingExternalIDParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.InventoryConverter":{"convert_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.ConvertTo"},"name":"convert_to","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.CheckStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.PortalUserType":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","unique_for":"none","structure":true},"chart_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","request_supported":["action","create","delete","read","update"],"name":"chart_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","unique_for":"none","structure":true},"screens":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen"},"request_supported":["action","create","delete","read","update"],"name":"screens","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationResponse":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource","request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Resource","unique_for":"none","structure":true},"detail":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule","request_supported":["action","create","delete","read","update"],"name":"detail","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsUsingExternalIDParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetGroupsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","name":"filters","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Criteria","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ResponseWrapper":{"data_enrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"data_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionWrapper":{"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceBodyWrapper":{"replace_picklist_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacePicklistValues"},"request_supported":["action","create","delete","read","update"],"name":"replace_picklist_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.BodyWrapper":{"mass_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete"},"request_supported":["action","create","delete","read","update"],"name":"mass_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.fields.APIException","zohocrmsdk.src.com.zoho.crm.api.fields.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.AssociatedGroupsWrapper","zohocrmsdk.src.com.zoho.crm.api.users.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.users.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.coql.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["LIMIT_EXCEEDED","SYNTAX_ERROR","INVALID_QUERY","DUPLICATE_DATA","DUPLICATE_ALIAS","INVALID_ALIAS","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"near","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"line","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"clause","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reason","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid query formed","value given seems to be invalid for the column","data type not supported","column given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.notifications.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming":{"days":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_timing":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"LocalTime"},"request_supported":["action","create","delete","read","update"],"name":"shift_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance":{"restrict_data_access_through_api":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_data_access_through_api","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"enabled_for_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.Modules"},"request_supported":["action","create","delete","read","update"],"name":"enabled_for_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"restrict_to_zoho_apps":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_to_zoho_apps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"restrict_data_in_export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_data_in_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"restrict_to_third_party_apps":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"restrict_to_third_party_apps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.RestrictedCustomButton":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.BodyWrapper":{"data_enrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"data_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.share_records.DeleteActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.inventory_convert.Record":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.AnalyticsAlert":{"email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"cliked_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cliked_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"bounced_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"bounced_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"replied_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"replied_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"email_spam_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email_spam_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sent_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sent_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"unsent_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unsent_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"opened_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"opened_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"unsubscribed_email_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"unsubscribed_email_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.APIException","zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ResponseWrapper":{"unsubscribe_links":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.UnsubscribeLinks"},"request_supported":["action","create","delete","read","update"],"name":"unsubscribe_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.DPipeline":{"delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete","request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.Delete","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.portals.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portals.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.portals.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ResponseWrapper":{"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.HipaaCompliance","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.Note":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"note_content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Note_Content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"attachments":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"$attachments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"note_title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Note_Title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"editable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$editable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"voice_note":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$voice_note","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sharing_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$sharing_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"parent_id":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.ParentId","request_supported":["action","create","delete","read","update"],"name":"Parent_Id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notes.ParentId","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"is_shared_to_client":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$is_shared_to_client","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.LockedForS":{"module":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.GetFeatureDetailParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData":{"crm_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","request_supported":["action","create","delete","read","update"],"name":"crm_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField","unique_for":"none","structure":true},"enrich_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","request_supported":["action","create","delete","read","update"],"name":"enrich_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.notes.GetNoteHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.UrlsWrapper":{"urls":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Urls","request_supported":["action","create","delete","read","update"],"name":"urls","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Urls","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.Attachment":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.Record":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Fields":{"pin":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_pin","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.webforms.APIException","zohocrmsdk.src.com.zoho.crm.api.webforms.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["NOT_SUPPORTED","NO_PERMISSION","INVALID_DATA","AMBIGUITY_DURING_PROCESSING","MANDATORY_NOT_FOUND","EXPECTED_FIELD_MISSING","UNABLE_TO_PARSE_DATA_TYPE","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"permissions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"ambiguity_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ErrorDetails"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the id given seems to be invalid","either the request body or parameters is in wrong format","the owner id given is invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.GetUnassignBodyWrapper":{"get_unassigned":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","request_supported":["action","create","delete","read","update"],"name":"get_unassigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Assign","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.RoleRequestWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Suggestion":{"available":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_convert.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_templates.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.MinifiedLayout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.roles.DeleteRoleParam":{"transfer_to_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_to_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User":{"zgid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zgid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"full_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"full_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signature":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature","request_supported":["action","create","delete","read","update"],"name":"signature","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature","unique_for":"none","structure":true},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ButtonBackground":{"button_background":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"button_background","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionWrapper":{"fiscal_year":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"fiscal_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.timelines.PathFinder":{"process_entry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"process_entry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"process_exit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"process_exit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.State","request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.State","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionWrapper":{"data_enrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"duplicate_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"duplicate_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["insert","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully","record updated","record deleted","record added","photo uploaded successfully","Photo deleted","the territories data updated successfully","the territories are removed successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.BodyWrapper":{"appointment_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","request_supported":["action","create","delete","read","update"],"name":"appointment_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.BodyWrapper":{"process":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"process","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"wf_trigger":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"wf_trigger","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"name":"data","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100},"lar_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lar_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"trigger":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"trigger","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"duplicate_check_fields":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"duplicate_check_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variables.ResponseWrapper":{"variables":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.variables.Variable"},"request_supported":["action","create","delete","read","update"],"name":"variables","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Detail":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_allowed_field_mappings.CrmField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseWrapper":{"business_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","request_supported":["action","create","delete","read","update"],"name":"business_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.MandatoryDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetAssociationsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCountWrapper":{"associated_users_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount"},"request_supported":["action","create","delete","read","update"],"name":"associated_users_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Data":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portal_invite.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.portal_invite.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.GetVariablesParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseWrapper":{"merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.Merge"},"request_supported":["action","create","delete","read","update"],"name":"merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.UpdateHolidaysHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Layout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.ResponseWrapper":{"appointment_preferences":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","request_supported":["action","create","delete","read","update"],"name":"appointment_preferences","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.AppointmentPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.APIException","zohocrmsdk.src.com.zoho.crm.api.holidays.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole":{"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TSerial","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":50},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsUsingExternalIDHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ChangeSortOrderOfCustomViewsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.BodyWrapper":{"custom_views":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.CustomViews"},"request_supported":["action","create","delete","read","update"],"name":"custom_views","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.UpdateDuplicateCheckPreferenceParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.TransferTerritory":{"transfer_to_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_to_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete_previous_forecasts":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_previous_forecasts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.ViewType":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"quick_create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.TransferUsersOfAUserTypeParam":{"personality_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"transfer_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"transfer_To","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap":{"mergefieldsdata":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mergeFieldsData","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"features_available":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable","request_supported":["action","create","delete","read","update"],"name":"features_available","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable","unique_for":"none","structure":true},"relay_domains":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"relay_domains","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User","request_supported":["action","create","delete","read","update"],"name":"user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.User","unique_for":"none","structure":true},"from_address":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FromAddress"},"request_supported":["action","create","delete","read","update"],"name":"from_address","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.attachments.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unblock_email.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.apis.GetSupportedAPIParam":{"filters":{"name":"filters","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance":{"restricted_in_export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted_in_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"restricted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restricted","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"duplicate_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"duplicate_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["insert","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"External_Contact_ID","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$approval_state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully","record updated","record deleted","record added","photo uploaded successfully","Photo deleted","the territories data updated successfully","the territories are removed successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Status":{"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ADDED_SUCCESSFULLY"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"operation","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","IN PROGRESS","ADDED","FAILURE"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Added successfully."],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.files.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.files.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.BodyWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.InReplyTo":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.Owner","unique_for":"none","structure":true},"message_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["owner is successfully updated"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseWrapper":{"conversionoptions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions","request_supported":["action","create","delete","read","update"],"name":"__conversion_options","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ConversionOptions","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Message":{"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"content":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"content","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFieldLookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.ShowFields"},"request_supported":["action","create","delete","read","update"],"name":"show_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"revalidate_filter_during_edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"revalidate_filter_during_edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"query_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","request_supported":["action","create","delete","read","update"],"name":"query_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.QueryDetails","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.AssociatedUsersCount":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.MinifiedTerritory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.CreateMapDependencyParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.DefaultView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusResponseWrapper":{"mass_delete":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.StatusActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"mass_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.Template":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","NO_PERMISSION","MANDATORY_NOT_FOUND","INVALID_MODULE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.ActionWrapper":{"portals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portals.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"portals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.DeleteContactRolesParam":{"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals.Portals":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"min_length":6,"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":30},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"zaid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zaid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.portals.Owner","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Layout":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Expression":{"function_parameters":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter"},"request_supported":["action","create","delete","read","update"],"name":"function_parameters","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupCriteria","unique_for":"none","structure":true},"function":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"function","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.taxes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.holidays.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["PATTERN_NOT_MATCHED","DEPENDENT_FIELD_MISSING","MANDATORY_NOT_FOUND","INVALID_DATA","DUPLICATE_DATA","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Please check whether the input values are correct","Shift id is required for shift holidays","required field not found","invalid data","duplicate data","Invalid ID"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.BodyWrapper":{"ziapeopleenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"__zia_people_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.LineTax":{"percentage":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"percentage","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"display_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.user_groups.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.contact_roles.BodyWrapper":{"contact_roles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.contact_roles.ContactRole"},"name":"contact_roles","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":100}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference":{"consent_modules":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_tpt_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_tpt_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_zoho":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_zoho","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"awaiting_period":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"awaiting_period","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"consent_mail_send":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_mail_send","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_export_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_export_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"limit_actions":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit_actions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_export":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_export","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_zoho_integ":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_zoho_integ","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_zoho_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_zoho_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"duration_timing":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"duration_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_processing_duration":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_processing_duration","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_tpt_services":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_tpt_services","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_tpt_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_tpt_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_zoho_integ_services":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_zoho_integ_services","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"privacy_setting_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"privacy_setting_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"double_opt_in":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"double_opt_in","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_zoho_integ_fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_zoho_integ_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"exclude_api_tpt":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_api_tpt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"block_list":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"block_list","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"restrict_tpt":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"restrict_tpt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actions_while_awaiting":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actions_while_awaiting","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.DeleteShiftHourHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territories.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territories.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"associated_places":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociatedPlaces"},"request_supported":["action","create","delete","read","update"],"name":"associated_places","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.PortalUserType":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionWrapper":{"record_locking_configurations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"record_locking_configurations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.users.GetAssociatedGroupsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMergeWrapper":{"sign_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge"},"request_supported":["action","create","delete","read","update"],"name":"sign_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftHours":{"custom_timing":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ShiftCustomTiming"},"request_supported":["action","create","delete","read","update"],"name":"custom_timing","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"users_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"users_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Holidays"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"daily_timing":{"response_supported":["action","create","delete","read","update"],"min_length":2,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":false,"sub_type":{"type":"LocalTime"},"name":"daily_timing","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":2},"timezone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"timezone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TTimeZone","nullable_for":"none","type":"TimeZone","unique_for":"none","structure":false},"break_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.BreakHours"},"request_supported":["action","create","delete","read","update"],"name":"break_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shift_days":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"shift_days","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"same_as_everyday":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"same_as_everyday","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.GetUserHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDelete":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Module","unique_for":"none","structure":true},"tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag"},"name":"tags","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":200}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryDetails":{"inventory_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate","request_supported":["action","create","delete","read","update"],"name":"inventory_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.InventoryTemplate","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.Resource":{"field_mappings":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FieldMapping"},"request_supported":["action","create","delete","read","update"],"name":"field_mappings","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.File","request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_write.File","unique_for":"none","structure":true},"file_names":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"file_names","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"ignore_empty":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ignore_empty","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"file_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"find_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"find_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["data"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ADDED","IN PROGRESS","COMPLETED","SKIPPED","FAILED"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.change_owner.APIException","zohocrmsdk.src.com.zoho.crm.api.change_owner.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.SharingProperties":{"scheduler_status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"scheduler_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"share_permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["full-access","read-write","read-only"],"name":"share_permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"share_preference_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_preference_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.backup.History":{"done_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","request_supported":["action","create","delete","read","update"],"name":"done_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.backup.Requester","unique_for":"none","structure":true},"repeat_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"repeat_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"action":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"action","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"state":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"state","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"log_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"log_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.ResponseWrapper":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Fields"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.ResponseWrapper":{"from_addresses":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address"},"request_supported":["action","create","delete","read","update"],"name":"from_addresses","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.SearchRecordsParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"phone","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"word":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"word","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.GetRelatedListParam":{"layout_id":{"name":"layout_id","type":"Long","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false,"extend_property":[{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"DateTime"},"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User"},"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module"},"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}]},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.SignMailMerge":{"sign_in_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign_in_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"signers":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.Signers"},"request_supported":["action","create","delete","read","update"],"name":"signers","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_merge_template":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","request_supported":["action","create","delete","read","update"],"name":"mail_merge_template","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeTemplate","unique_for":"none","structure":true},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":255}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionWrapper":{"unsubscribe_links":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"unsubscribe_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"uid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"uid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"startDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"startDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"on_demand_properties":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"on_demand_properties","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"endDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"endDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"territory_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.VariableGroup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the module name given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.related_records.APIException","zohocrmsdk.src.com.zoho.crm.api.related_records.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.CreateFieldParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Transition":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.AuditLogExport":{"download_links":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"download_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Criteria","unique_for":"none","structure":true},"job_end_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_end_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"expiry_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expiry_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"job_start_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_start_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.User","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedRecord":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.send_mail.LinkedModule","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.Module","unique_for":"none","structure":true},"carry_over_tags":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"carry_over_tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Wrapper":{"privacypreference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference"},"request_supported":["action","create","delete","read","update"],"name":"privacyPreference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.business_hours.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMergeWrapper":{"send_mail_merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mail_merge.MailMerge"},"request_supported":["action","create","delete","read","update"],"name":"send_mail_merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.ActionWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Owner":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.files.APIException","zohocrmsdk.src.com.zoho.crm.api.files.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.reschedule_history.APIException","zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.FunctionParameter":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notes.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.notes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.BodyWrapper":{"assign_to":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User","request_supported":["action","create","delete","read","update"],"name":"assign_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.User","unique_for":"none","structure":true},"related_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.RelatedModules"},"request_supported":["action","create","delete","read","update"],"name":"related_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"ids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Long"},"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false,"max_length":50},"convert_to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.inventory_mass_convert.ConvertTo"},"name":"convert_to","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty":{"pinned_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pinned_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the relation name given seems to be invalid","the module name given seems to be invalid","the related id given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.templates.Templates":{"folder":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","request_supported":["action","create","delete","read","update"],"name":"folder","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"subject":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.templates.Folder","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"consent_linked":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"consent_linked","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"favourite":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"favourite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"attachment_present":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"attachment_present","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.ScheduleDetails":{"timezone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"timezone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TTimeZone","nullable_for":"none","type":"TimeZone","unique_for":"none","structure":false},"time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.modules.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.modules.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.modules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary":{"return_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"return_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"expression":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Expression","request_supported":["action","create","delete","read","update"],"name":"expression","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Expression","unique_for":"none","structure":true},"based_on_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"based_on_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"related_list":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","request_supported":["action","create","delete","read","update"],"name":"related_list","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MinifiedField","unique_for":"none","structure":true},"rollup_based_on":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"rollup_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.BodyWrapper":{"user_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.UserType"},"request_supported":["action","create","delete","read","update"],"name":"user_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.functions.ResponseWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.functions.APIException","zohocrmsdk.src.com.zoho.crm.api.functions.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.webforms.APIException","zohocrmsdk.src.com.zoho.crm.api.webforms.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users":{"personality_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"personality_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"confirm":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"confirm","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"status_reason__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status_reason__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"invited_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"invited_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Signature":{"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sign":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sign","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.digest.ActionWrapper":{"digest":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.digest.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.digest.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"__digest","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformProperties":{"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.StaticSubformField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.holidays.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Holidays created successfully","Holidays updated successfully","Holidays deleted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Business Hours saved successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.BodyWrapper":{"global_picklists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Picklist"},"request_supported":["action","create","delete","read","update"],"name":"global_picklists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.UpdateShiftHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.DuplicateRecord":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Users":{"role":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role","request_supported":["action","create","delete","read","update"],"name":"role","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.shift_hours.Role","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"effective_from":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"effective_from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.GetUserUnavailabilityParam":{"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.files.APIException","zohocrmsdk.src.com.zoho.crm.api.files.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.UpdateRelatedRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionWrapper":{"scrapy_feedback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionResponse","request_supported":["action","create","delete","read","update"],"name":"scrapy_feedback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_templates.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_templates.ResponseWrapper":{"email_templates":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.EmailTemplate"},"request_supported":["action","create","delete","read","update"],"name":"email_templates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_templates.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.UploadFileHeader":{"feature":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"X_crm_org":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-CRM-ORG","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty1":{"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.conversion_option.APIException","zohocrmsdk.src.com.zoho.crm.api.conversion_option.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.DeleteRecordHeader":{"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"structure_name":"String","request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"structure_name":"Long","request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Profile":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber":{"starting_number_length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"starting_number_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"prefix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"start_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"suffix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"suffix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.features.Detail":{"available_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","request_supported":["action","create","delete","read","update"],"name":"available_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","unique_for":"none","structure":true},"used_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","request_supported":["action","create","delete","read","update"],"name":"used_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","unique_for":"none","structure":true},"limits":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","request_supported":["action","create","delete","read","update"],"name":"limits","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.features.Limit","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.Role":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.ScrapyFeedback":{"feedback":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["negative","positive"],"name":"feedback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"comment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["organization","personal"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"enrich_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["jRsJ7grCwzJfs4B384k4zY3OFsLIE+EGt9AwDDtb4j4="],"name":"enrich_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCountWrapper":{"sources_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount"},"request_supported":["action","create","delete","read","update"],"name":"sources_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["The record has been converted successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordsParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.RecordActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.webforms.SpamControll":{"exclude_score":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exclude_score","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.PortalInvite":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.Portal"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["QUEUED","SCHEDULED","COMPLETED","RUNNING","FAILED"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.BodyWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.holidays.CreateBusinessHoliday","zohocrmsdk.src.com.zoho.crm.api.holidays.CreateShiftHoliday"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationModule":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.record.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency":{"symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"is_active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"exchange_rate":{"regex":"[1-9][0-9]{1,8}[.][0-9]{9}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"exchange_rate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"format":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","request_supported":["action","create","delete","read","update"],"name":"format","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Format","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"prefix_symbol":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix_symbol","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"is_base":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"is_base","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"iso_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"iso_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociationsResponseWrapper":{"pick_list_values_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.PickListValuesAssociation"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.External":{"allow_multiple_config":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"allow_multiple_config","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_REQUEST","INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid"],"name":"related_status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.RelatedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_templates.Attachment":{"size":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"size","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"file_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.Info":{"license_limit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"license_limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.entity_scores.APIException","zohocrmsdk.src.com.zoho.crm.api.entity_scores.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.templates.Wrapper":{"templates":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.templates.Templates","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.templates.Templates"},"request_supported":["action","create","delete","read","update"],"name":"templates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.DeleteWebFormsParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.EnrichField":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Layout","unique_for":"none","structure":true},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.FieldRule"},"request_supported":["action","create","delete","read","update"],"name":"field_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.Modules","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":25},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":500},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"signal_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SignalRule"},"request_supported":["action","create","delete","read","update"],"name":"signal_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.territories.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.definition.Property":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"allowed_values":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"Object"},"request_supported":["action","create","delete","read","update"],"name":"allowed_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"regex":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"regex","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.definition.MinifiedProperty"},"request_supported":["action","create","delete","read","update"],"name":"properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionWrapper":{"merge":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"merge","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ResponseWrapper":{"portal_invite":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.JobResponse"},"request_supported":["action","create","delete","read","update"],"name":"portal_invite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ResponseWrapper":{"scoring_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ScoringRule"},"request_supported":["action","create","delete","read","update"],"name":"scoring_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Industry":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DefaultView":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition":{"next_transitions":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.NextTransition"},"request_supported":["action","create","delete","read","update"],"name":"next_transitions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.record.Record","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria_message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria_message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"execution_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"execution_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sequence":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_field_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_field_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"text_color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"text_color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"criteria_matched":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"criteria_matched","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"parent_transition":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","request_supported":["action","create","delete","read","update"],"name":"parent_transition","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Transition","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Field","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.blueprint.Field"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"percent_partial_save":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"percent_partial_save","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"color_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_type_users.BodyWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_type_users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.blueprint.AutoNumber":{"prefix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"prefix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"start_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"suffix":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"suffix","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.APIException","zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.related_records.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Info":{"call":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"call","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","MANDATORY_NOT_FOUND","INVALID_DATA","INTERNAL_SERVER_ERROR","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["cvid","id","Owner"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["the module name given seems to be invalid","required field not found","the cvid given seems to be invalid"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Abtesting":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.webforms.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"structure_name":"String","request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"structure_name":"Long","request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"structure_name":"String","request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.share_records.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.share_records.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.notifications.BodyWrapper":{"watch":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification"},"request_supported":["action","create","delete","read","update"],"name":"watch","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException","zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldsParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"component":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"component","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"layout_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"layout_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"feature_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"feature_name","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["used","unused","all"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts":{"has_more_profiles":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"has_more_profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.ConvertMapping","unique_for":"none","structure":true},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_for":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_for","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Profiles"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"subform_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty","request_supported":["action","create","delete","read","update"],"name":"subform_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.SubformProperty","unique_for":"none","structure":true},"sections":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Sections","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Sections"},"request_supported":["action","create","delete","read","update"],"name":"sections","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"show_business_card":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_business_card","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"actions_allowed":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed","request_supported":["action","create","delete","read","update"],"name":"actions_allowed","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.ActionsAllowed","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"generated_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"generated_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.UploadUrlAttachmentsParam":{"attachmentUrl":{"regex":"[a-zA-Z]{10}[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"attachmentUrl","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.GetFileParam":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.change_owner.RelatedModules":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.CreateBusinessHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"maps":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PicklistMap"},"request_supported":["action","create","delete","read","update"],"name":"maps","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseWrapper":{"watch":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Notification"},"request_supported":["action","create","delete","read","update"],"name":"watch","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notifications.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notifications.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Result":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"download_url":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"download_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_territories.APIException","zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.Tag":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.MappedModule":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionWrapper":{"business_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionResponse","request_supported":["action","create","delete","read","update"],"name":"business_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","interface":true,"type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionResponse","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_drafts.Template":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.UpdateTagParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.download_inline_images.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.download_inline_images.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.download_inline_images.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.convert_lead.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.convert_lead.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.CrmField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.Holidays":{"holidays":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.holidays.Holiday"},"request_supported":["action","create","delete","read","update"],"name":"holidays","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","INVALID_DATA","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","The module name given seems to be invalid","the request does not contain any file","invalid file type"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.CountWrapper":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.BodyWrapper":{"file_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ics","csv"],"name":"file_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"query":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","request_supported":["action","create","delete","read","update"],"name":"query","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.Query","unique_for":"none","structure":true},"callback":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack","request_supported":["action","create","delete","read","update"],"name":"callback","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.bulk_read.CallBack","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Node":{"pos_y":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pos_y","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"pos_x":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pos_x","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"start_node":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"start_node","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"screen":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","request_supported":["action","create","delete","read","update"],"name":"screen","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record updated","mass update scheduled successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portals_meta.Layouts":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.send_mail.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.send_mail.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.ImageUpload":{"owner__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"preview_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Preview_Id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"file_name__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Name__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Sequence_Number__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"file_id__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"File_Id__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"state__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"State__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"size__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Size__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by__s":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Description__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time__s":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time__s","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.layouts.DealLayoutMapping":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.DealField"},"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.Territory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"assigned":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$assigned","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"assigned_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"$assigned_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"assigned_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"$assigned_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.MapDependency":{"parent":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent","request_supported":["action","create","delete","read","update"],"name":"parent","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Parent","unique_for":"none","structure":true},"internal":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"internal","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SubModule","unique_for":"none","structure":true},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.PickListMapping"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"child":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child","request_supported":["action","create","delete","read","update"],"name":"child","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.Child","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.roles.ReportingTo":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.custom_views.APIException","zohocrmsdk.src.com.zoho.crm.api.custom_views.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.PrivacyPreference":{"preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference","request_supported":["action","create","delete","read","update"],"name":"preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Preference","unique_for":"none","structure":true},"config":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config","request_supported":["action","create","delete","read","update"],"name":"config","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Config","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Company":{"website":{"regex":"www[.][a-z0-9]+[.][a-z]{3}","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"website","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users.APIException","zohocrmsdk.src.com.zoho.crm.api.users.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.taxes.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutHeader":{},"zohocrmsdk.src.com.zoho.crm.api.webforms.GetWebformsPreviewParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.audit_log_export.APIException","zohocrmsdk.src.com.zoho.crm.api.audit_log_export.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.modules.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["module created"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.GetFieldHeader":{},"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Entity":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.entity_scores.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.ModuleMap":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.OrgTax":{"preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.Preference","request_supported":["action","create","delete","read","update"],"name":"preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.taxes.Preference","unique_for":"none","structure":true},"taxes":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.Tax","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.taxes.Tax"},"request_supported":["action","create","delete","read","update"],"name":"taxes","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_MODULE","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.notifications.APIException","zohocrmsdk.src.com.zoho.crm.api.notifications.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.ResponseWrapper":{"fiscal_year":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","request_supported":["action","create","delete","read","update"],"name":"fiscal_year","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fiscal_year.Year","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.PinFields":{"pin":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_pin","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_lists.ModuleMap":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_cvid.GetMassDeleteStatusParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.bulk_read.APIException","zohocrmsdk.src.com.zoho.crm.api.bulk_read.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.bulk_read.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.DataEnrichment":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.Module","unique_for":"none","structure":true},"input_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.InputData"},"request_supported":["action","create","delete","read","update"],"name":"input_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.User","unique_for":"none","structure":true},"output_data_field_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_enrichment.OutputData"},"request_supported":["action","create","delete","read","update"],"name":"output_data_field_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.Consent":{"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"contact_through_email":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"data_processing_basis":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Data_Processing_Basis","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"contact_through_social":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Social","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"contact_through_phone":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Phone","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"consent_remarks":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Consent_Remarks","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"contact_through_survey":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Contact_Through_Survey","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"consent_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Consent_Date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDate","nullable_for":"none","type":"Date","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"mail_sent_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Mail_Sent_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"consent_through":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Consent_Through","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.SuccessWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionWrapper":{"assignment_rules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.assignment_rules.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"assignment_rules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.LineItemProduct":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Created_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Modified_Time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Modified_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"tag":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.Tag"},"request_supported":["action","create","delete","read","update"],"name":"Tag","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"product_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"Product_Code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"Created_By","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.webforms.ButtonAttributes":{"color":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"color","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Field","unique_for":"none","structure":true},"group_operator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_operator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"group":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.custom_views.Criteria"},"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.ActionWrapper":{"modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.privacy_preference.Option":{"suboptions":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"suboptions","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.BodyWrapper":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"owner":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner","request_supported":["action","create","delete","read","update"],"name":"owner","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Owner","unique_for":"none","structure":true},"criteria":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","request_supported":["action","create","delete","read","update"],"name":"criteria","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Criteria","unique_for":"none","structure":true},"territory":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory","request_supported":["action","create","delete","read","update"],"name":"territory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Territory","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.users.GetUsersParam":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["ActiveUsers","DeactiveUsers","NotConfirmedUsers","ConfirmedUsers","CurrentUser","ActiveConfirmedUsers"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mail_merge.DownloadResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mail_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.mail_merge.FileBodyWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variables.UpdateVariableByAPINameParam":{"group":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Resource":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.record.Record","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.record.Record"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Container":{"layout":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","request_supported":["action","create","delete","read","update"],"name":"layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Layouts","unique_for":"none","structure":true},"chart_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","request_supported":["action","create","delete","read","update"],"name":"chart_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.ChartData","unique_for":"none","structure":true},"screens":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Screen"},"request_supported":["action","create","delete","read","update"],"name":"screens","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territories.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.territories.APIException","zohocrmsdk.src.com.zoho.crm.api.territories.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.tags.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.tags.APIException","zohocrmsdk.src.com.zoho.crm.api.tags.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enriched_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData","request_supported":["action","create","delete","read","update"],"name":"enriched_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichedData","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enrich_based_on":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn","request_supported":["action","create","delete","read","update"],"name":"enrich_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.EnrichBasedOn","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssignedActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.find_and_merge.APIException","zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.service_preference.ServicePreference":{"job_sheet_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_sheet_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.appointment_preference.Layout":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Groups":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sources_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","request_supported":["action","create","delete","read","update"],"name":"sources_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCount","unique_for":"none","structure":true},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"sources":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Sources"},"request_supported":["action","create","delete","read","update"],"name":"sources","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"modified_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","request_supported":["action","create","delete","read","update"],"name":"modified_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Owner","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.layouts.SectionField":{"associated_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"associated_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"operation_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","request_supported":["action","create","delete","read","update"],"name":"operation_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","unique_for":"none","structure":true},"updateexistingrecords":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_update_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"colour_code_enabled_by_system":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code_enabled_by_system","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","unique_for":"none","structure":true},"textarea":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","request_supported":["action","create","delete","read","update"],"name":"textarea","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"required":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"required","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customizable_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"customizable_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","unique_for":"none","structure":true},"businesscard_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"businesscard_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"sharing_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","request_supported":["action","create","delete","read","update"],"name":"sharing_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"refer_from_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","request_supported":["action","create","delete","read","update"],"name":"refer_from_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","unique_for":"none","structure":true},"subform":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","request_supported":["action","create","delete","read","update"],"name":"subform","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","unique_for":"none","structure":true},"separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"searchable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"searchable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"virtual_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"virtual_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"allowed_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"allowed_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"validation_rule":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"validation_rule","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"auto_number_70":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"section_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"section_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"file_upolad_optionlist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption"},"request_supported":["action","create","delete","read","update"],"name":"file_upolad_optionlist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"static_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.layouts.StaticValues"},"request_supported":["action","create","delete","read","update"],"name":"static_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"email_parser":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","request_supported":["action","create","delete","read","update"],"name":"email_parser","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","unique_for":"none","structure":true},"multiuserlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiuserlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","unique_for":"none","structure":true},"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","unique_for":"none","structure":true},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","unique_for":"none","structure":true},"rollup_summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","request_supported":["action","create","delete","read","update"],"name":"rollup_summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","unique_for":"none","structure":true},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"global_picklist":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"autonumber":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"autonumber","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","unique_for":"none","structure":true},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","unique_for":"none","structure":true},"static_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"static_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"additional_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"additional_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"mass_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mass_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"blueprint_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"blueprint_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.share_records.ShareRecord":{"shared_with":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","request_supported":["action","create","delete","read","update"],"name":"shared_with","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Users","unique_for":"none","structure":true},"share_related_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"share_related_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"shared_through":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough","request_supported":["action","create","delete","read","update"],"name":"shared_through","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough","unique_for":"none","structure":true},"shared_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shared_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"permission":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"shared_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","request_supported":["action","create","delete","read","update"],"name":"shared_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Users","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["public","private"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","request_supported":["action","create","delete","read","update"],"name":"user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.Users","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.Info":{"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"next_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"next_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"previous_page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"previous_page_token","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token_expiry":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token_expiry","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"more_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"more_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_read.ModuleDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.GetEmailsRelatedRecordParam":{"owner_id":{"name":"owner_id","type":"Long","structure":false},"type":{"name":"type","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Maps":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.inventory_templates.GetInventoryTemplatesParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.RescheduleHistory"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.reschedule_history.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.DeletedRecord":{"deleted_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"deleted_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"display_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users.MinifiedUser","unique_for":"none","structure":true},"deleted_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.territory_users.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.fields.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["INVALID_DATA","INVALID_MODULE","MANDATORY_NOT_FOUND","LIMIT_EXCEEDED","DEPENDENT_FIELD_MISSING","REQUIRED_PARAM_MISSING","INVALID_TOKEN","INVALID_URL_PATTERN","BAD_REQUEST","NO_PERMISSION","OAUTH_SCOPE_MISMATCH","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","INVALID_REQUEST_METHOD","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expected_data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"dummy","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"limit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails"},"request_supported":["action","create","delete","read","update"],"name":"limit_due_to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","request_supported":["action","create","delete","read","update"],"name":"dependee","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MandatoryDetails","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionWrapper":{"emails":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.associate_email.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"Emails","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.BodyWrapper":{"business_hours":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","request_supported":["action","create","delete","read","update"],"name":"business_hours","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.business_hours.BusinessHours","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"linking_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"linking_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"lookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"lookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connected_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"connected_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedfield_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedfield_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"connectedlookup_apiname":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"connectedlookup_apiname","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"record_access":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"record_access","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pick_list_values.GetPickListValuesParam":{"module":{"name":"module","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.Record":{"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.timelines.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.timelines.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.UsersUnavailability":{"comments":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"comments","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false,"max_length":250},"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"service":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"service","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"all_day":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"all_day","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tp_event_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tp_event_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"user":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User","request_supported":["action","create","delete","read","update"],"name":"user","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.User","unique_for":"none","structure":true},"tp_calendar_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"tp_calendar_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_unavailability.GetUsersUnavailabilityParam":{"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"group_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"group_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"filters":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filters","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"role_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"role_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory_ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.SharedThrough":{"entity_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"entity_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.share_records.Module","request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.share_records.Module","unique_for":"none","structure":true},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Criteria":{"comparator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["equal"],"name":"comparator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field","request_supported":["action","create","delete","read","update"],"name":"field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.email_related_records.Field","unique_for":"none","structure":true},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ResponseWrapper":{"ziapeopleenrichment":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.ZiaPeopleEnrichment"},"request_supported":["action","create","delete","read","update"],"name":"__zia_people_enrichment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationsResponseWrapper":{"associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.AssociationDetails"},"request_supported":["action","create","delete","read","update"],"name":"associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordUsingExternalIDParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"uid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"uid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"startDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"startDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"endDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"endDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"territory_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.coql.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.coql.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.Properties":{"reorder_rows":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"reorder_rows","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.layouts.Tooltip","unique_for":"none","structure":true},"maximum_rows":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_rows","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.currencies.BodyWrapper":{"currencies":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.currencies.Currency"},"request_supported":["action","create","delete","read","update"],"name":"currencies","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.zia_people_enrichment.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["tax added","tax updated"," tax deleted"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.GetRecordsParam":{"cvid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"cvid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"per_page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"per_page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"sort_by":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_by","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"endDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"endDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"uid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"uid","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"approved":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"approved","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"startDateTime":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"startDateTime","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"include_child":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_child","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"converted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"converted","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page_token":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page_token","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"ids":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ids","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"page":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"page","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sort_order":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sort_order","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"territory_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"territory_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.TransferAndDelete":{"move_subordinate":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","request_supported":["action","create","delete","read","update"],"name":"move_subordinate","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.MoveSubordinate","unique_for":"none","structure":true},"transfer":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","request_supported":["action","create","delete","read","update"],"name":"transfer","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.Transfer","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionWrapper":{"portal_invite":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.portal_invite.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"portal_invite","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.Element":{"resource":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Resource","request_supported":["action","create","delete","read","update"],"name":"resource","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Resource","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.scoring_rules.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.scoring_rules.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.scoring_rules.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.send_mail.To":{"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionWrapper":{"global_picklists":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"global_picklists","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.portals.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.portals.APIException","zohocrmsdk.src.com.zoho.crm.api.portals.ActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.CurrentField":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.email_sharing_details.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionWrapper":{"replace_picklist_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplaceActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"replace_picklist_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ResponseWrapper":{"wizards":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.wizards.Wizard"},"request_supported":["action","create","delete","read","update"],"name":"wizards","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.ReplacedValue":{"display_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"actual_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"actual_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_convert.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.mass_convert.APIException","zohocrmsdk.src.com.zoho.crm.api.mass_convert.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.shift_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.shift_hours.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.taxes.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["EXPECTED_FIELD_MISSING","OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","MANDATORY_NOT_FOUND","INVALID_DATA","INTERNAL_ERROR","REQUIRED_PARAM_MISSING","BAD_REQUEST","NO_PERMISSION","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"maximum_length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"resource_path_index","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deprecated_version","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.taxes.ExpectedField"},"request_supported":["action","create","delete","read","update"],"name":"expected_fields","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"param","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one","required field not found","Sequence number out of range","Sequence number cannot be repeated in same request","Given ID does not exist","tax not deleted","One of the expected parameter is missing"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_territories.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.user_groups.GroupedCountWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUserCount","zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociationWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.APIException","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesWrapper","zohocrmsdk.src.com.zoho.crm.api.user_groups.SourcesCountWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.SocialMedia":{"media_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"media_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"media_url":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"media_url","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.holidays.GetHolidaysParam":{"year":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"year","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false,"max_length":4},"shift_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"shift_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["business_holiday","shift_holiday"],"name":"type","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.custom_views.SharedTo":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["users","roles","groups","territories"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"subordinates":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subordinates","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.attachments.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Attachment"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.attachments.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.attachments.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.record_locking.GetRecordLockingInformationParam":{"fields":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"fields","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.AssignmentRule":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.coql.DetailsWrapper":{"classes":["zohocrmsdk.src.com.zoho.crm.api.coql.ClauseDetails","zohocrmsdk.src.com.zoho.crm.api.coql.ParseErrorDetails"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record.MassUpdateResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.MassUpdate"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.FeaturesAvailable":{"inline_compose_window":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"inline_compose_window","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"schedule_mail":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"Schedule_Mail","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"islivedeskenabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"isLiveDeskEnabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"email_cloud_picker":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"EMAIL_CLOUD_PICKER","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"old_compose_revert":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"OLD_COMPOSE_REVERT","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"attach_teamdrive":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"attach_teamdrive","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"mandateunsublink":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mandateUnsubLink","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unsubscribe_link":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"UNSUBSCRIBE_LINK","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"email_preference":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"EMAIL_PREFERENCE","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"form_integration_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"form_integration_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ATTACHMENT","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"isprivacyenabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"isPrivacyEnabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"best_time_to_contact":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"best_time_to_contact","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"auto_suggestion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"auto_suggestion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"zsurvey_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":[true],"name":"zsurvey_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"subject_line_suggestion":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"subject_line_suggestion","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt":{"mode":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mode","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"encfldids":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"encFldIds","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"table":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"table","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"notify":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"notify","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.available_currencies.ResponseWrapper","zohocrmsdk.src.com.zoho.crm.api.available_currencies.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.taxes.Tax":{"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDouble","nullable_for":"none","type":"Double","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.territory_users.ResponseWrapper":{"users":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.users.Users","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.users.Users"},"request_supported":["action","create","delete","read","update"],"name":"users","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.territory_users.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.territory_users.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.business_hours.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.business_hours.APIException","zohocrmsdk.src.com.zoho.crm.api.business_hours.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.org.HierarchyPreferences":{"strictly_reporting":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"strictly_reporting","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["Reporting_To_Hierarchy","Role_Hierarchy"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.GetRecordMergeParam":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.field_attachments.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.field_attachments.FileBodyWrapper","zohocrmsdk.src.com.zoho.crm.api.field_attachments.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.backup.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.backup.SuccessResponse","zohocrmsdk.src.com.zoho.crm.api.backup.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.APIException":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["OAUTH_SCOPE_MISMATCH","INVALID_TOKEN","INVALID_URL_PATTERN","INVALID_REQUEST_METHOD","BAD_REQUEST","NO_PERMISSION","INTERNAL_ERROR","LIMIT_REACHED","NOT_ALLOWED","ALREADY_USED","Not Modified","AUTHENTICATION_FAILURE","MANDATORY_NOT_FOUND","INTERNAL_SERVER_ERROR"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["invalid oauth token","Please check if the URL trying to access is a correct one","The http request method type is not a valid one"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["error"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.record.APIException","zohocrmsdk.src.com.zoho.crm.api.record.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.cadences_execution.User":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUserCount":{"associated_users_count":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.AssociatedUser"},"request_supported":["action","create","delete","read","update"],"name":"associated_users_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.user_groups.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.modules.ModuleFields":{"associated_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"associated_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"webhook":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"webhook","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"operation_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","request_supported":["action","create","delete","read","update"],"name":"operation_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.OperationType","unique_for":"none","structure":true},"updateexistingrecords":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"_update_existing_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"colour_code_enabled_by_system":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"colour_code_enabled_by_system","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"field_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"tooltip":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","request_supported":["action","create","delete","read","update"],"name":"tooltip","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Tooltip","unique_for":"none","structure":true},"textarea":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","request_supported":["action","create","delete","read","update"],"name":"textarea","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Textarea","unique_for":"none","structure":true},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"field_read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"field_read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"customizable_properties":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"customizable_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"display_label":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_label","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"read_only":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"read_only","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"association_details":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","request_supported":["action","create","delete","read","update"],"name":"association_details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AssociationDetails","unique_for":"none","structure":true},"businesscard_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"businesscard_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multi_module_lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","request_supported":["action","create","delete","read","update"],"name":"multi_module_lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.MultiModuleLookup","unique_for":"none","structure":true},"sharing_properties":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","request_supported":["action","create","delete","read","update"],"name":"sharing_properties","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.SharingProperties","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"filterable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"filterable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"visible":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"visible","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"refer_from_field":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","request_supported":["action","create","delete","read","update"],"name":"refer_from_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ReferFromField","unique_for":"none","structure":true},"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"view_type":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","request_supported":["action","create","delete","read","update"],"name":"view_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ViewType","unique_for":"none","structure":true},"subform":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","request_supported":["action","create","delete","read","update"],"name":"subform","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Subform","unique_for":"none","structure":true},"separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"searchable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"searchable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"show_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"show_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"external":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.External","request_supported":["action","create","delete","read","update"],"name":"external","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.External","unique_for":"none","structure":true},"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enable_colour_code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"enable_colour_code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"unique":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","request_supported":["action","create","delete","read","update"],"name":"unique","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Unique","unique_for":"none","structure":true},"pick_list_values":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.PickListValue"},"request_supported":["action","create","delete","read","update"],"name":"pick_list_values","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"system_mandatory":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"system_mandatory","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"private":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","request_supported":["action","create","delete","read","update"],"name":"private","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Private","unique_for":"none","structure":true},"virtual_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"virtual_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"json_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"crypt":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","request_supported":["action","create","delete","read","update"],"name":"crypt","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Crypt","unique_for":"none","structure":true},"auto_number_65":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"auto_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"created_source":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_source","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"available_in_user_layout":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"available_in_user_layout","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"allowed_modules":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule"},"request_supported":["action","create","delete","read","update"],"name":"allowed_modules","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"display_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"ui_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"ui_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"modified_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"modified_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"file_upolad_optionlist":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.FileUpoladOption"},"request_supported":["action","create","delete","read","update"],"name":"file_upolad_optionlist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"quick_sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"quick_sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email_parser":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","request_supported":["action","create","delete","read","update"],"name":"email_parser","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.EmailParser","unique_for":"none","structure":true},"currency":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","request_supported":["action","create","delete","read","update"],"name":"currency","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Currency","unique_for":"none","structure":true},"multiuserlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiuserlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true},"lookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","request_supported":["action","create","delete","read","update"],"name":"lookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Lookup","unique_for":"none","structure":true},"hipaa_compliance":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HipaaCompliance","unique_for":"none","structure":true},"custom_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"custom_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"convert_mapping":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","request_supported":["action","create","delete","read","update"],"name":"convert_mapping","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.ConvertMapping","unique_for":"none","structure":true},"rollup_summary":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","request_supported":["action","create","delete","read","update"],"name":"rollup_summary","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.RollupSummary","unique_for":"none","structure":true},"length":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"length","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"column_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"column_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"default_value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default_value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"display_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"display_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"pick_list_values_sorted_lexically":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"pick_list_values_sorted_lexically","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"sortable":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sortable","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"number_separator":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"number_separator","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"layout_associations":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.fields.LayoutAssociation"},"request_supported":["action","create","delete","read","update"],"name":"layout_associations","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"sequence_number":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sequence_number","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"global_picklist":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"global_picklist","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false},"autonumber":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","request_supported":["action","create","delete","read","update"],"name":"autonumber","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.AutoNumber","unique_for":"none","structure":true},"history_tracking":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","request_supported":["action","create","delete","read","update"],"name":"history_tracking","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.HistoryTracking","unique_for":"none","structure":true},"data_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"data_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sub_module":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","request_supported":["action","create","delete","read","update"],"name":"sub_module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.modules.MinifiedModule","unique_for":"none","structure":true},"formula":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","request_supported":["action","create","delete","read","update"],"name":"formula","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Formula","unique_for":"none","structure":true},"additional_column":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"additional_column","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"static_field":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"static_field","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"hipaa_compliance_enabled":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"hipaa_compliance_enabled","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"category":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"category","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"decimal_place":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"decimal_place","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"mass_update":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"mass_update","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"blueprint_supported":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"blueprint_supported","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"multiselectlookup":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","request_supported":["action","create","delete","read","update"],"name":"multiselectlookup","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.fields.Multiselectlookup","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.RecordSuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.RecordDetailTag"},"request_supported":["action","create","delete","read","update"],"name":"tags","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.APIException","zohocrmsdk.src.com.zoho.crm.api.users_transfer_delete.SuccessResponse"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.GetGlobalPicklistParam":{"include":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"include_inner_details":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"include_inner_details","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.convert_lead.CarryOverTags":{"deals":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"accounts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"contacts":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.currencies.ErrorDetails":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"json_path":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"json_path","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.ZiaOrgEnrichment":{"created_time":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"created_time","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enriched_data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData","request_supported":["action","create","delete","read","update"],"name":"enriched_data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichedData","unique_for":"none","structure":true},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"created_by":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User","request_supported":["action","create","delete","read","update"],"name":"created_by","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.User","unique_for":"none","structure":true},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"enrich_based_on":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn","request_supported":["action","create","delete","read","update"],"name":"enrich_based_on","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.EnrichBasedOn","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.APIException","zohocrmsdk.src.com.zoho.crm.api.deal_contact_roles.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.related_records.FileBodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"file","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TFile","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatchedValue":{"deals":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch"},"request_supported":["action","create","delete","read","update"],"name":"Deals","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"accounts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch"},"request_supported":["action","create","delete","read","update"],"name":"Accounts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"contacts":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.conversion_option.PreferenceFieldMatch"},"request_supported":["action","create","delete","read","update"],"name":"Contacts","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.ActionResponse":{"classes":["zohocrmsdk.src.com.zoho.crm.api.hipaa_compliance.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.mass_change_owner.Field":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.global_picklists.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.Profile":{"permission_type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"permission_type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.profiles.ResponseWrapper":{"profiles":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Profile"},"request_supported":["action","create","delete","read","update"],"name":"profiles","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.profiles.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.profiles.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.tags.MergeWrapper":{"tags":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":true,"structure_name":"zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.tags.ConflictWrapper"},"name":"tags","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":1}},"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.BodyWrapper":{"duplicate_check_preference":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","request_supported":["action","create","delete","read","update"],"name":"duplicate_check_preference","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.duplicate_check_preference.DuplicateCheckPreference","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.Urls":{"data_links":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"data_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"attachment_links":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"name":"attachment_links","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":false},"expiry_date":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"expiry_date","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.notes.ResponseWrapper":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.Note","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.notes.Note"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true},"info":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.notes.Info","request_supported":["action","create","delete","read","update"],"name":"info","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.notes.Info","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.backup.Requester":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"zuid":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"zuid","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.timelines.APIException","zohocrmsdk.src.com.zoho.crm.api.timelines.ResponseWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.from_addresses.Address":{"default":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"default","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"user_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"user_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"type":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"type","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"email":{"regex":"[a-z]{7}[@]zoho[.]com","response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"email","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.associate_email.ModuleMap":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.unsubscribe_links.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.record_locking_configuration.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["record locking configuration created successfully"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.mass_delete_tags.MassDeleteDetails":{"job_id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"job_id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"total_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"total_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"failed_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"failed_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"deleted_count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted_count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["COMPLETED","RUNNING","FAILED","SCHEDULED"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.webforms.Module":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"module_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.record.CountWrapper":{"count":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"count","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.fields.UpdateFieldsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.shift_hours.CreateShiftsHoursHeader":{"x_crm_org":{"name":"X-CRM-ORG","type":"String","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionWrapper":{"pipeline":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionResponse","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.pipeline.ActionResponse"},"request_supported":["action","create","delete","read","update"],"name":"pipeline","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.find_and_merge.ImageData":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.ForecastCategory":{"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.share_records.GetSharedRecordDetailsParam":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"sharedTo":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"sharedTo","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLong","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.tags.AddTagsParam":{"over_write":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"over_write","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.wizards.ExemptedPortalUserType":{"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.variable_groups.MinifiedVariableGroup":{"api_name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"api_name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"id":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.portal_user_type.Permissions":{"view":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"view","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"delete_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"edit_shared_records":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"edit_shared_records","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"create_attachment":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"create_attachment","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false},"delete":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"delete","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TBoolean","nullable_for":"none","type":"Boolean","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.related_records.GetRelatedRecordHeader":{"If_modified_since":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"If-Modified-Since","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TDateTime","nullable_for":"none","type":"DateTime","unique_for":"none","structure":false},"X_external":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"X-EXTERNAL","required_for":"false","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.user_groups.Users":{"inactive":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"inactive","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"deleted":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"deleted","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false},"active":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"active","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TInteger","nullable_for":"none","type":"Integer","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TPipeline":{"from_1":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"from","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false},"to":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"to","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.pipeline.APIException","zohocrmsdk.src.com.zoho.crm.api.pipeline.TransferPipelineActionWrapper"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.Data":{"data":{"response_supported":["action","create","delete","read","update"],"structure_name":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap","sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.email_compose_meta.DataMap"},"request_supported":["action","create","delete","read","update"],"name":"data","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TCollections","nullable_for":"none","type":"List","unique_for":"none","structure":true}},"zohocrmsdk.src.com.zoho.crm.api.field_map_dependency.SuccessResponse":{"code":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["SUCCESS"],"name":"code","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false},"details":{"response_supported":["action","create","delete","read","update"],"sub_type":{"type":"String"},"request_supported":["action","create","delete","read","update"],"keys":[{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"id","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TLongString","nullable_for":"none","type":"Long","unique_for":"none","structure":false}],"name":"details","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TMap","nullable_for":"none","type":"Map","unique_for":"none","structure":false},"message":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"message","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"status":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"values":["success"],"name":"status","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"zohocrmsdk.src.com.zoho.crm.api.util.Choice","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.bulk_write.DefaultValue":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"name":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"name","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"value":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"value","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TObject","nullable_for":"none","type":"Object","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.taxes.ActionHandler":{"classes":["zohocrmsdk.src.com.zoho.crm.api.taxes.ActionWrapper","zohocrmsdk.src.com.zoho.crm.api.taxes.APIException"],"interface":true},"zohocrmsdk.src.com.zoho.crm.api.layouts.GetLayoutsParam":{"module":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"module","required_for":"true","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.zia_org_enrichment.Description":{"description":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"description","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false},"title":{"response_supported":["action","create","delete","read","update"],"request_supported":["action","create","delete","read","update"],"name":"title","required_for":"none","emptiable_for":"none","spec_type":"com.zoho.api.spec.template.type.TString","nullable_for":"none","type":"String","unique_for":"none","structure":false}},"zohocrmsdk.src.com.zoho.crm.api.files.BodyWrapper":{"file":{"response_supported":["action","create","delete","read","update"],"min_length":1,"request_supported":["action","create","delete","read","update"],"spec_type":"com.zoho.api.spec.template.type.TCollections","type":"List","unique_for":"none","structure":false,"sub_type":{"type":"zohocrmsdk.src.com.zoho.crm.api.util.StreamWrapper"},"name":"file","required_for":"none","emptiable_for":"none","nullable_for":"none","max_length":10}}} \ No newline at end of file